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

Generated the following references: - `api_key_models` - `auth_models` - `auth_provider` - `caching` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `fulfillment_models` - `inventory_next_models` - `js_sdk` - `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` --- > [!NOTE] > Regenerates API reference pages across models, workflows/steps, and JS SDK, and updates generated Typedoc JSON and edit-dates script. > > - **Documentation**: > - **Models References**: Regenerated pages under `apps/resources/references/*_models/variables` for `api_key`, `auth`, `cart`, `currency`, `customer`, `fulfillment`, `inventory_next`, `order`, `payment`, `pricing`, `product`, `promotion`, `region`, `sales_channel`, `stock_location_next`, `store`, `tax`, `user`. > - **Core Flows**: Added/updated `Workflows_*` and `Steps_*` reference pages across modules including `Api_Key`, `Auth`, `Cart`, `Common`, `Customer`, `Customer_Group`, `Defaults`, `Draft_Order`, `File`, `Fulfillment`, `Inventory`, `Invite`, `Line_Item`, `Order`, `Payment`, `Payment_Collection`, `Price_List`, `Pricing`, `Product`, `Product_Category`, `Promotion`, `Region`, `Reservation`, `Return_Reason`, `Sales_Channel`, `Settings`, `Shipping_Options`, `Shipping_Profile`, `Stock_Location`, `Store`, `Tax`, `User`. > - **JS SDK**: Added `js_sdk.admin.Admin.order` property and `admin.Order.updateOrderChange` method references. > - **Types**: Added `types/CachingTypes.interfaces.ICachingModuleService` reference. > - **Generated Assets**: > - Updated `utils/generated/typedoc-json-output/0-medusa.json` and `0-types.json`. > - Updated `apps/resources/generated/edit-dates.mjs`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 796f722aa33abd2033f488a33e0df81903b1b3f2. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-12-03 12:01:29 +00:00
1 parent b3bcfb7b49
commit 471ab72ecb
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the AccountHolder data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/account-holder.ts#L3" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/account-holder.ts#L3" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the payment provider storing the account holder's saved payment methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`TextProperty`","description":"The ID of the account holder in the payment provider's system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data returned by the payment provider when the account holder is created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the account holder","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="AccountHolder"/>
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the Capture data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/capture.ts#L4" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/capture.ts#L4" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the capture.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The captured amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","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":"payment_session","type":"BelongsTo&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.Line truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the Payment data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/payment.ts#L9" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/payment.ts#L9" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"context","type":"`JSONProperty`","description":"The context of the payment session, such as the billing address or the customer's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`DateTimeProperty`","description":"The date the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"HasOne&#60;[Payment](./page.mdx)&#62;","description":"The associated payment.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","dLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the PaymentCollection data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/payment-collection.ts#L6" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/payment-collection.ts#L6" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](./page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","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":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description"Line truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the PaymentProvider data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/payment-provider.ts#L4" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/payment-provider.ts#L4" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](./page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"context","type":"`JSONProperty`","description":"The context of the payment session, such as the billing address or the customer's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`DateTimeProperty`","description":"The date the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"HasOne&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#Line truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the PaymentSession data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/payment-session.ts#L5" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/payment-session.ts#L5" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](./page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"context","type":"`JSONProperLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the Refund data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/refund.ts#L5" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/refund.ts#L5" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","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":"payment_session","type":"BelongsTo&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.mLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the RefundReason data model. It belongs to the Payment Module.

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/payment/src/models/refund-reason.ts#L4" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/payment/src/models/refund-reason.ts#L4" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"HasMany&#60;[Refund](../payment_models.Refund/page.mdx)&#62;","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_session","type":"BelongsTo&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"refunds","type":"HasMany&#60;[Refund](../payment_models.Refund/page.mdx)&#62;","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"captures","type":"HasMany&#60;[Capture](../payment_models.Capture/page.mdx)&#62;","description":"The associated captures.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","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":"captured_at","type":"`DateTimeProperty`","description":"The date that the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`DateTimeProperty`","description":"The date that the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refund_reason","type":"BelongsTo&#60;[RefundReason](./page.mdx)&#62;","description":"The associated refund reason.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"HasMany&#60;[Refund](../payment_models.Refund/page.mdx)&#62;","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the refund 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":"note","type":"`TextProperty`","description":"A note with more explanation about the refund","optional":true,"defaultValue":"","expandable":false,"childreLine truncated