docs: generate references manually for v2.1.2 (#10639)
* docs: manually generate references for v2.1.2 * more changes
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
ee62083c52
commit
0f5d640736
196 files changed
+267336
-200539
No files matched your search
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: customerModelReference
|
||||
slug: /references/customer/models/Customer
|
||||
sidebar_label: Customer
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Customer - Customer Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Customer data model. It belongs to the Customer Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"company_name","type":"`TextProperty`","description":"The company name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"Line truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: customerModelReference
|
||||
slug: /references/customer/models/CustomerAddress
|
||||
sidebar_label: CustomerAddress
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CustomerAddress - Customer Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the CustomerAddress data model. It belongs to the Customer Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"Line truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: customerModelReference
|
||||
slug: /references/customer/models/CustomerGroup
|
||||
sidebar_label: CustomerGroup
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CustomerGroup - Customer Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the CustomerGroup data model. It belongs to the Customer Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value paiLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: customerModelReference
|
||||
slug: /references/customer/models/CustomerGroupCustomer
|
||||
sidebar_label: CustomerGroupCustomer
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CustomerGroupCustomer - Customer Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the CustomerGroupCustomer data model. It belongs to the Customer Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the group-customer pairing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"company_name","type":"`TextProperLine truncated
|
||||
Reference in new issue
Block a user