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

50
www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.mdx
View File

@@ -118,7 +118,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -127,7 +127,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -163,7 +163,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -971,7 +971,7 @@ medusa.admin.salesChannels
"children": [
{
"name": "AdminSalesChannelsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; sales_channels: [SalesChannel](../internal/classes/internal.SalesChannel.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ sales_channels: [SalesChannel](../internal/classes/internal.SalesChannel.mdx)[] }``",
"description": "The list of sales channels with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1023,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1032,7 +1032,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1068,7 +1068,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1202,7 +1202,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1211,7 +1211,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1247,7 +1247,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1395,7 +1395,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1404,7 +1404,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1440,7 +1440,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1553,7 +1553,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1562,7 +1562,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1598,7 +1598,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1750,7 +1750,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1759,7 +1759,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1795,7 +1795,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",