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>
This commit is contained in:
983 files changed
+427349
-403173
No files matched your search
@@ -52,9 +52,9 @@ Emitted when regions are deleted.
|
||||
</Table>
|
||||
|
||||
<EventHeader headerLvl="2" headerProps={{ id: "regionupdated", children: (<>region.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.updated" payload={`\`\`\`ts
|
||||
[{
|
||||
{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when regions are updated.
|
||||
@@ -62,9 +62,9 @@ Emitted when regions are updated.
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
@@ -76,9 +76,9 @@ The following workflows emit this event when they're executed. These workflows a
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="2" headerProps={{ id: "regioncreated", children: (<>region.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.created" payload={`\`\`\`ts
|
||||
[{
|
||||
{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when regions are created.
|
||||
@@ -86,9 +86,9 @@ Emitted when regions are created.
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
@@ -100,9 +100,9 @@ The following workflows emit this event when they're executed. These workflows a
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="2" headerProps={{ id: "regiondeleted", children: (<>region.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.deleted" payload={`\`\`\`ts
|
||||
[{
|
||||
{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when regions are deleted.
|
||||
@@ -110,9 +110,9 @@ Emitted when regions are deleted.
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
Reference in new issue
Block a user