Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Dec 1, 2025

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.

Written by Cursor Bugbot for commit eeb0dac. This will update automatically on new commits. Configure here.

@github-actions github-actions bot requested a review from a team as a code owner December 1, 2025 18:34
@changeset-bot
Copy link

changeset-bot bot commented Dec 1, 2025

⚠️ No Changeset found

Latest commit: eeb0dac

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Dec 1, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
resources-docs Ready Ready Preview Comment Dec 2, 2025 6:58am
6 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
api-reference-v2 Ignored Ignored Preview Dec 2, 2025 6:58am
cloud-docs Ignored Ignored Preview Dec 2, 2025 6:58am
docs-ui Ignored Ignored Preview Dec 2, 2025 6:58am
docs-v2 Ignored Ignored Preview Dec 2, 2025 6:58am
medusa-docs Ignored Ignored Preview Dec 2, 2025 6:58am
user-guide Ignored Ignored Preview Dec 2, 2025 6:58am

@kodiakhq kodiakhq bot merged commit 21f61ec into develop Dec 2, 2025
46 checks passed
@kodiakhq kodiakhq bot deleted the docs/generate-reference-1764614057 branch December 2, 2025 06:59
Balu-Varanasi pushed a commit to Balu-Varanasi/medusa that referenced this pull request Dec 11, 2025
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 eeb0dac. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <[email protected]>
Co-authored-by: Shahed Nasser <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants