chore(docs): Generated References (automated) (#11579)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
759 files changed
+428283
-416492
No files matched your search
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderCreditLine data model. It belongs to the Order Module.
|
||||
|
||||
<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`","descripLine truncated
|
||||
<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
|
||||
Reference in new issue
Block a user