chore(docs): Generated References (automated) (#12460)
Generated the following references: - `_index.mdx` - `api_key` - `api_key_models` - `auth` - `auth_models` - `auth_provider` - `cart` - `cart_models` - `core_flows` - `currency` - `currency_models` - `customer` - `customer_models` - `events` - `file` - `file_service` - `fulfillment` - `fulfillment_models` - `fulfillment_provider` - `inventory_next` - `inventory_next_models` - `js_sdk` - `locking` - `medusa` - `module_events` - `modules` - `modules_sdk` - `notification` - `notification_service` - `order` - `order_models` - `payment` - `payment_models` - `payment_provider` - `pricing` - `pricing_models` - `product` - `product_models` - `promotion` - `promotion_models` - `region` - `region_models` - `sales_channel` - `sales_channel_models` - `stock_location_next` - `stock_location_next_models` - `store` - `store_models` - `tax` - `tax_models` - `tax_provider` - `types` - `user` - `user_models` - `utils` - `workflows` 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:
1978 files changed
+332243
-279592
No files matched your search
@@ -48,6 +48,15 @@ Emitted when a cart's details are updated.
|
||||
<Table.Cell>
|
||||
Emitted when the cart's region is updated. This
|
||||
event is emitted alongside the `cart.updated` event.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[cart.customer_transferred](#cartcustomer_transferred)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when the customer in the cart is transferred.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
@@ -129,6 +138,35 @@ The following workflows emit this event when they're executed. These workflows a
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "cartcustomer_transferred", children: (<>cart.customer_transferred
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.customer_transferred" payload={`\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
customer_id, // The ID of the customer
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when the customer in the cart is transferred.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
customer_id, // The ID of the customer
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [transferCartCustomerWorkflow](/references/medusa-workflows/transferCartCustomerWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Customer Events
|
||||
|
||||
### Summary
|
||||
@@ -678,6 +716,139 @@ The following workflows emit this event when they're executed. These workflows a
|
||||
|
||||
---
|
||||
|
||||
## Order Edit Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.requested](#order-editrequested)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit is requested.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.confirmed](#order-editconfirmed)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit request is confirmed.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.canceled](#order-editcanceled)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit request is canceled.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editrequested", children: (<>order-edit.requested
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.requested" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order edit is requested.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [requestOrderEditRequestWorkflow](/references/medusa-workflows/requestOrderEditRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editconfirmed", children: (<>order-edit.confirmed
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.confirmed" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order edit request is confirmed.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [confirmOrderEditRequestWorkflow](/references/medusa-workflows/confirmOrderEditRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editcanceled", children: (<>order-edit.canceled
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.canceled" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order edit request is canceled.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [cancelBeginOrderEditWorkflow](/references/medusa-workflows/cancelBeginOrderEditWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## User Events
|
||||
|
||||
### Summary
|
||||
|
||||
Reference in new issue
Block a user