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
GitHub
@@ -84,7 +84,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"type": "`null` \\| `Date`",
|
||||
"description": "The date with timezone at which the resource was deleted.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -165,7 +165,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "item_tax_total",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The total of items with taxes",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -192,7 +192,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "object",
|
||||
"type": "``\"cart\"``",
|
||||
"type": "`\"cart\"`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "\"cart\"",
|
||||
@@ -228,7 +228,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "payment_session",
|
||||
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
|
||||
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
|
||||
"description": "The details of the selected payment session in the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -300,7 +300,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "sales_channel_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The sales channel ID the cart is associated with.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -309,7 +309,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "``null`` \\| [Address](Address.mdx)",
|
||||
"type": "`null` \\| [Address](Address.mdx)",
|
||||
"description": "The details of the shipping address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -336,7 +336,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "shipping_tax_total",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The total of shipping with taxes",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -363,7 +363,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "tax_total",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The total of tax",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -609,7 +609,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "claim_order_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the claim that the shipping method is used in.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -816,7 +816,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "external_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of an external order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -897,7 +897,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "item_tax_total",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The tax total applied on items",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -933,7 +933,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "object",
|
||||
"type": "``\"order\"``",
|
||||
"type": "`\"order\"`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "\"order\"",
|
||||
@@ -1050,7 +1050,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "sales_channel_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the sales channel this order belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1086,7 +1086,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "shipping_tax_total",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The tax total applied on shipping",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1131,7 +1131,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "tax_rate",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The order's tax rate",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1140,7 +1140,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "tax_total",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The total of tax",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1213,7 +1213,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "claim_order_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the claim that the return may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1240,7 +1240,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "idempotency_key",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1258,7 +1258,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the stock location the return will be added back.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1267,7 +1267,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| `Record<string, unknown>`",
|
||||
"type": "`null` \\| `Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1276,7 +1276,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "no_notification",
|
||||
"type": "``null`` \\| `boolean`",
|
||||
"type": "`null` \\| `boolean`",
|
||||
"description": "When set to true, no notification will be sent related to this return.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1294,7 +1294,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "order_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the order that the return was created for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1357,7 +1357,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "swap_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the swap that the return may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1394,7 +1394,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1421,7 +1421,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"type": "`null` \\| `Date`",
|
||||
"description": "The date with timezone at which the resource was deleted.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1648,7 +1648,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"type": "`null` \\| `Date`",
|
||||
"description": "The date with timezone at which the resource was deleted.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1820,7 +1820,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "A code to identify the tax type by",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
Reference in New Issue
Block a user