asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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/entities/classes/ShippingProfile.mdx
+23 -23
View File
@@ -22,7 +22,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -364,7 +364,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -574,7 +574,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
"children": [
{
"name": "CUSTOM",
"type": "``\"custom\"``",
"type": "`\"custom\"`",
"description": "The profile used to ship custom items.",
"optional": true,
"defaultValue": "",
@@ -583,7 +583,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "DEFAULT",
"type": "``\"default\"``",
"type": "`\"default\"`",
"description": "The default profile used to ship item.",
"optional": true,
"defaultValue": "",
@@ -592,7 +592,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "GIFT_CARD",
"type": "``\"gift_card\"``",
"type": "`\"gift_card\"`",
"description": "The profile used to ship gift cards.",
"optional": true,
"defaultValue": "",