Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document missing events in reference #10779

Merged
merged 1 commit into from
Dec 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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>
Original file line number Diff line number Diff line change
@@ -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 />
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
Original file line number Diff line number Diff line change
@@ -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>
11 changes: 11 additions & 0 deletions www/apps/resources/app/commerce-modules/payment/events/page.mdx
Original file line number Diff line number Diff line change
@@ -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 />
14 changes: 14 additions & 0 deletions www/apps/resources/app/events-reference/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -41,6 +43,12 @@ This documentation page includes the list of all events emitted by [Medusa's wor

---

## Fulfillment Events

<FulfillmentEvents />

---

## Invite Events

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

---

## Payment Events

<PaymentEvents />

---

## Product Events

<ProductEvents />
Expand Down
6 changes: 4 additions & 2 deletions www/apps/resources/generated/edit-dates.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3369,7 +3369,7 @@ export const generatedEditDates = {
"references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2024-12-23T12:30:28.159Z",
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2024-12-10T14:54:55.447Z",
"references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-12-09T13:21:32.969Z",
"app/events-reference/page.mdx": "2024-12-23T16:30:48.569Z",
"app/events-reference/page.mdx": "2024-12-31T09:44:06.198Z",
"references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2024-12-23T13:57:08.092Z",
"references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2024-12-23T13:57:08.094Z",
"references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx": "2024-12-09T13:21:55.464Z",
Expand Down Expand Up @@ -5766,5 +5766,7 @@ export const generatedEditDates = {
"app/commerce-modules/tax/admin-widget-zones/page.mdx": "2024-12-24T08:47:13.176Z",
"app/commerce-modules/user/admin-widget-zones/page.mdx": "2024-12-24T08:48:14.186Z",
"app/commerce-modules/currency/links-to-other-modules/page.mdx": "2024-12-24T14:47:10.556Z",
"app/commerce-modules/customer/links-to-other-modules/page.mdx": "2024-12-24T14:48:54.689Z"
"app/commerce-modules/customer/links-to-other-modules/page.mdx": "2024-12-24T14:48:54.689Z",
"app/commerce-modules/fulfillment/events/page.mdx": "2024-12-31T09:37:49.253Z",
"app/commerce-modules/payment/events/page.mdx": "2024-12-31T09:41:56.582Z"
}
8 changes: 8 additions & 0 deletions www/apps/resources/generated/files-map.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/concepts/page.mdx",
"pathname": "/commerce-modules/fulfillment/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx",
"pathname": "/commerce-modules/fulfillment/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx",
"pathname": "/commerce-modules/fulfillment/fulfillment-provider"
Expand Down Expand Up @@ -359,6 +363,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/page.mdx",
"pathname": "/commerce-modules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/events/page.mdx",
"pathname": "/commerce-modules/payment/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/payment/links-to-other-modules"
Expand Down
16 changes: 16 additions & 0 deletions www/apps/resources/generated/sidebar.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3511,6 +3511,14 @@ export const generatedSidebar = [
"initialOpen": false,
"description": "Find references for data models, methods, and more. These are useful for your customizations.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/fulfillment/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
Expand Down Expand Up @@ -8041,6 +8049,14 @@ export const generatedSidebar = [
"initialOpen": false,
"description": "Find references for data models, methods, and more. These are useful for your customizations.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/payment/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
Expand Down
5 changes: 5 additions & 0 deletions www/apps/resources/sidebars/fulfillment.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ export const fulfillmentSidebar = [
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/fulfillment/events",
title: "Events Reference",
},
{
type: "link",
path: "/commerce-modules/fulfillment/admin-widget-zones",
Expand Down
5 changes: 5 additions & 0 deletions www/apps/resources/sidebars/payment.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,11 @@ export const paymentSidebar = [
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/payment/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/payment",
Expand Down
Loading