docs: general fixes to references (#5653)

* 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
@@ -66,7 +66,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -454,7 +454,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -490,7 +490,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -607,7 +607,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -643,7 +643,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -688,7 +688,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -697,7 +697,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -735,7 +735,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax rate of the transaction",
"optional": false,
"defaultValue": "",