chore(docs): Generated References (automated) (#13027)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
1 parent
d5beb2fa64
commit
0ccaa19918
477 files changed
+212702
-219002
No files matched your search
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Order data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/fc377a136006df0f1c3d5cb6e0be340a486a03f0/packages/modules/order/src/models/order.ts#L124" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/order/src/models/order.ts#L124" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notifications for order updates.","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":"canceled_at","type":"`DateTimeProperty`","description":"The date the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Order"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderAddress data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/fc377a136006df0f1c3d5cb6e0be340a486a03f0/packages/modules/order/src/models/address.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/order/src/models/address.ts#L27" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that the address belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the order address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the order 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":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderAddress"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderCreditLine data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/fc377a136006df0f1c3d5cb6e0be340a486a03f0/packages/modules/order/src/models/credit-line.ts#L31" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/order/src/models/credit-line.ts#L31" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"BelongsTo<[Order](../order_models.Order/page.mdx)>","description":"The associated order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notifications for order updates.","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":"canceled_at","type":"`DateTimeProperty`","description":"The date the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the order credit line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`JSONProperty`","description":"The raw amount of the order credit line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`TextProperty`","description":"The table that this credit line references. For example, `payment_collection`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`TextProperty`","description":"The ID of the record in the referenced table. For example, `paycol_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","descriptionLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderItem data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/fc377a136006df0f1c3d5cb6e0be340a486a03f0/packages/modules/order/src/models/order-item.ts#L56" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/order/src/models/order-item.ts#L56" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version that the order item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`BigNumberProperty`","description":"The fulfilled quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_quantity","type":"`BigNumberProperty`","description":"The delivered quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`BigNumberProperty`","description":"The shipped quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"`BigNumberProperty`","description":"The quantity requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"`BigNumberProperty`","description":"The quantity received by a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"`BigNumberProperty`","description":"The quantity dismissed by a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"`BigNumberProperty`","description":"The quantity written off by an order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"BelongsTo<[Order](../order_models.Order/page.mdx)>","description":"The associated order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notificaLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderSummary data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/fc377a136006df0f1c3d5cb6e0be340a486a03f0/packages/modules/order/src/models/order-summary.ts#L34" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/order/src/models/order-summary.ts#L34" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version that the summary belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totals","type":"`JSONProperty`","description":"The totals of the order summary","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"BelongsTo<[Order](../order_models.Order/page.mdx)>","description":"The associated order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notifications for order updates.","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":"canceled_at","type":"`DateTimeProperty`","description":"The date the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderSummary"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ReturnReason data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/fc377a136006df0f1c3d5cb6e0be340a486a03f0/packages/modules/order/src/models/return-reason.ts#L43" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/order/src/models/return-reason.ts#L43" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"HasMany<() => any>","description":"The associated return\\_reason\\_children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the return reason","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":"parent_return_reason","type":"BelongsTo<() => any, undefined>","description":"The associated parent\\_return\\_reason.","optional":true,"defaultValue":"","expandable":true,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ReturnReason"/>
|
||||
Reference in new issue
Block a user