asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 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
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/entities/classes/DiscountCondition.mdx
+30 -30
View File
@@ -48,7 +48,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -104,7 +104,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "IN",
"type": "``\"in\"``",
"type": "`\"in\"`",
"description": "The discountable resources are within the specified resources.",
"optional": true,
"defaultValue": "",
@@ -257,7 +257,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "NOT_IN",
"type": "``\"not_in\"``",
"type": "`\"not_in\"`",
"description": "The discountable resources are everything but the specified resources.",
"optional": true,
"defaultValue": "",
@@ -285,7 +285,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -367,7 +367,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -505,7 +505,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -523,7 +523,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -532,7 +532,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -550,7 +550,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -559,7 +559,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -568,7 +568,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -577,7 +577,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -613,7 +613,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -622,7 +622,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -631,7 +631,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -640,7 +640,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -658,7 +658,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -712,7 +712,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -730,7 +730,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -757,7 +757,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -784,7 +784,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -793,7 +793,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -812,7 +812,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "CUSTOMER_GROUPS",
"type": "``\"customer_groups\"``",
"type": "`\"customer_groups\"`",
"description": "The discount condition is used for customer groups.",
"optional": true,
"defaultValue": "",
@@ -821,7 +821,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCTS",
"type": "``\"products\"``",
"type": "`\"products\"`",
"description": "The discount condition is used for products.",
"optional": true,
"defaultValue": "",
@@ -830,7 +830,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCT_COLLECTIONS",
"type": "``\"product_collections\"``",
"type": "`\"product_collections\"`",
"description": "The discount condition is used for product collections.",
"optional": true,
"defaultValue": "",
@@ -839,7 +839,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCT_TAGS",
"type": "``\"product_tags\"``",
"type": "`\"product_tags\"`",
"description": "The discount condition is used for product tags.",
"optional": true,
"defaultValue": "",
@@ -848,7 +848,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCT_TYPES",
"type": "``\"product_types\"``",
"type": "`\"product_types\"`",
"description": "The discount condition is used for product types.",
"optional": true,
"defaultValue": "",