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/Customer.mdx
+38 -38
View File
@@ -21,7 +21,7 @@ A customer can make purchases in your store and manage their profile.
"children": [
{
"name": "address_1",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "address_2",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "city",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "company",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "first_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "last_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "phone",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "postal_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "province",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -518,7 +518,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -635,7 +635,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -752,7 +752,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -788,7 +788,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -833,7 +833,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -842,7 +842,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -897,7 +897,7 @@ A customer can make purchases in your store and manage their profile.
"children": [
{
"name": "address_1",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
@@ -906,7 +906,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "address_2",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
@@ -915,7 +915,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "city",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
@@ -924,7 +924,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "company",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
@@ -933,7 +933,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -942,7 +942,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
@@ -960,7 +960,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -969,7 +969,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
@@ -978,7 +978,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -987,7 +987,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "first_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
@@ -1005,7 +1005,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "last_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1023,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "phone",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
@@ -1032,7 +1032,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "postal_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
@@ -1041,7 +1041,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "province",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",