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

104
www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx
View File

@@ -104,7 +104,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
},
{
"name": "sales_channel_availability",
"type": "`{ available_quantity: number ; channel_id: string ; channel_name: string }`[]",
"type": "``{ available_quantity: number ; channel_id: string ; channel_name: string }``[]",
"description": "Details about the variant's inventory availability in sales channels.",
"optional": false,
"defaultValue": "",
@@ -315,7 +315,7 @@ medusa.admin.variants
"children": [
{
"name": "AdminVariantsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ variants: [PricedVariant](../internal/types/internal.PricedVariant.mdx)[] }`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ variants: [PricedVariant](../internal/types/internal.PricedVariant.mdx)[] }``",
"description": "The list of variants with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -367,7 +367,7 @@ medusa.admin.variants
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -385,7 +385,7 @@ medusa.admin.variants
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -394,7 +394,7 @@ medusa.admin.variants
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -403,7 +403,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -412,7 +412,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -448,7 +448,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -466,7 +466,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -475,7 +475,7 @@ medusa.admin.variants
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -502,7 +502,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -547,7 +547,7 @@ medusa.admin.variants
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.",
"optional": false,
"defaultValue": "",
@@ -565,7 +565,7 @@ medusa.admin.variants
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -583,7 +583,7 @@ medusa.admin.variants
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -592,7 +592,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -601,7 +601,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -610,7 +610,7 @@ medusa.admin.variants
},
{
"name": "calculated_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The lowest price among the retrieved prices.",
"optional": false,
"defaultValue": "",
@@ -619,7 +619,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `calculated_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -629,7 +629,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_type",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.",
"optional": true,
"defaultValue": "",
@@ -638,7 +638,7 @@ medusa.admin.variants
},
{
"name": "original_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The original price of the variant.",
"optional": false,
"defaultValue": "",
@@ -647,7 +647,7 @@ medusa.admin.variants
},
{
"name": "original_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `original_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -666,7 +666,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the calculated price.",
"optional": false,
"defaultValue": "",
@@ -675,7 +675,7 @@ medusa.admin.variants
},
{
"name": "calculated_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the calculated price.",
"optional": false,
"defaultValue": "",
@@ -684,7 +684,7 @@ medusa.admin.variants
},
{
"name": "original_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the original price.",
"optional": false,
"defaultValue": "",
@@ -693,7 +693,7 @@ medusa.admin.variants
},
{
"name": "original_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the original price.",
"optional": false,
"defaultValue": "",
@@ -702,7 +702,7 @@ medusa.admin.variants
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",
@@ -840,7 +840,7 @@ medusa.admin.variants
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -858,7 +858,7 @@ medusa.admin.variants
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -867,7 +867,7 @@ medusa.admin.variants
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -876,7 +876,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -885,7 +885,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -921,7 +921,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -939,7 +939,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -948,7 +948,7 @@ medusa.admin.variants
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -957,7 +957,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -975,7 +975,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -1020,7 +1020,7 @@ medusa.admin.variants
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.",
"optional": false,
"defaultValue": "",
@@ -1038,7 +1038,7 @@ medusa.admin.variants
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -1056,7 +1056,7 @@ medusa.admin.variants
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -1065,7 +1065,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -1074,7 +1074,7 @@ medusa.admin.variants
},
{
"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": "",
@@ -1083,7 +1083,7 @@ medusa.admin.variants
},
{
"name": "calculated_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The lowest price among the retrieved prices.",
"optional": false,
"defaultValue": "",
@@ -1092,7 +1092,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `calculated_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -1102,7 +1102,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_type",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.",
"optional": true,
"defaultValue": "",
@@ -1111,7 +1111,7 @@ medusa.admin.variants
},
{
"name": "original_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The original price of the variant.",
"optional": false,
"defaultValue": "",
@@ -1120,7 +1120,7 @@ medusa.admin.variants
},
{
"name": "original_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `original_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -1139,7 +1139,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the calculated price.",
"optional": false,
"defaultValue": "",
@@ -1148,7 +1148,7 @@ medusa.admin.variants
},
{
"name": "calculated_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the calculated price.",
"optional": false,
"defaultValue": "",
@@ -1157,7 +1157,7 @@ medusa.admin.variants
},
{
"name": "original_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the original price.",
"optional": false,
"defaultValue": "",
@@ -1166,7 +1166,7 @@ medusa.admin.variants
},
{
"name": "original_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the original price.",
"optional": false,
"defaultValue": "",
@@ -1175,7 +1175,7 @@ medusa.admin.variants
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",