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/TaxRate.mdx
+25 -25
View File
@@ -13,7 +13,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
<ParameterTypes parameters={[
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -239,7 +239,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -275,7 +275,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -284,7 +284,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -293,7 +293,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -302,7 +302,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -320,7 +320,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -374,7 +374,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -419,7 +419,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -455,7 +455,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -466,7 +466,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -528,7 +528,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -619,7 +619,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -637,7 +637,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -692,7 +692,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"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": "",
@@ -719,7 +719,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",