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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/entities/classes/TaxRate.mdx
+34 -34
View File
@@ -40,7 +40,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"type": "[ProductType](ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -140,7 +140,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -158,7 +158,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"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": "",
@@ -311,7 +311,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -329,7 +329,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -347,7 +347,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -365,7 +365,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -383,7 +383,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -410,7 +410,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -510,7 +510,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -537,7 +537,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -574,7 +574,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -592,7 +592,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -610,7 +610,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the 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": "",
@@ -675,7 +675,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -693,7 +693,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -710,7 +710,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -756,7 +756,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -774,8 +774,8 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -783,7 +783,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -801,7 +801,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -819,7 +819,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -837,7 +837,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "requirements",
"type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",