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
@@ -93,7 +93,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -201,7 +201,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "object",
"type": "``\"cart\"``",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
@@ -237,7 +237,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"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": "",
@@ -309,7 +309,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -318,7 +318,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"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": "",
@@ -345,7 +345,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -372,7 +372,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "cart_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "is_selected",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.",
"optional": false,
"defaultValue": "",