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/AdminDraftOrdersResource.mdx
+7 -7
View File
@@ -861,7 +861,7 @@ medusa.admin.draftOrders
"children": [
{
"name": "AdminDraftOrdersListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ draft_orders: [DraftOrder](../internal/classes/internal.DraftOrder.mdx)[] }`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ draft_orders: [DraftOrder](../internal/classes/internal.DraftOrder.mdx)[] }``",
"description": "The list of draft orders with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -1268,7 +1268,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -1349,7 +1349,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -1493,7 +1493,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1529,7 +1529,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -1574,7 +1574,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -1583,7 +1583,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",