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

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-11-17 19:36:58 +02:00
1 parent b3093c3e3d
commit c51dce164d
869 files changed
+15238 -7267
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/product/Buffer/methods/Buffer.compare.mdx
+4 -4
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
[Buffer](../../interfaces/Buffer.mdx).compare
`**compare**(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): `0` \| `1` \| `-1``
`**compare**(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): 0 \| 1 \| -1`
Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order.
Comparison is based on the actual sequence of bytes in each `Buffer`.
@@ -109,12 +109,12 @@ console.log(buf1.compare(buf2, 5, 6, 5));
#### Returns
``0`` \| ``1`` \| ``-1``
`0` \| `1` \| `-1`
<ParameterTypes parameters={[
{
"name": "`0` \\| `1` \\| `-1`",
"type": "``0`` \\| ``1`` \\| ``-1``",
"name": "0 \\| 1 \\| -1",
"type": "`0` \\| `1` \\| `-1`",
"optional": true,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/product/Buffer/methods/Buffer.toJSON.mdx
+2 -2
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
[Buffer](../../interfaces/Buffer.mdx).toJSON
`**toJSON**(): &#123; data: number[] ; type: `"Buffer"` &#125;`
`**toJSON**(): &#123; data: number[] ; type: "Buffer" &#125;`
Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/JSON/stringify) implicitly calls
this function when stringifying a `Buffer` instance.
@@ -63,7 +63,7 @@ console.log(copy);
},
{
"name": "type",
"type": "``\"Buffer\"``",
"type": "`\"Buffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/BufferConstructor/methods/BufferConstructor.compare.mdx
+4 -4
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
[BufferConstructor](../../interfaces/BufferConstructor.mdx).compare
`**compare**(buf1, buf2): `0` \| `1` \| `-1``
`**compare**(buf1, buf2): 0 \| 1 \| -1`
Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`.
@@ -49,12 +49,12 @@ console.log(arr.sort(Buffer.compare));
#### Returns
``0`` \| ``1`` \| ``-1``
`0` \| `1` \| `-1`
<ParameterTypes parameters={[
{
"name": "`0` \\| `1` \\| `-1`",
"type": "``0`` \\| ``1`` \\| ``-1``",
"name": "0 \\| 1 \\| -1",
"type": "`0` \\| `1` \\| `-1`",
"optional": true,
"defaultValue": "",
"description": "Either `-1`, `0`, or `1`, depending on the result of the comparison. See `compare` for details.",
www/apps/docs/content/references/product/BufferConstructor/methods/BufferConstructor.from.mdx
+1 -1
View File
@@ -158,7 +158,7 @@ If not provided, &#123;encoding&#125; defaults to 'utf8'.
<ParameterTypes parameters={[
{
"name": "str",
"type": "[WithImplicitCoercion](../../types/WithImplicitCoercion.mdx)&#60;string&#62; \\| `&#123; [toPrimitive]: Method [toPrimitive] &#125;`",
"type": "[WithImplicitCoercion](../../types/WithImplicitCoercion.mdx)&#60;string&#62; \\| ``{ [toPrimitive]: Method [toPrimitive] }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.create.mdx
+51 -51
View File
@@ -48,7 +48,7 @@ async function createProduct (title: string) {
"children": [
{
"name": "categories",
"type": "`&#123; id: string &#125;`[]",
"type": "``{ id: string }``[]",
"description": "The product categories to associate with the product.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ async function createProduct (title: string) {
},
{
"name": "images",
"type": "`string`[] \\| `&#123; id?: string ; url: string &#125;`[]",
"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": "",
@@ -213,14 +213,14 @@ async function createProduct (title: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -229,7 +229,7 @@ async function createProduct (title: string) {
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -238,7 +238,7 @@ async function createProduct (title: string) {
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -247,7 +247,7 @@ async function createProduct (title: string) {
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -551,7 +551,7 @@ async function createProduct (title: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -578,7 +578,7 @@ async function createProduct (title: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -618,20 +618,20 @@ async function createProduct (title: string) {
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -654,8 +654,8 @@ async function createProduct (title: string) {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -672,7 +672,7 @@ async function createProduct (title: string) {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -681,8 +681,8 @@ async function createProduct (title: string) {
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -690,8 +690,8 @@ async function createProduct (title: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -699,8 +699,8 @@ async function createProduct (title: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -718,10 +718,10 @@ async function createProduct (title: string) {
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -735,8 +735,8 @@ async function createProduct (title: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -744,8 +744,8 @@ async function createProduct (title: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -754,7 +754,7 @@ async function createProduct (title: string) {
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -762,8 +762,8 @@ async function createProduct (title: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -772,16 +772,16 @@ async function createProduct (title: string) {
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -790,7 +790,7 @@ async function createProduct (title: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -798,8 +798,8 @@ async function createProduct (title: string) {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -808,16 +808,16 @@ async function createProduct (title: string) {
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -835,10 +835,10 @@ async function createProduct (title: string) {
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -853,16 +853,16 @@ async function createProduct (title: string) {
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -870,8 +870,8 @@ async function createProduct (title: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx
+16 -16
View File
@@ -92,8 +92,8 @@ async function createCategory (name: string, parent_category_id: string | null)
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
"type": "`null` \\| `string`",
"description": "The ID of the parent product category, if it has any.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -121,7 +121,7 @@ async function createCategory (name: string, parent_category_id: string | null)
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -148,7 +148,7 @@ async function createCategory (name: string, parent_category_id: string | null)
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -181,18 +181,18 @@ async function createCategory (name: string, parent_category_id: string | null)
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -261,10 +261,10 @@ async function createCategory (name: string, parent_category_id: string | null)
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -353,18 +353,18 @@ async function createCategory (name: string, parent_category_id: string | null)
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -433,10 +433,10 @@ async function createCategory (name: string, parent_category_id: string | null)
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx
+6 -6
View File
@@ -67,7 +67,7 @@ async function createCollection (title: string) {
{
"name": "product_ids",
"type": "`string`[]",
"description": "",
"description": "The products to associate with the collection.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -95,7 +95,7 @@ async function createCollection (title: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -122,7 +122,7 @@ async function createCollection (title: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -189,7 +189,7 @@ async function createCollection (title: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -199,10 +199,10 @@ async function createCollection (title: string) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx
+7 -7
View File
@@ -78,7 +78,7 @@ async function createProductOption (title: string, productId: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -105,7 +105,7 @@ async function createProductOption (title: string, productId: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -163,7 +163,7 @@ async function createProductOption (title: string, productId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -173,10 +173,10 @@ async function createProductOption (title: string, productId: string) {
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -191,10 +191,10 @@ async function createProductOption (title: string, productId: string) {
{
"name": "values",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx
+5 -5
View File
@@ -68,7 +68,7 @@ async function createProductTags (values: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -95,7 +95,7 @@ async function createProductTags (values: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -144,7 +144,7 @@ async function createProductTags (values: string[]) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -154,10 +154,10 @@ async function createProductTags (values: string[]) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx
+3 -3
View File
@@ -86,7 +86,7 @@ async function createProductType (value: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -113,7 +113,7 @@ async function createProductType (value: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -171,7 +171,7 @@ async function createProductType (value: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx
+2 -2
View File
@@ -52,7 +52,7 @@ async function deleteProducts (ids: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -79,7 +79,7 @@ async function deleteProducts (ids: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx
+2 -2
View File
@@ -52,7 +52,7 @@ async function deleteCategory (id: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -79,7 +79,7 @@ async function deleteCategory (id: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx
+2 -2
View File
@@ -52,7 +52,7 @@ async function deleteCollection (ids: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -79,7 +79,7 @@ async function deleteCollection (ids: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx
+2 -2
View File
@@ -52,7 +52,7 @@ async function deleteProductOptions (ids: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -79,7 +79,7 @@ async function deleteProductOptions (ids: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx
+2 -2
View File
@@ -53,7 +53,7 @@ async function deleteProductTags (ids: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -80,7 +80,7 @@ async function deleteProductTags (ids: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx
+2 -2
View File
@@ -52,7 +52,7 @@ async function deleteProductTypes (ids: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -79,7 +79,7 @@ async function deleteProductTypes (ids: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx
+50 -50
View File
@@ -146,7 +146,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)&#60;string&#62;",
"description": "",
"description": "IDs to filter categories by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -155,7 +155,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "is_active",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're active.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -164,7 +164,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "is_internal",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're internal",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "category_id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)&#60;string&#62;",
"description": "",
"description": "Filter a product by the IDs of their associated categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -184,7 +184,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "collection_id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)&#60;string&#62;",
"description": "Filters a product by its associated collections.",
"description": "Filters a product by the IDs of their associated collections.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -228,7 +228,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "value",
"type": "`string`[]",
"description": "",
"description": "Values to filter product tags by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -323,7 +323,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -350,7 +350,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -390,20 +390,20 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -426,8 +426,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -444,7 +444,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -453,8 +453,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -462,8 +462,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -471,8 +471,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -490,10 +490,10 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -507,8 +507,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -516,8 +516,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -526,7 +526,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -534,8 +534,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -544,16 +544,16 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -562,7 +562,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -570,8 +570,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -580,16 +580,16 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -607,10 +607,10 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -625,16 +625,16 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -642,8 +642,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx
+8 -8
View File
@@ -146,7 +146,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)&#60;string&#62;",
"description": "",
"description": "IDs to filter categories by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -155,7 +155,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "is_active",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're active.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -164,7 +164,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "is_internal",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're internal",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "category_id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)&#60;string&#62;",
"description": "",
"description": "Filter a product by the IDs of their associated categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -184,7 +184,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "collection_id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)&#60;string&#62;",
"description": "Filters a product by its associated collections.",
"description": "Filters a product by the IDs of their associated collections.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -228,7 +228,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "value",
"type": "`string`[]",
"description": "",
"description": "Values to filter product tags by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -323,7 +323,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -350,7 +350,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx
+3 -3
View File
@@ -191,7 +191,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string` \\| `string`[]",
"type": "`null` \\| `string` \\| `string`[]",
"description": "Filter product categories by their parent category's ID.",
"optional": true,
"defaultValue": "",
@@ -285,7 +285,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -312,7 +312,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx
+3 -3
View File
@@ -138,7 +138,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
{
"name": "handle",
"type": "`string` \\| `string`[]",
"description": "",
"description": "The handles to filter product collections by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -249,7 +249,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -276,7 +276,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx
+2 -2
View File
@@ -249,7 +249,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -276,7 +276,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx
+2 -2
View File
@@ -240,7 +240,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -267,7 +267,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx
+2 -2
View File
@@ -240,7 +240,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number,
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -267,7 +267,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number,
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx
+3 -3
View File
@@ -155,7 +155,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "id",
"type": "`string`[]",
"description": "",
"description": "IDs to filter options by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -268,7 +268,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -295,7 +295,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx
+7 -7
View File
@@ -191,7 +191,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string` \\| `string`[]",
"type": "`null` \\| `string` \\| `string`[]",
"description": "Filter product categories by their parent category's ID.",
"optional": true,
"defaultValue": "",
@@ -285,7 +285,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -312,7 +312,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -353,10 +353,10 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -425,10 +425,10 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx
+6 -6
View File
@@ -138,7 +138,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
{
"name": "handle",
"type": "`string` \\| `string`[]",
"description": "",
"description": "The handles to filter product collections by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -249,7 +249,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -276,7 +276,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -343,7 +343,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -353,10 +353,10 @@ async function retrieveCollections (ids: string[], title: string, skip: number,
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx
+7 -7
View File
@@ -249,7 +249,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -276,7 +276,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -334,7 +334,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -344,10 +344,10 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -362,10 +362,10 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe
{
"name": "values",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx
+5 -5
View File
@@ -240,7 +240,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -267,7 +267,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -316,7 +316,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -326,10 +326,10 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx
+3 -3
View File
@@ -240,7 +240,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number,
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -267,7 +267,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number,
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -325,7 +325,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number,
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx
+34 -34
View File
@@ -155,7 +155,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "id",
"type": "`string`[]",
"description": "",
"description": "IDs to filter options by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -268,7 +268,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -295,7 +295,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -344,8 +344,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -371,8 +371,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -380,8 +380,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -389,8 +389,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -416,8 +416,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -434,8 +434,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -443,7 +443,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -452,8 +452,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -462,16 +462,16 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "options",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -480,10 +480,10 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -497,8 +497,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -515,8 +515,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -533,8 +533,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -542,8 +542,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -551,8 +551,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx
+2 -2
View File
@@ -75,7 +75,7 @@ async function restoreProducts (ids: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -102,7 +102,7 @@ async function restoreProducts (ids: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx
+2 -2
View File
@@ -55,7 +55,7 @@ This documentation provides a reference to the restoreVariants method. This belo
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -82,7 +82,7 @@ This documentation provides a reference to the restoreVariants method. This belo
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieve.mdx
+100 -103
View File
@@ -37,20 +37,17 @@ To specify relations that should be retrieved:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
initialize as initializeProductModule,
} from "@medusajs/product"
async function retrievePriceSet (priceSetId: string) {
const pricingService = await initializePricingModule()
async function retrieveProduct (id: string) {
const productModule = await initializeProductModule()
const priceSet = await pricingService.retrieve(
priceSetId,
{
relations: ["money_amounts"]
}
)
const product = await productModule.retrieve(id, {
relations: ["categories"]
})
// do something with the price set or return it
// do something with the product or return it
}
```
@@ -151,7 +148,7 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -178,7 +175,7 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -210,20 +207,20 @@ async function retrievePriceSet (priceSetId: string) {
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -254,7 +251,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -264,10 +261,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -301,8 +298,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -319,7 +316,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -328,8 +325,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -337,8 +334,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -346,8 +343,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -365,10 +362,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -390,7 +387,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -419,8 +416,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -428,8 +425,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -438,7 +435,7 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -446,8 +443,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -456,10 +453,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -481,7 +478,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -491,10 +488,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -509,18 +506,18 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "values",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -529,14 +526,14 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -545,7 +542,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -554,7 +551,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -563,7 +560,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -574,8 +571,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -584,10 +581,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "id",
@@ -600,7 +597,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -610,10 +607,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -629,8 +626,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -648,10 +645,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -673,7 +670,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -703,10 +700,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -719,8 +716,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -746,8 +743,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -755,8 +752,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -764,8 +761,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -791,8 +788,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -809,8 +806,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -818,7 +815,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -827,8 +824,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -837,16 +834,16 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "options",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -855,10 +852,10 @@ async function retrievePriceSet (priceSetId: string) {
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -872,8 +869,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -890,8 +887,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -908,8 +905,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -917,8 +914,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -926,8 +923,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -937,8 +934,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -946,8 +943,8 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCategory.mdx
+14 -14
View File
@@ -148,7 +148,7 @@ async function retrieveCategory (id: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveCategory (id: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -208,18 +208,18 @@ async function retrieveCategory (id: string) {
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -288,10 +288,10 @@ async function retrieveCategory (id: string) {
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -380,18 +380,18 @@ async function retrieveCategory (id: string) {
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -460,10 +460,10 @@ async function retrieveCategory (id: string) {
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCollection.mdx
+47 -47
View File
@@ -148,7 +148,7 @@ async function retrieveCollection (id: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveCollection (id: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -234,7 +234,7 @@ async function retrieveCollection (id: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -244,27 +244,27 @@ async function retrieveCollection (id: string) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -287,8 +287,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -305,7 +305,7 @@ async function retrieveCollection (id: string) {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -314,8 +314,8 @@ async function retrieveCollection (id: string) {
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -323,8 +323,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -332,8 +332,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -351,10 +351,10 @@ async function retrieveCollection (id: string) {
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -368,8 +368,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -377,8 +377,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -387,7 +387,7 @@ async function retrieveCollection (id: string) {
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -395,8 +395,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -405,16 +405,16 @@ async function retrieveCollection (id: string) {
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -423,7 +423,7 @@ async function retrieveCollection (id: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -431,8 +431,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -441,16 +441,16 @@ async function retrieveCollection (id: string) {
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -468,10 +468,10 @@ async function retrieveCollection (id: string) {
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -486,16 +486,16 @@ async function retrieveCollection (id: string) {
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -503,8 +503,8 @@ async function retrieveCollection (id: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveOption.mdx
+54 -54
View File
@@ -148,7 +148,7 @@ async function retrieveProductOption (id: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveProductOption (id: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -225,7 +225,7 @@ async function retrieveProductOption (id: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -235,27 +235,27 @@ async function retrieveProductOption (id: string) {
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -278,8 +278,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -296,7 +296,7 @@ async function retrieveProductOption (id: string) {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -305,8 +305,8 @@ async function retrieveProductOption (id: string) {
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -314,8 +314,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -323,8 +323,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -342,10 +342,10 @@ async function retrieveProductOption (id: string) {
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -359,8 +359,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -368,8 +368,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -378,7 +378,7 @@ async function retrieveProductOption (id: string) {
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -386,8 +386,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -396,16 +396,16 @@ async function retrieveProductOption (id: string) {
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -414,7 +414,7 @@ async function retrieveProductOption (id: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -422,8 +422,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -432,16 +432,16 @@ async function retrieveProductOption (id: string) {
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -459,10 +459,10 @@ async function retrieveProductOption (id: string) {
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -477,16 +477,16 @@ async function retrieveProductOption (id: string) {
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -494,8 +494,8 @@ async function retrieveProductOption (id: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -515,10 +515,10 @@ async function retrieveProductOption (id: string) {
{
"name": "values",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -540,7 +540,7 @@ async function retrieveProductOption (id: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -550,10 +550,10 @@ async function retrieveProductOption (id: string) {
{
"name": "option",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)",
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
"description": "The associated product option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -568,10 +568,10 @@ async function retrieveProductOption (id: string) {
{
"name": "variant",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)",
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
"description": "The associated product variant.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveTag.mdx
+47 -47
View File
@@ -148,7 +148,7 @@ async function retrieveProductTag (tagId: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveProductTag (tagId: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -216,7 +216,7 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -226,27 +226,27 @@ async function retrieveProductTag (tagId: string) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -269,8 +269,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -287,7 +287,7 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -296,8 +296,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -305,8 +305,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -314,8 +314,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -333,10 +333,10 @@ async function retrieveProductTag (tagId: string) {
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -350,8 +350,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -359,8 +359,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -369,7 +369,7 @@ async function retrieveProductTag (tagId: string) {
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -377,8 +377,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -387,16 +387,16 @@ async function retrieveProductTag (tagId: string) {
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -405,7 +405,7 @@ async function retrieveProductTag (tagId: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -413,8 +413,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -423,16 +423,16 @@ async function retrieveProductTag (tagId: string) {
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -450,10 +450,10 @@ async function retrieveProductTag (tagId: string) {
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -468,16 +468,16 @@ async function retrieveProductTag (tagId: string) {
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -485,8 +485,8 @@ async function retrieveProductTag (tagId: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveType.mdx
+3 -3
View File
@@ -148,7 +148,7 @@ async function retrieveProductType (id: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveProductType (id: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -225,7 +225,7 @@ async function retrieveProductType (id: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveVariant.mdx
+80 -80
View File
@@ -148,7 +148,7 @@ async function retrieveProductVariant (id: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,7 +175,7 @@ async function retrieveProductVariant (id: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -216,8 +216,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -243,8 +243,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -252,8 +252,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -261,8 +261,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -288,8 +288,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -306,8 +306,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -315,7 +315,7 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -324,8 +324,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -334,10 +334,10 @@ async function retrieveProductVariant (id: string) {
{
"name": "options",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -359,7 +359,7 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -369,10 +369,10 @@ async function retrieveProductVariant (id: string) {
{
"name": "option",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)",
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
"description": "The associated product option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -387,18 +387,18 @@ async function retrieveProductVariant (id: string) {
{
"name": "variant",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)",
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
"description": "The associated product variant.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -407,27 +407,27 @@ async function retrieveProductVariant (id: string) {
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -450,8 +450,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -468,7 +468,7 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -477,8 +477,8 @@ async function retrieveProductVariant (id: string) {
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -486,8 +486,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -495,8 +495,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -514,10 +514,10 @@ async function retrieveProductVariant (id: string) {
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -531,8 +531,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -540,8 +540,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -550,7 +550,7 @@ async function retrieveProductVariant (id: string) {
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -558,8 +558,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -568,16 +568,16 @@ async function retrieveProductVariant (id: string) {
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -586,7 +586,7 @@ async function retrieveProductVariant (id: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -594,8 +594,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -604,16 +604,16 @@ async function retrieveProductVariant (id: string) {
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -631,10 +631,10 @@ async function retrieveProductVariant (id: string) {
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -649,16 +649,16 @@ async function retrieveProductVariant (id: string) {
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -666,8 +666,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -686,8 +686,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -704,8 +704,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -722,8 +722,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -731,8 +731,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -740,8 +740,8 @@ async function retrieveProductVariant (id: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.softDelete.mdx
+2 -2
View File
@@ -75,7 +75,7 @@ async function deleteProducts (ids: string[]) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -102,7 +102,7 @@ async function deleteProducts (ids: string[]) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.update.mdx
+53 -53
View File
@@ -49,7 +49,7 @@ async function updateProduct (id: string, title: string) {
"children": [
{
"name": "categories",
"type": "`&#123; id: string &#125;`[]",
"type": "``{ id: string }``[]",
"description": "The product categories to associate with the product.",
"optional": true,
"defaultValue": "",
@@ -68,7 +68,7 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The product collection to be associated with the product.",
"optional": true,
"defaultValue": "",
@@ -131,7 +131,7 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "images",
"type": "`string`[] \\| `&#123; id?: string ; url: string &#125;`[]",
"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": "",
@@ -223,14 +223,14 @@ async function updateProduct (id: string, title: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -239,7 +239,7 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -248,7 +248,7 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -257,7 +257,7 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -351,7 +351,7 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The product type to be associated with the product.",
"optional": true,
"defaultValue": "",
@@ -398,7 +398,7 @@ async function updateProduct (id: string, title: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -425,7 +425,7 @@ async function updateProduct (id: string, title: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -465,20 +465,20 @@ async function updateProduct (id: string, title: string) {
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -501,8 +501,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -519,7 +519,7 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -528,8 +528,8 @@ async function updateProduct (id: string, title: string) {
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -537,8 +537,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -546,8 +546,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -565,10 +565,10 @@ async function updateProduct (id: string, title: string) {
{
"name": "images",
"type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -582,8 +582,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -591,8 +591,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -601,7 +601,7 @@ async function updateProduct (id: string, title: string) {
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -609,8 +609,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -619,16 +619,16 @@ async function updateProduct (id: string, title: string) {
{
"name": "options",
"type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -637,7 +637,7 @@ async function updateProduct (id: string, title: string) {
{
"name": "status",
"type": "[ProductStatus](../../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -645,8 +645,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -655,16 +655,16 @@ async function updateProduct (id: string, title: string) {
{
"name": "tags",
"type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -682,10 +682,10 @@ async function updateProduct (id: string, title: string) {
{
"name": "type",
"type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -700,16 +700,16 @@ async function updateProduct (id: string, title: string) {
{
"name": "variants",
"type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -717,8 +717,8 @@ async function updateProduct (id: string, title: string) {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCategory.mdx
+16 -16
View File
@@ -100,8 +100,8 @@ async function updateCategory (id: string, name: string) {
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
"type": "`null` \\| `string`",
"description": "The ID of the parent product category, if it has any.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -129,7 +129,7 @@ async function updateCategory (id: string, name: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -156,7 +156,7 @@ async function updateCategory (id: string, name: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -189,18 +189,18 @@ async function updateCategory (id: string, name: string) {
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -269,10 +269,10 @@ async function updateCategory (id: string, name: string) {
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -361,18 +361,18 @@ async function updateCategory (id: string, name: string) {
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -441,10 +441,10 @@ async function updateCategory (id: string, name: string) {
{
"name": "parent_category",
"type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCollections.mdx
+5 -5
View File
@@ -114,7 +114,7 @@ async function updateCollection (id: string, title: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -141,7 +141,7 @@ async function updateCollection (id: string, title: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -208,7 +208,7 @@ async function updateCollection (id: string, title: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -218,10 +218,10 @@ async function updateCollection (id: string, title: string) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateOptions.mdx
+7 -7
View File
@@ -87,7 +87,7 @@ async function updateProductOption (id: string, title: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -114,7 +114,7 @@ async function updateProductOption (id: string, title: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -172,7 +172,7 @@ async function updateProductOption (id: string, title: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -182,10 +182,10 @@ async function updateProductOption (id: string, title: string) {
{
"name": "product",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -200,10 +200,10 @@ async function updateProductOption (id: string, title: string) {
{
"name": "values",
"type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTags.mdx
+5 -5
View File
@@ -78,7 +78,7 @@ async function updateProductTag (id: string, value: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -105,7 +105,7 @@ async function updateProductTag (id: string, value: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -154,7 +154,7 @@ async function updateProductTag (id: string, value: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -164,10 +164,10 @@ async function updateProductTag (id: string, value: string) {
{
"name": "products",
"type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTypes.mdx
+3 -3
View File
@@ -87,7 +87,7 @@ async function updateProductType (id: string, value: string) {
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -114,7 +114,7 @@ async function updateProductType (id: string, value: string) {
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -172,7 +172,7 @@ async function updateProductType (id: string, value: string) {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/SharedArrayBuffer/methods/SharedArrayBuffer.slice.mdx
+1 -1
View File
@@ -67,7 +67,7 @@ Returns a section of an SharedArrayBuffer.
},
{
"name": "[toStringTag]",
"type": "``\"SharedArrayBuffer\"``",
"type": "`\"SharedArrayBuffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/Buffer.mdx
+1 -1
View File
@@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"Uint8Array\"``",
"type": "`\"Uint8Array\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx
+1 -1
View File
@@ -174,7 +174,7 @@ Copies the passed &#123;buffer&#125; data onto a new &#123;Buffer&#125; instance
},
{
"name": "[toStringTag]",
"type": "``\"Uint8Array\"``",
"type": "`\"Uint8Array\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/Context.mdx
+2 -4
View File
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Context
The interface tag is used to ensure that the type is documented similar to interfaces.
A shared context object that is used to share resources between the application and the module.
## Type parameters
@@ -30,7 +28,7 @@ A shared context object that is used to share resources between the application
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"description": "A boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -57,7 +55,7 @@ A shared context object that is used to share resources between the application
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"description": "A string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/CreateProductCategoryDTO.mdx
+2 -2
View File
@@ -58,8 +58,8 @@ A product category to create.
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
"type": "`null` \\| `string`",
"description": "The ID of the parent product category, if it has any.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/CreateProductCollectionDTO.mdx
+1 -1
View File
@@ -32,7 +32,7 @@ A product collection to create.
{
"name": "product_ids",
"type": "`string`[]",
"description": "",
"description": "The products to associate with the collection.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/CreateProductDTO.mdx
+7 -7
View File
@@ -13,7 +13,7 @@ A product to create.
<ParameterTypes parameters={[
{
"name": "categories",
"type": "`&#123; id: string &#125;`[]",
"type": "``{ id: string }``[]",
"description": "The product categories to associate with the product.",
"optional": true,
"defaultValue": "",
@@ -86,7 +86,7 @@ A product to create.
},
{
"name": "images",
"type": "`string`[] \\| `&#123; id?: string ; url: string &#125;`[]",
"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": "",
@@ -178,14 +178,14 @@ A product to create.
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -194,7 +194,7 @@ A product to create.
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -203,7 +203,7 @@ A product to create.
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -212,7 +212,7 @@ A product to create.
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/FilterableProductCategoryProps.mdx
+1 -1
View File
@@ -85,7 +85,7 @@ The filters to apply on retrieved product categories.
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string` \\| `string`[]",
"type": "`null` \\| `string` \\| `string`[]",
"description": "Filter product categories by their parent category's ID.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/FilterableProductCollectionProps.mdx
+1 -1
View File
@@ -32,7 +32,7 @@ The filters to apply on retrieved product collections.
{
"name": "handle",
"type": "`string` \\| `string`[]",
"description": "",
"description": "The handles to filter product collections by.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/FilterableProductProps.mdx
+10 -10
View File
@@ -40,7 +40,7 @@ The filters to apply on retrieved products.
{
"name": "id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../types/OperatorMap.mdx)&#60;string&#62;",
"description": "",
"description": "IDs to filter categories by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -49,7 +49,7 @@ The filters to apply on retrieved products.
{
"name": "is_active",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're active.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -58,7 +58,7 @@ The filters to apply on retrieved products.
{
"name": "is_internal",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're internal",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -69,7 +69,7 @@ The filters to apply on retrieved products.
{
"name": "categories.id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../types/OperatorMap.mdx)&#60;string&#62;",
"description": "",
"description": "IDs to filter categories by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -78,7 +78,7 @@ The filters to apply on retrieved products.
{
"name": "categories.is_active",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're active.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -87,7 +87,7 @@ The filters to apply on retrieved products.
{
"name": "categories.is_internal",
"type": "`boolean`",
"description": "",
"description": "Filter categories by whether they're internal",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -96,7 +96,7 @@ The filters to apply on retrieved products.
{
"name": "category_id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../types/OperatorMap.mdx)&#60;string&#62;",
"description": "",
"description": "Filter a product by the IDs of their associated categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -105,7 +105,7 @@ The filters to apply on retrieved products.
{
"name": "collection_id",
"type": "`string` \\| `string`[] \\| [OperatorMap](../types/OperatorMap.mdx)&#60;string&#62;",
"description": "Filters a product by its associated collections.",
"description": "Filters a product by the IDs of their associated collections.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -149,7 +149,7 @@ The filters to apply on retrieved products.
{
"name": "value",
"type": "`string`[]",
"description": "",
"description": "Values to filter product tags by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -160,7 +160,7 @@ The filters to apply on retrieved products.
{
"name": "tags.value",
"type": "`string`[]",
"description": "",
"description": "Values to filter product tags by.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/FilterableProductVariantProps.mdx
+2 -2
View File
@@ -49,7 +49,7 @@ The filters to apply on retrieved product variants.
{
"name": "id",
"type": "`string`[]",
"description": "",
"description": "IDs to filter options by.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -60,7 +60,7 @@ The filters to apply on retrieved product variants.
{
"name": "options.id",
"type": "`string`[]",
"description": "",
"description": "IDs to filter options by.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/IteratorReturnResult.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "done",
"type": "``true``",
"type": "`true`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/IteratorYieldResult.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "done",
"type": "``false``",
"type": "`false`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/JoinerServiceConfig.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "`&#123; relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/ProductCategoryDTO.mdx
+28 -28
View File
@@ -14,26 +14,26 @@ A product category's data.
{
"name": "category_children",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -102,10 +102,10 @@ A product category's data.
{
"name": "parent_category",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -194,18 +194,18 @@ A product category's data.
{
"name": "parent_category",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -274,10 +274,10 @@ A product category's data.
{
"name": "parent_category",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -386,26 +386,26 @@ A product category's data.
{
"name": "parent_category",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -474,10 +474,10 @@ A product category's data.
{
"name": "parent_category",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -566,18 +566,18 @@ A product category's data.
{
"name": "parent_category",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
"description": "The associated child categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -646,10 +646,10 @@ A product category's data.
{
"name": "parent_category",
"type": "[ProductCategoryDTO](ProductCategoryDTO.mdx)",
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
"description": "The associated parent category.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
www/apps/docs/content/references/product/interfaces/ProductCollectionDTO.mdx
+93 -93
View File
@@ -40,7 +40,7 @@ A product collection's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -50,27 +50,27 @@ A product collection's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -101,7 +101,7 @@ A product collection's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -111,10 +111,10 @@ A product collection's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -148,8 +148,8 @@ A product collection's data.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -166,7 +166,7 @@ A product collection's data.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -175,8 +175,8 @@ A product collection's data.
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -184,8 +184,8 @@ A product collection's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -193,8 +193,8 @@ A product collection's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -212,10 +212,10 @@ A product collection's data.
{
"name": "images",
"type": "[ProductImageDTO](ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -237,7 +237,7 @@ A product collection's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -266,8 +266,8 @@ A product collection's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -275,8 +275,8 @@ A product collection's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -285,7 +285,7 @@ A product collection's data.
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -293,8 +293,8 @@ A product collection's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -303,10 +303,10 @@ A product collection's data.
{
"name": "options",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -328,7 +328,7 @@ A product collection's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -338,10 +338,10 @@ A product collection's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -356,18 +356,18 @@ A product collection's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -376,14 +376,14 @@ A product collection's data.
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -392,7 +392,7 @@ A product collection's data.
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -401,7 +401,7 @@ A product collection's data.
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,7 @@ A product collection's data.
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -421,8 +421,8 @@ A product collection's data.
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -431,10 +431,10 @@ A product collection's data.
{
"name": "tags",
"type": "[ProductTagDTO](ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "id",
@@ -447,7 +447,7 @@ A product collection's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -457,10 +457,10 @@ A product collection's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -476,8 +476,8 @@ A product collection's data.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -495,10 +495,10 @@ A product collection's data.
{
"name": "type",
"type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -520,7 +520,7 @@ A product collection's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -550,10 +550,10 @@ A product collection's data.
{
"name": "variants",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -566,8 +566,8 @@ A product collection's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -593,8 +593,8 @@ A product collection's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -602,8 +602,8 @@ A product collection's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -611,8 +611,8 @@ A product collection's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -638,8 +638,8 @@ A product collection's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -656,8 +656,8 @@ A product collection's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -665,7 +665,7 @@ A product collection's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -674,8 +674,8 @@ A product collection's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -684,16 +684,16 @@ A product collection's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -702,10 +702,10 @@ A product collection's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -719,8 +719,8 @@ A product collection's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -737,8 +737,8 @@ A product collection's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -755,8 +755,8 @@ A product collection's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -764,8 +764,8 @@ A product collection's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -773,8 +773,8 @@ A product collection's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -784,8 +784,8 @@ A product collection's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -793,8 +793,8 @@ A product collection's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/ProductDTO.mdx
+268 -268
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/product/interfaces/ProductImageDTO.mdx
+1 -1
View File
@@ -31,7 +31,7 @@ The product image's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/ProductOptionDTO.mdx
+136 -136
View File
@@ -31,7 +31,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -41,27 +41,27 @@ A product option's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -92,7 +92,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -102,10 +102,10 @@ A product option's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -139,8 +139,8 @@ A product option's data.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -157,7 +157,7 @@ A product option's data.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -166,8 +166,8 @@ A product option's data.
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,8 +175,8 @@ A product option's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -184,8 +184,8 @@ A product option's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -203,10 +203,10 @@ A product option's data.
{
"name": "images",
"type": "[ProductImageDTO](ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -228,7 +228,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -257,8 +257,8 @@ A product option's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -266,8 +266,8 @@ A product option's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -276,7 +276,7 @@ A product option's data.
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -284,8 +284,8 @@ A product option's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -294,10 +294,10 @@ A product option's data.
{
"name": "options",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -319,7 +319,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -329,10 +329,10 @@ A product option's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -347,18 +347,18 @@ A product option's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -367,14 +367,14 @@ A product option's data.
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -383,7 +383,7 @@ A product option's data.
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -392,7 +392,7 @@ A product option's data.
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -401,7 +401,7 @@ A product option's data.
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -412,8 +412,8 @@ A product option's data.
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -422,10 +422,10 @@ A product option's data.
{
"name": "tags",
"type": "[ProductTagDTO](ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "id",
@@ -438,7 +438,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -448,10 +448,10 @@ A product option's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -467,8 +467,8 @@ A product option's data.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -486,10 +486,10 @@ A product option's data.
{
"name": "type",
"type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -511,7 +511,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -541,10 +541,10 @@ A product option's data.
{
"name": "variants",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -557,8 +557,8 @@ A product option's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -584,8 +584,8 @@ A product option's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -593,8 +593,8 @@ A product option's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -602,8 +602,8 @@ A product option's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -629,8 +629,8 @@ A product option's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -647,8 +647,8 @@ A product option's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -656,7 +656,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -665,8 +665,8 @@ A product option's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -675,16 +675,16 @@ A product option's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -693,10 +693,10 @@ A product option's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -710,8 +710,8 @@ A product option's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -728,8 +728,8 @@ A product option's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -746,8 +746,8 @@ A product option's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -755,8 +755,8 @@ A product option's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -764,8 +764,8 @@ A product option's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -775,8 +775,8 @@ A product option's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -784,8 +784,8 @@ A product option's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -805,10 +805,10 @@ A product option's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -830,7 +830,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -840,10 +840,10 @@ A product option's data.
{
"name": "option",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)",
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
"description": "The associated product option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -865,7 +865,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -875,10 +875,10 @@ A product option's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -893,10 +893,10 @@ A product option's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
@@ -913,10 +913,10 @@ A product option's data.
{
"name": "variant",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)",
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
"description": "The associated product variant.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -929,8 +929,8 @@ A product option's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -956,8 +956,8 @@ A product option's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -965,8 +965,8 @@ A product option's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -974,8 +974,8 @@ A product option's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1001,8 +1001,8 @@ A product option's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1019,8 +1019,8 @@ A product option's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1028,7 +1028,7 @@ A product option's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -1037,8 +1037,8 @@ A product option's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1047,16 +1047,16 @@ A product option's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1065,10 +1065,10 @@ A product option's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -1082,8 +1082,8 @@ A product option's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1100,8 +1100,8 @@ A product option's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1118,8 +1118,8 @@ A product option's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1127,8 +1127,8 @@ A product option's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1136,8 +1136,8 @@ A product option's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/ProductOptionValueDTO.mdx
+135 -135
View File
@@ -31,7 +31,7 @@ The product option value's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -41,10 +41,10 @@ The product option value's data.
{
"name": "option",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)",
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
"description": "The associated product option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -66,7 +66,7 @@ The product option value's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -76,27 +76,27 @@ The product option value's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -119,8 +119,8 @@ The product option value's data.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -137,7 +137,7 @@ The product option value's data.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -146,8 +146,8 @@ The product option value's data.
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -155,8 +155,8 @@ The product option value's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -164,8 +164,8 @@ The product option value's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -183,10 +183,10 @@ The product option value's data.
{
"name": "images",
"type": "[ProductImageDTO](ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -200,8 +200,8 @@ The product option value's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -209,8 +209,8 @@ The product option value's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -219,7 +219,7 @@ The product option value's data.
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -227,8 +227,8 @@ The product option value's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -237,16 +237,16 @@ The product option value's data.
{
"name": "options",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -255,7 +255,7 @@ The product option value's data.
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -263,8 +263,8 @@ The product option value's data.
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -273,16 +273,16 @@ The product option value's data.
{
"name": "tags",
"type": "[ProductTagDTO](ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -300,10 +300,10 @@ The product option value's data.
{
"name": "type",
"type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -318,16 +318,16 @@ The product option value's data.
{
"name": "variants",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -335,8 +335,8 @@ The product option value's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -356,10 +356,10 @@ The product option value's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -381,7 +381,7 @@ The product option value's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -391,10 +391,10 @@ The product option value's data.
{
"name": "option",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)",
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
"description": "The associated product option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -409,10 +409,10 @@ The product option value's data.
{
"name": "variant",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)",
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
"description": "The associated product variant.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
@@ -431,10 +431,10 @@ The product option value's data.
{
"name": "variant",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)",
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
"description": "The associated product variant.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -447,8 +447,8 @@ The product option value's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -474,8 +474,8 @@ The product option value's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -483,8 +483,8 @@ The product option value's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -492,8 +492,8 @@ The product option value's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -519,8 +519,8 @@ The product option value's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -537,8 +537,8 @@ The product option value's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -546,7 +546,7 @@ The product option value's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -555,8 +555,8 @@ The product option value's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -565,10 +565,10 @@ The product option value's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -590,7 +590,7 @@ The product option value's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -600,10 +600,10 @@ The product option value's data.
{
"name": "option",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)",
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
"description": "The associated product option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -618,18 +618,18 @@ The product option value's data.
{
"name": "variant",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)",
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
"description": "The associated product variant.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -638,27 +638,27 @@ The product option value's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -681,8 +681,8 @@ The product option value's data.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -699,7 +699,7 @@ The product option value's data.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -708,8 +708,8 @@ The product option value's data.
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -717,8 +717,8 @@ The product option value's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -726,8 +726,8 @@ The product option value's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -745,10 +745,10 @@ The product option value's data.
{
"name": "images",
"type": "[ProductImageDTO](ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -762,8 +762,8 @@ The product option value's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -771,8 +771,8 @@ The product option value's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -781,7 +781,7 @@ The product option value's data.
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -789,8 +789,8 @@ The product option value's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -799,16 +799,16 @@ The product option value's data.
{
"name": "options",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -817,7 +817,7 @@ The product option value's data.
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -825,8 +825,8 @@ The product option value's data.
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -835,16 +835,16 @@ The product option value's data.
{
"name": "tags",
"type": "[ProductTagDTO](ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -862,10 +862,10 @@ The product option value's data.
{
"name": "type",
"type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -880,16 +880,16 @@ The product option value's data.
{
"name": "variants",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -897,8 +897,8 @@ The product option value's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -917,8 +917,8 @@ The product option value's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -935,8 +935,8 @@ The product option value's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -953,8 +953,8 @@ The product option value's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -962,8 +962,8 @@ The product option value's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -971,8 +971,8 @@ The product option value's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/ProductTagDTO.mdx
+93 -93
View File
@@ -22,7 +22,7 @@ A product tag's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -32,27 +32,27 @@ A product tag's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -83,7 +83,7 @@ A product tag's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -93,10 +93,10 @@ A product tag's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -130,8 +130,8 @@ A product tag's data.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -148,7 +148,7 @@ A product tag's data.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -157,8 +157,8 @@ A product tag's data.
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -166,8 +166,8 @@ A product tag's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -175,8 +175,8 @@ A product tag's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -194,10 +194,10 @@ A product tag's data.
{
"name": "images",
"type": "[ProductImageDTO](ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -219,7 +219,7 @@ A product tag's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -248,8 +248,8 @@ A product tag's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -257,8 +257,8 @@ A product tag's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -267,7 +267,7 @@ A product tag's data.
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -275,8 +275,8 @@ A product tag's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -285,10 +285,10 @@ A product tag's data.
{
"name": "options",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -310,7 +310,7 @@ A product tag's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -320,10 +320,10 @@ A product tag's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -338,18 +338,18 @@ A product tag's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -358,14 +358,14 @@ A product tag's data.
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -374,7 +374,7 @@ A product tag's data.
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -383,7 +383,7 @@ A product tag's data.
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -392,7 +392,7 @@ A product tag's data.
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -403,8 +403,8 @@ A product tag's data.
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -413,10 +413,10 @@ A product tag's data.
{
"name": "tags",
"type": "[ProductTagDTO](ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "id",
@@ -429,7 +429,7 @@ A product tag's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -439,10 +439,10 @@ A product tag's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -458,8 +458,8 @@ A product tag's data.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -477,10 +477,10 @@ A product tag's data.
{
"name": "type",
"type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -502,7 +502,7 @@ A product tag's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -532,10 +532,10 @@ A product tag's data.
{
"name": "variants",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -548,8 +548,8 @@ A product tag's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -575,8 +575,8 @@ A product tag's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -584,8 +584,8 @@ A product tag's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -593,8 +593,8 @@ A product tag's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -620,8 +620,8 @@ A product tag's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -638,8 +638,8 @@ A product tag's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -647,7 +647,7 @@ A product tag's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -656,8 +656,8 @@ A product tag's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -666,16 +666,16 @@ A product tag's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -684,10 +684,10 @@ A product tag's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -701,8 +701,8 @@ A product tag's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -719,8 +719,8 @@ A product tag's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -737,8 +737,8 @@ A product tag's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -746,8 +746,8 @@ A product tag's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -755,8 +755,8 @@ A product tag's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -766,8 +766,8 @@ A product tag's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -775,8 +775,8 @@ A product tag's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/ProductTypeDTO.mdx
+1 -1
View File
@@ -31,7 +31,7 @@ A product type's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/ProductVariantDTO.mdx
+162 -162
View File
@@ -22,8 +22,8 @@ A product variant's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -49,8 +49,8 @@ A product variant's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -58,8 +58,8 @@ A product variant's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -67,8 +67,8 @@ A product variant's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -94,8 +94,8 @@ A product variant's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -112,8 +112,8 @@ A product variant's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -121,7 +121,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -130,8 +130,8 @@ A product variant's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -140,10 +140,10 @@ A product variant's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -165,7 +165,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -175,10 +175,10 @@ A product variant's data.
{
"name": "option",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)",
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
"description": "The associated product option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -200,7 +200,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -210,10 +210,10 @@ A product variant's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -228,10 +228,10 @@ A product variant's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
@@ -248,10 +248,10 @@ A product variant's data.
{
"name": "variant",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)",
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
"description": "The associated product variant.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -264,8 +264,8 @@ A product variant's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -291,8 +291,8 @@ A product variant's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -300,8 +300,8 @@ A product variant's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -309,8 +309,8 @@ A product variant's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -336,8 +336,8 @@ A product variant's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -354,8 +354,8 @@ A product variant's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -363,7 +363,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -372,8 +372,8 @@ A product variant's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -382,16 +382,16 @@ A product variant's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -400,10 +400,10 @@ A product variant's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -417,8 +417,8 @@ A product variant's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -435,8 +435,8 @@ A product variant's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -453,8 +453,8 @@ A product variant's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -462,8 +462,8 @@ A product variant's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -471,8 +471,8 @@ A product variant's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -484,8 +484,8 @@ A product variant's data.
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -494,27 +494,27 @@ A product variant's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "categories",
"type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
"type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]",
"description": "The associated product categories.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "collection",
"type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)",
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
"description": "The associated product collection.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -545,7 +545,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -555,10 +555,10 @@ A product variant's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -592,8 +592,8 @@ A product variant's data.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "The description of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The description of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -610,7 +610,7 @@ A product variant's data.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -619,8 +619,8 @@ A product variant's data.
},
{
"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`.",
"type": "`null` \\| `string`",
"description": "The handle of the product. The handle can be used to create slug URL paths.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -628,8 +628,8 @@ A product variant's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -637,8 +637,8 @@ A product variant's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -656,10 +656,10 @@ A product variant's data.
{
"name": "images",
"type": "[ProductImageDTO](ProductImageDTO.mdx)[]",
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
"description": "The associated product images.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -681,7 +681,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -710,8 +710,8 @@ A product variant's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -719,8 +719,8 @@ A product variant's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -729,7 +729,7 @@ A product variant's data.
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -737,8 +737,8 @@ A product variant's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -747,10 +747,10 @@ A product variant's data.
{
"name": "options",
"type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -772,7 +772,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -782,10 +782,10 @@ A product variant's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -800,18 +800,18 @@ A product variant's data.
{
"name": "values",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]",
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
"description": "The associated product option values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
}
]
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -820,14 +820,14 @@ A product variant's data.
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -836,7 +836,7 @@ A product variant's data.
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -845,7 +845,7 @@ A product variant's data.
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -854,7 +854,7 @@ A product variant's data.
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -865,8 +865,8 @@ A product variant's data.
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"description": "The subttle of the product. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The subttle of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -875,10 +875,10 @@ A product variant's data.
{
"name": "tags",
"type": "[ProductTagDTO](ProductTagDTO.mdx)[]",
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
"description": "The associated product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "id",
@@ -891,7 +891,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -901,10 +901,10 @@ A product variant's data.
{
"name": "products",
"type": "[ProductDTO](ProductDTO.mdx)[]",
"description": "The associated products. It may only be available if the `products` relation is expanded.",
"description": "The associated products.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -920,8 +920,8 @@ A product variant's data.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The URL of the product's thumbnail.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -939,10 +939,10 @@ A product variant's data.
{
"name": "type",
"type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]",
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
"description": "The associated product type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "deleted_at",
@@ -964,7 +964,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -994,10 +994,10 @@ A product variant's data.
{
"name": "variants",
"type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]",
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
"description": "The associated product variants.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "allow_backorder",
@@ -1010,8 +1010,8 @@ A product variant's data.
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"description": "The barcode of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The barcode of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1037,8 +1037,8 @@ A product variant's data.
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"description": "The EAN of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The EAN of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1046,8 +1046,8 @@ A product variant's data.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"description": "The height of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The height of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1055,8 +1055,8 @@ A product variant's data.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"description": "The HS Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The HS Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1082,8 +1082,8 @@ A product variant's data.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"description": "The length of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The length of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1100,8 +1100,8 @@ A product variant's data.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"description": "The material of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The material of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1109,7 +1109,7 @@ A product variant's data.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -1118,8 +1118,8 @@ A product variant's data.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"description": "The MID Code of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The MID Code of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1128,16 +1128,16 @@ A product variant's data.
{
"name": "options",
"type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)",
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
"description": "The associated product options.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"description": "The origin country of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The origin country of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1146,10 +1146,10 @@ A product variant's data.
{
"name": "product",
"type": "[ProductDTO](ProductDTO.mdx)",
"description": "The associated product. It may only be available if the `product` relation is expanded.",
"description": "The associated product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": []
},
{
@@ -1163,8 +1163,8 @@ A product variant's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1181,8 +1181,8 @@ A product variant's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1199,8 +1199,8 @@ A product variant's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1208,8 +1208,8 @@ A product variant's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1217,8 +1217,8 @@ A product variant's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1228,8 +1228,8 @@ A product variant's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1237,8 +1237,8 @@ A product variant's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "",
"type": "`null` \\| `number`",
"description": "The width of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1257,8 +1257,8 @@ A product variant's data.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"description": "The SKU of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The SKU of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1275,8 +1275,8 @@ A product variant's data.
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"description": "The UPC of the product variant. It can possibly be `null`.",
"type": "`null` \\| `string`",
"description": "The UPC of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1293,8 +1293,8 @@ A product variant's data.
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "he ranking of the variant among other variants associated with the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1302,8 +1302,8 @@ A product variant's data.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"description": "The weight of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The weight of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1311,8 +1311,8 @@ A product variant's data.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"description": "The width of the product variant. It can possibly be `null`.",
"type": "`null` \\| `number`",
"description": "The width of the product variant.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/SharedArrayBuffer.mdx
+3 -3
View File
@@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"SharedArrayBuffer\"``",
"type": "`\"SharedArrayBuffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -60,7 +60,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"SharedArrayBuffer\"``",
"type": "`\"SharedArrayBuffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -80,7 +80,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"SharedArrayBuffer\"``",
"type": "`\"SharedArrayBuffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/SharedArrayBufferConstructor.mdx
+2 -2
View File
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"SharedArrayBuffer\"``",
"type": "`\"SharedArrayBuffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "[toStringTag]",
"type": "``\"SharedArrayBuffer\"``",
"type": "`\"SharedArrayBuffer\"`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/product/interfaces/UpdateProductCategoryDTO.mdx
+2 -2
View File
@@ -58,8 +58,8 @@ The data to update in a product category.
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
"type": "`null` \\| `string`",
"description": "The ID of the parent product category, if it has any.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/product/interfaces/UpdateProductDTO.mdx
+9 -9
View File
@@ -13,7 +13,7 @@ The data to update in a product. The `id` is used to identify which product to u
<ParameterTypes parameters={[
{
"name": "categories",
"type": "`&#123; id: string &#125;`[]",
"type": "``{ id: string }``[]",
"description": "The product categories to associate with the product.",
"optional": true,
"defaultValue": "",
@@ -32,7 +32,7 @@ The data to update in a product. The `id` is used to identify which product to u
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The product collection to be associated with the product.",
"optional": true,
"defaultValue": "",
@@ -95,7 +95,7 @@ The data to update in a product. The `id` is used to identify which product to u
},
{
"name": "images",
"type": "`string`[] \\| `&#123; id?: string ; url: string &#125;`[]",
"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": "",
@@ -187,14 +187,14 @@ The data to update in a product. The `id` is used to identify which product to u
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).",
"description": "The status of the product.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -203,7 +203,7 @@ The data to update in a product. The `id` is used to identify which product to u
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -212,7 +212,7 @@ The data to update in a product. The `id` is used to identify which product to u
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -221,7 +221,7 @@ The data to update in a product. The `id` is used to identify which product to u
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -315,7 +315,7 @@ The data to update in a product. The `id` is used to identify which product to u
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The product type to be associated with the product.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/product/types/ArrayBufferLike.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ArrayBufferLike
**ArrayBufferLike**: ArrayBufferTypes[keyof ArrayBufferTypes]
**ArrayBufferLike**: `ArrayBufferTypes`[keyof `ArrayBufferTypes`]
www/apps/docs/content/references/product/types/ArrayBufferView.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ArrayBufferView
**ArrayBufferView**: [TypedArray](TypedArray.mdx) \| DataView
**ArrayBufferView**: [TypedArray](TypedArray.mdx) \| `DataView`
www/apps/docs/content/references/product/types/Exclude.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Exclude
**Exclude**`<TypeParameter T, TypeParameter U>`: T extends U ? never : T
**Exclude**`<TypeParameter T, TypeParameter U>`: `T` extends `U` ? `never` : `T`
Exclude from T those types that are assignable to U
www/apps/docs/content/references/product/types/ExpandScalar.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ExpandScalar
**ExpandScalar**`<TypeParameter T>`: `null` \| T extends string ? string \| RegExp : T extends Date ? Date \| string : T
**ExpandScalar**`<TypeParameter T>`: `null` \| `T` extends `string` ? `string` \| `RegExp` : `T` extends `Date` ? `Date` \| `string` : `T`
### Type parameters
www/apps/docs/content/references/product/types/FilterQuery.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterQuery
**FilterQuery**`<TypeParameter T, TypeParameter Prev>`: Prev extends never ? never : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**`<TypeParameter T, TypeParameter Prev>`: `Prev` extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
### Type parameters
www/apps/docs/content/references/product/types/FilterValue2.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterValue2
**FilterValue2**`<TypeParameter T>`: T \| [ExpandScalar](ExpandScalar.mdx)&#60;T&#62; \| [Primary](Primary.mdx)&#60;T&#62;
**FilterValue2**`<TypeParameter T>`: `T` \| [ExpandScalar](ExpandScalar.mdx)&#60;T&#62; \| [Primary](Primary.mdx)&#60;T&#62;
### Type parameters
www/apps/docs/content/references/product/types/ModuleJoinerConfig.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleJoinerConfig
**ModuleJoinerConfig**: [Omit](Omit.mdx)&#60;[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), `"serviceName"` \| `"primaryKeys"` \| `"relationships"` \| `"extends"`&#62; & &#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `"date"` \| `"time"` \| `"datetime"` \| `"bigint"` \| `"blob"` \| `"uint8array"` \| `"array"` \| `"enumArray"` \| `"enum"` \| `"json"` \| `"integer"` \| `"smallint"` \| `"tinyint"` \| `"mediumint"` \| `"float"` \| `"double"` \| `"boolean"` \| `"decimal"` \| `"string"` \| `"uuid"` \| `"text"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;
**ModuleJoinerConfig**: [Omit](Omit.mdx)&#60;[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"&#62; & ``{ databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: "date" \| "time" \| "datetime" \| bigint \| "blob" \| "uint8array" \| "array" \| "enumArray" \| "enum" \| "json" \| "integer" \| "smallint" \| "tinyint" \| "mediumint" \| "float" \| "double" \| "boolean" \| "decimal" \| "string" \| "uuid" \| "text" &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }``
www/apps/docs/content/references/product/types/ModuleJoinerRelationship.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleJoinerRelationship
**ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & &#123; deleteCascade?: boolean ; isInternalService?: boolean &#125;
**ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & ``{ deleteCascade?: boolean ; isInternalService?: boolean }``
www/apps/docs/content/references/product/types/PrevLimit.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# PrevLimit
**PrevLimit**: [never, `1`, `2`, `3`]
**PrevLimit**: [`never`, `1`, `2`, `3`]
www/apps/docs/content/references/product/types/Primary.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Primary
**Primary**`<TypeParameter T>`: T extends &#123; [PrimaryKeyType]?: infer PK &#125; ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; : T extends &#123; _id?: infer PK &#125; ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; \| string : T extends &#123; uuid?: infer PK &#125; ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; : T extends &#123; id?: infer PK &#125; ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; : never
**Primary**`<TypeParameter T>`: `T` extends ``{ [PrimaryKeyType]?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; : `T` extends ``{ _id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; \| `string` : `T` extends ``{ uuid?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; : `T` extends ``{ id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)&#60;PK&#62; : `never`
### Type parameters
www/apps/docs/content/references/product/types/Query.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Query
**Query**`<TypeParameter T>`: T extends object ? T extends [Scalar](Scalar.mdx) ? never : [FilterQuery](FilterQuery.mdx)&#60;T&#62; : [FilterValue](FilterValue.mdx)&#60;T&#62;
**Query**`<TypeParameter T>`: `T` extends `object` ? `T` extends [Scalar](Scalar.mdx) ? `never` : [FilterQuery](FilterQuery.mdx)&#60;T&#62; : [FilterValue](FilterValue.mdx)&#60;T&#62;
### Type parameters
www/apps/docs/content/references/product/types/ReadonlyPrimary.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ReadonlyPrimary
**ReadonlyPrimary**`<TypeParameter T>`: T extends any[] ? [Readonly](Readonly.mdx)&#60;T&#62; : T
**ReadonlyPrimary**`<TypeParameter T>`: `T` extends `any`[] ? [Readonly](Readonly.mdx)&#60;T&#62; : `T`
### Type parameters
www/apps/docs/content/references/product/types/Scalar.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Scalar
**Scalar**: boolean \| number \| string \| bigint \| symbol \| Date \| RegExp \| [Buffer](../variables/Buffer-1.mdx) \| &#123; toHexString: Method toHexString &#125;
**Scalar**: `boolean` \| `number` \| `string` \| `bigint` \| `symbol` \| `Date` \| `RegExp` \| [Buffer](../variables/Buffer-1.mdx) \| ``{ toHexString: Method toHexString }``
www/apps/docs/content/references/product/types/TypedArray.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# TypedArray
**TypedArray**: Uint8Array \| Uint8ClampedArray \| Uint16Array \| Uint32Array \| Int8Array \| Int16Array \| Int32Array \| BigUint64Array \| BigInt64Array \| Float32Array \| Float64Array
**TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array`
www/apps/docs/content/references/product/types/WithImplicitCoercion.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# WithImplicitCoercion
**WithImplicitCoercion**`<TypeParameter T>`: T \| &#123; valueOf: Method valueOf &#125;
**WithImplicitCoercion**`<TypeParameter T>`: `T` \| ``{ valueOf: Method valueOf }``
### Type parameters