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

Generated the following references: - `api_key_models` - `auth_models` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `file` - `file_service` - `fulfillment` - `fulfillment_models` - `helper_steps` - `inventory_next_models` - `js_sdk` - `module_events` - `modules` - `notification` - `notification_service` - `order` - `order_models` - `payment` - `payment_models` - `pricing_models` - `product_models` - `promotion` - `promotion_models` - `region_models` - `sales_channel_models` - `stock_location_next_models` - `store_models` - `tax_models` - `types` - `user_models` - `utils` - `workflows` --- > [!NOTE] > Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values. > > - **Docs Generation**: > - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples. > - **Fulfillment Workflows/Steps**: > - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`). > - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag. > - Refreshed example snippets and sample values. > - **Notification Step** (`sendNotificationsStep`): > - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional. > - Output includes `provider_data` and `attachments` fields. > - **Order Steps/Workflows**: > - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions. > - Example payloads adjusted (IDs, currencies, amounts). > - **Meta**: > - Updated `<SourceCodeLink>` URLs to new commit hashes throughout. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. 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> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-12-02 06:59:52 +00:00
1 parent aba10608ae
commit 21f61ec160
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

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

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

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the store","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"HasMany&#60;[StoreCurrency](../store_models.StoreCurrency/page.mdx)&#62;","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether the currency is the default in the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"BelongsTo&#60;[Store](./page.mdx)&#62;","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the store","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"HasMany&#60;[StoreCurrency](../store_models.StoreCurrency/page.mdx)&#62;","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"default_sales_channel_id","type":"`TextProperty`","description":"The ID of the store's default sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`TextProperty`","description":"The ID of the store's default region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`TextProperty`","description":"The ID of the store's default stock location.","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":"default_sales_channel_id","type":"`TextProperty`","description":"The ID of the store's default sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`TextProperty`","description":"The ID of the store's default region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`TextProperty`","description":"The ID of the store's default stock location.","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="Store"/>
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"

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

-<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/store/src/models/currency.ts#L4" />
+<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/store/src/models/currency.ts#L4" />

 <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether the currency is the default in the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"BelongsTo&#60;[Store](../store_models.Store/page.mdx)&#62;","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the store","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"HasMany&#60;[StoreCurrency](./page.mdx)&#62;","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether the currency is the default in the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"BelongsTo&#60;[Store](../store_models.Store/page.mdx)&#62;","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`TextProperty`","description":"The ID of the store's default sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`TextProperty`","description":"The ID of the store's default region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`TextProperty`","description":"The ID of the store's default stock location.","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="StoreCurrency"/>