docs: generate references after adding copy subscriber button (#12407)
* docs: generate references after adding copy subscriber button * re-generate
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
7ef13495d6
commit
41f46b7723
113 files changed
+170325
-164016
No files matched your search
@@ -127,7 +127,11 @@ another customer.
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `order.updated`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderupdated", children: (<>order.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.updated" payload={`\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when the details of an order or draft order is updated. This
|
||||
doesn't include updates made by an edit.
|
||||
@@ -142,12 +146,18 @@ doesn't include updates made by an edit.
|
||||
|
||||
#### 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.
|
||||
|
||||
- [updateOrderWorkflow](/references/medusa-workflows/updateOrderWorkflow)
|
||||
- [updateDraftOrderWorkflow](/references/medusa-workflows/updateDraftOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.placed`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderplaced", children: (<>order.placed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.placed" payload={`\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order is placed, or when a draft order is converted to an
|
||||
order.
|
||||
@@ -162,13 +172,19 @@ order.
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [completeCartWorkflow](/references/medusa-workflows/completeCartWorkflow)
|
||||
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.
|
||||
|
||||
- [convertDraftOrderWorkflow](/references/medusa-workflows/convertDraftOrderWorkflow)
|
||||
- [completeCartWorkflow](/references/medusa-workflows/completeCartWorkflow)
|
||||
- [processPaymentWorkflow](/references/medusa-workflows/processPaymentWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.canceled`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "ordercanceled", children: (<>order.canceled</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.canceled" payload={`\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order is canceld.
|
||||
|
||||
@@ -182,11 +198,17 @@ Emitted when an order is canceld.
|
||||
|
||||
#### 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.
|
||||
|
||||
- [cancelOrderWorkflow](/references/medusa-workflows/cancelOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.completed`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "ordercompleted", children: (<>order.completed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.completed" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when orders are completed.
|
||||
|
||||
@@ -200,11 +222,17 @@ Emitted when orders are completed.
|
||||
|
||||
#### 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.
|
||||
|
||||
- [completeOrderWorkflow](/references/medusa-workflows/completeOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.archived`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderarchived", children: (<>order.archived</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.archived" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order is archived.
|
||||
|
||||
@@ -218,11 +246,19 @@ Emitted when an order is archived.
|
||||
|
||||
#### 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.
|
||||
|
||||
- [archiveOrderWorkflow](/references/medusa-workflows/archiveOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.fulfillment_created`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderfulfillment_created", children: (<>order.fulfillment_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.fulfillment_created" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // (boolean) Whether to notify the customer
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a fulfillment is created for an order.
|
||||
|
||||
@@ -232,17 +268,25 @@ Emitted when a fulfillment is created for an order.
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // Whether to notify the customer
|
||||
no_notification, // (boolean) Whether to notify 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.
|
||||
|
||||
- [createOrderFulfillmentWorkflow](/references/medusa-workflows/createOrderFulfillmentWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.fulfillment_canceled`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderfulfillment_canceled", children: (<>order.fulfillment_canceled</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.fulfillment_canceled" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // (boolean) Whether to notify the customer
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order's fulfillment is canceled.
|
||||
|
||||
@@ -252,17 +296,24 @@ Emitted when an order's fulfillment is canceled.
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // Whether to notify the customer
|
||||
no_notification, // (boolean) Whether to notify 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.
|
||||
|
||||
- [cancelOrderFulfillmentWorkflow](/references/medusa-workflows/cancelOrderFulfillmentWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.return_requested`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderreturn_requested", children: (<>order.return_requested</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.return_requested" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a return request is confirmed.
|
||||
|
||||
@@ -277,12 +328,19 @@ Emitted when a return request is confirmed.
|
||||
|
||||
#### 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.
|
||||
|
||||
- [createAndCompleteReturnOrderWorkflow](/references/medusa-workflows/createAndCompleteReturnOrderWorkflow)
|
||||
- [confirmReturnRequestWorkflow](/references/medusa-workflows/confirmReturnRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.return_received`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderreturn_received", children: (<>order.return_received</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.return_received" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a return is marked as received.
|
||||
|
||||
@@ -297,12 +355,19 @@ Emitted when a return is marked as received.
|
||||
|
||||
#### 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.
|
||||
|
||||
- [createAndCompleteReturnOrderWorkflow](/references/medusa-workflows/createAndCompleteReturnOrderWorkflow)
|
||||
- [confirmReturnReceiveWorkflow](/references/medusa-workflows/confirmReturnReceiveWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.claim_created`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderclaim_created", children: (<>order.claim_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.claim_created" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
claim_id, // The ID of the claim
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a claim is created for an order.
|
||||
|
||||
@@ -317,11 +382,18 @@ Emitted when a claim is created for an 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.
|
||||
|
||||
- [confirmClaimRequestWorkflow](/references/medusa-workflows/confirmClaimRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.exchange_created`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "orderexchange_created", children: (<>order.exchange_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.exchange_created" payload={`\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
exchange_id, // The ID of the exchange
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an exchange is created for an order.
|
||||
|
||||
@@ -336,11 +408,18 @@ Emitted when an exchange is created for an 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.
|
||||
|
||||
- [confirmExchangeRequestWorkflow](/references/medusa-workflows/confirmExchangeRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.transfer_requested`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "ordertransfer_requested", children: (<>order.transfer_requested</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.transfer_requested" payload={`\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
order_change_id, // The ID of the order change created for the transfer
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order is requested to be transferred to
|
||||
another customer.
|
||||
@@ -356,6 +435,8 @@ another 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.
|
||||
|
||||
- [requestOrderTransferWorkflow](/references/medusa-workflows/requestOrderTransferWorkflow)
|
||||
|
||||
---
|
||||
@@ -403,7 +484,12 @@ Emitted when an order edit request is canceled.
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `order-edit.requested`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editrequested", children: (<>order-edit.requested</>), 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.
|
||||
|
||||
@@ -412,17 +498,24 @@ Emitted when an order edit is requested.
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit 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)
|
||||
|
||||
---
|
||||
|
||||
### `order-edit.confirmed`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editconfirmed", children: (<>order-edit.confirmed</>), 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.
|
||||
|
||||
@@ -431,17 +524,24 @@ Emitted when an order edit request is confirmed.
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit 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)
|
||||
|
||||
---
|
||||
|
||||
### `order-edit.canceled`
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editcanceled", children: (<>order-edit.canceled</>), 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.
|
||||
|
||||
@@ -450,10 +550,12 @@ Emitted when an order edit request is canceled.
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit 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)
|
||||
Reference in new issue
Block a user