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/LineItem.mdx
+21 -21
View File
@@ -76,7 +76,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
@@ -94,7 +94,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "fulfilled_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "gift_card_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "has_shipping",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -185,7 +185,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
@@ -194,7 +194,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_item_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
"optional": true,
"defaultValue": "",
@@ -212,7 +212,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -221,7 +221,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -230,7 +230,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "product_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "raw_discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
@@ -257,7 +257,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "refundable",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
@@ -266,7 +266,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "returned_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
@@ -275,7 +275,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "shipped_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "subtotal",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
@@ -329,7 +329,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
@@ -338,7 +338,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -392,7 +392,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "variant_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",