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/js-client/classes/LineItemsResource.mdx
+24 -24
View File
@@ -112,7 +112,7 @@ medusa.carts.lineItems
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ medusa.carts.lineItems
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,7 @@ medusa.carts.lineItems
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -318,7 +318,7 @@ medusa.carts.lineItems
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -372,7 +372,7 @@ medusa.carts.lineItems
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -381,7 +381,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -408,7 +408,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -435,7 +435,7 @@ medusa.carts.lineItems
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -546,7 +546,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -752,7 +752,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -815,7 +815,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -842,7 +842,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -869,7 +869,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -1012,7 +1012,7 @@ medusa.carts.lineItems
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -1083,7 +1083,7 @@ medusa.carts.lineItems
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1164,7 +1164,7 @@ medusa.carts.lineItems
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -1218,7 +1218,7 @@ medusa.carts.lineItems
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -1272,7 +1272,7 @@ medusa.carts.lineItems
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -1281,7 +1281,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -1308,7 +1308,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -1335,7 +1335,7 @@ medusa.carts.lineItems
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",