asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5602)

Browse Source 
Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-10 17:31:02 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 5f4317b9d7
commit 39649b3552
2110 changed files with 148777 additions and 4448445 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx
+36 -107
View File
@@ -6,207 +6,134 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SalesChannelLocation
This represents the association between a sales channel and a stock locations.
## Properties
<ParameterTypes parameters={[
{
"name": "created_at",
"type": "`Date`",
"description": "",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"description": "",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "",
"description": "The Sales Channel Stock Location's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "",
"description": "The ID of the Location Stock.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"description": "",
"description": "The details of the sales channel the location is associated with.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "constructor",
"type": "() => [`SalesChannel`](SalesChannel.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"description": "",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "``null`` \\| `string`",
"description": "",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "",
"description": "The sales channel's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_disabled",
"type": "`boolean`",
"description": "",
"description": "Specify if the sales channel is enabled or disabled.",
"optional": false,
"defaultValue": "",
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "locations",
"type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
"description": "",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
"children": [
{
"name": "constructor",
"type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "location_id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "sales_channel_id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "beforeInsert",
"type": "() => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
"expandable": true,
"children": []
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"description": "",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "",
"description": "The name of the sales channel.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "beforeInsert",
"type": "() => `void`",
"description": "",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -214,17 +141,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "sales_channel_id",
"type": "`string`",
"description": "",
"description": "The ID of the Sales Channel",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />