Skip to content

Commit e76ac32

Browse files
shahednassershahednasser
committed
docs: document missing events in reference
1 parent 0e2f608 commit e76ac32

File tree

11 files changed

+205
-2
lines changed

11 files changed

+205
-2
lines changed

‎www/apps/resources/app/commerce-modules/fulfillment/events/_content.mdx

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
import { Table } from "docs-ui"
2+
3+
<Table>
4+
<Table.Header>
5+
<Table.Row>
6+
<Table.HeaderCell>Event Name</Table.HeaderCell>
7+
<Table.HeaderCell>Description</Table.HeaderCell>
8+
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
9+
</Table.Row>
10+
</Table.Header>
11+
<Table.Body>
12+
<Table.Row>
13+
<Table.Cell>
14+
15+
`shipment.created`
16+
17+
</Table.Cell>
18+
<Table.Cell>
19+
20+
Emitted when an admin user creates a shipment.
21+
22+
</Table.Cell>
23+
<Table.Cell>
24+
25+
```ts blockStyle="inline"
26+
{
27+
id, // The ID of the shipment
28+
}
29+
```
30+
31+
</Table.Cell>
32+
</Table.Row>
33+
<Table.Row>
34+
<Table.Cell>
35+
36+
`delivery.created`
37+
38+
</Table.Cell>
39+
<Table.Cell>
40+
41+
Emitted when the admin user marks an order fulfillment as delivered.
42+
43+
</Table.Cell>
44+
<Table.Cell>
45+
46+
```ts blockStyle="inline"
47+
{
48+
id, // The ID of the fulfillment
49+
}
50+
```
51+
52+
</Table.Cell>
53+
</Table.Row>
54+
</Table.Body>
55+
</Table>

‎www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import Content from "./_content.mdx"
2+
3+
export const metadata = {
4+
title: `Fulfillment Module Events Reference`,
5+
}
6+
7+
# {metadata.title}
8+
9+
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.
10+
11+
<Content />

‎www/apps/resources/app/commerce-modules/order/events/_content.mdx

+21
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,27 @@ import { Table } from "docs-ui"
99
</Table.Row>
1010
</Table.Header>
1111
<Table.Body>
12+
<Table.Row>
13+
<Table.Cell>
14+
15+
`order.updated`
16+
17+
</Table.Cell>
18+
<Table.Cell>
19+
20+
Emitted when an admin user updates an order's details.
21+
22+
</Table.Cell>
23+
<Table.Cell>
24+
25+
```ts blockStyle="inline"
26+
{
27+
id, // The ID of the order
28+
}
29+
```
30+
31+
</Table.Cell>
32+
</Table.Row>
1233
<Table.Row>
1334
<Table.Cell>
1435

‎www/apps/resources/app/commerce-modules/payment/events/_content.mdx

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
import { Table } from "docs-ui"
2+
3+
<Table>
4+
<Table.Header>
5+
<Table.Row>
6+
<Table.HeaderCell>Event Name</Table.HeaderCell>
7+
<Table.HeaderCell>Description</Table.HeaderCell>
8+
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
9+
</Table.Row>
10+
</Table.Header>
11+
<Table.Body>
12+
<Table.Row>
13+
<Table.Cell>
14+
15+
`payment.captured`
16+
17+
</Table.Cell>
18+
<Table.Cell>
19+
20+
Emitted when a payment is captured.
21+
22+
</Table.Cell>
23+
<Table.Cell>
24+
25+
```ts blockStyle="inline"
26+
{
27+
id, // The ID of the payment
28+
}
29+
```
30+
31+
</Table.Cell>
32+
</Table.Row>
33+
<Table.Row>
34+
<Table.Cell>
35+
36+
`payment.refunded`
37+
38+
</Table.Cell>
39+
<Table.Cell>
40+
41+
Emitted when a payment is refunded.
42+
43+
</Table.Cell>
44+
<Table.Cell>
45+
46+
```ts blockStyle="inline"
47+
{
48+
id, // The ID of the payment
49+
}
50+
```
51+
52+
</Table.Cell>
53+
</Table.Row>
54+
</Table.Body>
55+
</Table>

‎www/apps/resources/app/commerce-modules/payment/events/page.mdx

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import Content from "./_content.mdx"
2+
3+
export const metadata = {
4+
title: `Payment Module Events Reference`,
5+
}
6+
7+
# {metadata.title}
8+
9+
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.
10+
11+
<Content />

‎www/apps/resources/app/events-reference/page.mdx

+14
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ import { Table } from "docs-ui"
22
import AuthEvents from "../commerce-modules/auth/events/_content.mdx"
33
import CartEvents from "../commerce-modules/cart/events/_content.mdx"
44
import CustomerEvents from "../commerce-modules/customer/events/_content.mdx"
5+
import FulfillmentEvents from "../commerce-modules/fulfillment/events/_content.mdx"
56
import InviteEvents from "../commerce-modules/user/events/_content/invite.mdx"
67
import OrderEvents from "../commerce-modules/order/events/_content.mdx"
8+
import PaymentEvents from "../commerce-modules/payment/events/page.mdx"
79
import ProductEvents from "../commerce-modules/product/events/_content/product.mdx"
810
import ProductCategoryEvents from "../commerce-modules/product/events/_content/product-category.mdx"
911
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
4143

4244
---
4345

46+
## Fulfillment Events
47+
48+
<FulfillmentEvents />
49+
50+
---
51+
4452
## Invite Events
4553

4654
<InviteEvents />
@@ -53,6 +61,12 @@ This documentation page includes the list of all events emitted by [Medusa's wor
5361

5462
---
5563

64+
## Payment Events
65+
66+
<PaymentEvents />
67+
68+
---
69+
5670
## Product Events
5771

5872
<ProductEvents />

‎www/apps/resources/generated/edit-dates.mjs

+4-2
Original file line numberDiff line numberDiff line change
@@ -3369,7 +3369,7 @@ export const generatedEditDates = {
33693369
"references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2024-12-23T12:30:28.159Z",
33703370
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2024-12-10T14:54:55.447Z",
33713371
"references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-12-09T13:21:32.969Z",
3372-
"app/events-reference/page.mdx": "2024-12-23T16:30:48.569Z",
3372+
"app/events-reference/page.mdx": "2024-12-31T09:44:06.198Z",
33733373
"references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2024-12-23T13:57:08.092Z",
33743374
"references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2024-12-23T13:57:08.094Z",
33753375
"references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx": "2024-12-09T13:21:55.464Z",
@@ -5766,5 +5766,7 @@ export const generatedEditDates = {
57665766
"app/commerce-modules/tax/admin-widget-zones/page.mdx": "2024-12-24T08:47:13.176Z",
57675767
"app/commerce-modules/user/admin-widget-zones/page.mdx": "2024-12-24T08:48:14.186Z",
57685768
"app/commerce-modules/currency/links-to-other-modules/page.mdx": "2024-12-24T14:47:10.556Z",
5769-
"app/commerce-modules/customer/links-to-other-modules/page.mdx": "2024-12-24T14:48:54.689Z"
5769+
"app/commerce-modules/customer/links-to-other-modules/page.mdx": "2024-12-24T14:48:54.689Z",
5770+
"app/commerce-modules/fulfillment/events/page.mdx": "2024-12-31T09:37:49.253Z",
5771+
"app/commerce-modules/payment/events/page.mdx": "2024-12-31T09:41:56.582Z"
57705772
}

‎www/apps/resources/generated/files-map.mjs

+8
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,10 @@ export const filesMap = [
255255
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/concepts/page.mdx",
256256
"pathname": "/commerce-modules/fulfillment/concepts"
257257
},
258+
{
259+
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx",
260+
"pathname": "/commerce-modules/fulfillment/events"
261+
},
258262
{
259263
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx",
260264
"pathname": "/commerce-modules/fulfillment/fulfillment-provider"
@@ -359,6 +363,10 @@ export const filesMap = [
359363
"filePath": "/www/apps/resources/app/commerce-modules/page.mdx",
360364
"pathname": "/commerce-modules"
361365
},
366+
{
367+
"filePath": "/www/apps/resources/app/commerce-modules/payment/events/page.mdx",
368+
"pathname": "/commerce-modules/payment/events"
369+
},
362370
{
363371
"filePath": "/www/apps/resources/app/commerce-modules/payment/links-to-other-modules/page.mdx",
364372
"pathname": "/commerce-modules/payment/links-to-other-modules"

‎www/apps/resources/generated/sidebar.mjs

+16
Original file line numberDiff line numberDiff line change
@@ -3511,6 +3511,14 @@ export const generatedSidebar = [
35113511
"initialOpen": false,
35123512
"description": "Find references for data models, methods, and more. These are useful for your customizations.",
35133513
"children": [
3514+
{
3515+
"loaded": true,
3516+
"isPathHref": true,
3517+
"type": "link",
3518+
"path": "/commerce-modules/fulfillment/events",
3519+
"title": "Events Reference",
3520+
"children": []
3521+
},
35143522
{
35153523
"loaded": true,
35163524
"isPathHref": true,
@@ -8041,6 +8049,14 @@ export const generatedSidebar = [
80418049
"initialOpen": false,
80428050
"description": "Find references for data models, methods, and more. These are useful for your customizations.",
80438051
"children": [
8052+
{
8053+
"loaded": true,
8054+
"isPathHref": true,
8055+
"type": "link",
8056+
"path": "/commerce-modules/payment/events",
8057+
"title": "Events Reference",
8058+
"children": []
8059+
},
80448060
{
80458061
"loaded": true,
80468062
"isPathHref": true,

‎www/apps/resources/sidebars/fulfillment.mjs

+5
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,11 @@ export const fulfillmentSidebar = [
140140
description:
141141
"Find references for data models, methods, and more. These are useful for your customizations.",
142142
children: [
143+
{
144+
type: "link",
145+
path: "/commerce-modules/fulfillment/events",
146+
title: "Events Reference",
147+
},
143148
{
144149
type: "link",
145150
path: "/commerce-modules/fulfillment/admin-widget-zones",

‎www/apps/resources/sidebars/payment.mjs

+5
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ export const paymentSidebar = [
157157
description:
158158
"Find references for data models, methods, and more. These are useful for your customizations.",
159159
children: [
160+
{
161+
type: "link",
162+
path: "/commerce-modules/payment/events",
163+
title: "Events Reference",
164+
},
160165
{
161166
type: "link",
162167
path: "/references/payment",

0 commit comments

Comments
 (0)