chore(docs): Generated References (automated) (#12492)

Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `modules`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and GitHub committed 2025-05-15 08:36:24 +00:00
1 parent d3d138bad3
commit e81d2333bc
579 files changed
+143451 -141621

No files matched your search

@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Customer data model. It belongs to the Customer Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/customer/src/models/customer.ts#L6" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/customer/src/models/customer.ts#L6" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](./page.mdx)&#62;","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"addresses","type":"HasMany&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","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&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](./page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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","typLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the CustomerAddress data model. It belongs to the Customer Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/customer/src/models/address.ts#L4" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/customer/src/models/address.ts#L4" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","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&#60;[CustomerAddress](./page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","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
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the CustomerGroup data model. It belongs to the Customer Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/customer/src/models/customer-group.ts#L5" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/customer/src/models/customer-group.ts#L5" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[CustomerGroup](./page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","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&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","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 pLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the CustomerGroupCustomer data model. It belongs to the Customer Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/customer/src/models/customer-group-customer.ts#L5" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/customer/src/models/customer-group-customer.ts#L5" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the group-customer pairing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","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&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","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