docs: document missing events in reference (#10779)
This commit is contained in:
1 parent
0e2f608db8
commit
6780ea9f13
11 files changed
+205
-2
No files matched your search
@@ -0,0 +1,55 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`shipment.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an admin user creates a shipment.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the shipment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`delivery.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when the admin user marks an order fulfillment as delivered.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the fulfillment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -0,0 +1,11 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Fulfillment Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Fulfillment Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
<Content />
|
||||
@@ -9,6 +9,27 @@ import { Table } from "docs-ui"
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an admin user updates an order's details.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`payment.captured`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a payment is captured.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`payment.refunded`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a payment is refunded.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -0,0 +1,11 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Payment Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Payment Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
<Content />
|
||||
@@ -2,8 +2,10 @@ import { Table } from "docs-ui"
|
||||
import AuthEvents from "../commerce-modules/auth/events/_content.mdx"
|
||||
import CartEvents from "../commerce-modules/cart/events/_content.mdx"
|
||||
import CustomerEvents from "../commerce-modules/customer/events/_content.mdx"
|
||||
import FulfillmentEvents from "../commerce-modules/fulfillment/events/_content.mdx"
|
||||
import InviteEvents from "../commerce-modules/user/events/_content/invite.mdx"
|
||||
import OrderEvents from "../commerce-modules/order/events/_content.mdx"
|
||||
import PaymentEvents from "../commerce-modules/payment/events/page.mdx"
|
||||
import ProductEvents from "../commerce-modules/product/events/_content/product.mdx"
|
||||
import ProductCategoryEvents from "../commerce-modules/product/events/_content/product-category.mdx"
|
||||
import ProductCollectionEvents from "../commerce-modules/product/events/_content/product-collection.mdx"
|
||||
@@ -41,6 +43,12 @@ This documentation page includes the list of all events emitted by [Medusa's wor
|
||||
|
||||
---
|
||||
|
||||
## Fulfillment Events
|
||||
|
||||
<FulfillmentEvents />
|
||||
|
||||
---
|
||||
|
||||
## Invite Events
|
||||
|
||||
<InviteEvents />
|
||||
@@ -53,6 +61,12 @@ This documentation page includes the list of all events emitted by [Medusa's wor
|
||||
|
||||
---
|
||||
|
||||
## Payment Events
|
||||
|
||||
<PaymentEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Events
|
||||
|
||||
<ProductEvents />
|
||||
|
||||
Reference in new issue
Block a user