github-actions[bot]
|
471ab72ecb
|
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 |
|
github-actions[bot]
|
21f61ec160
|
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 |
|
