diff --git a/www/apps/resources/app/commerce-modules/fulfillment/events/_content.mdx b/www/apps/resources/app/commerce-modules/fulfillment/events/_content.mdx new file mode 100644 index 0000000000..16720edd01 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/fulfillment/events/_content.mdx @@ -0,0 +1,55 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Payload + + + + + + + `shipment.created` + + + + + Emitted when an admin user creates a shipment. + + + + +```ts blockStyle="inline" +{ + id, // The ID of the shipment +} +``` + + + + + + + `delivery.created` + + + + + Emitted when the admin user marks an order fulfillment as delivered. + + + + +```ts blockStyle="inline" +{ + id, // The ID of the fulfillment +} +``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx b/www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx new file mode 100644 index 0000000000..f5d4185be2 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx @@ -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. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/order/events/_content.mdx b/www/apps/resources/app/commerce-modules/order/events/_content.mdx index f51d4aae58..b5e8c83593 100644 --- a/www/apps/resources/app/commerce-modules/order/events/_content.mdx +++ b/www/apps/resources/app/commerce-modules/order/events/_content.mdx @@ -9,6 +9,27 @@ import { Table } from "docs-ui" + + + + `order.updated` + + + + + Emitted when an admin user updates an order's details. + + + + +```ts blockStyle="inline" +{ + id, // The ID of the order +} +``` + + + diff --git a/www/apps/resources/app/commerce-modules/payment/events/_content.mdx b/www/apps/resources/app/commerce-modules/payment/events/_content.mdx new file mode 100644 index 0000000000..41316a718c --- /dev/null +++ b/www/apps/resources/app/commerce-modules/payment/events/_content.mdx @@ -0,0 +1,55 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Payload + + + + + + + `payment.captured` + + + + + Emitted when a payment is captured. + + + + +```ts blockStyle="inline" +{ + id, // The ID of the payment +} +``` + + + + + + + `payment.refunded` + + + + + Emitted when a payment is refunded. + + + + +```ts blockStyle="inline" +{ + id, // The ID of the payment +} +``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/payment/events/page.mdx b/www/apps/resources/app/commerce-modules/payment/events/page.mdx new file mode 100644 index 0000000000..103449308f --- /dev/null +++ b/www/apps/resources/app/commerce-modules/payment/events/page.mdx @@ -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. + + \ No newline at end of file diff --git a/www/apps/resources/app/events-reference/page.mdx b/www/apps/resources/app/events-reference/page.mdx index 7d0a0b54e8..e29b6b8fbc 100644 --- a/www/apps/resources/app/events-reference/page.mdx +++ b/www/apps/resources/app/events-reference/page.mdx @@ -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 + + + +--- + ## Invite Events @@ -53,6 +61,12 @@ This documentation page includes the list of all events emitted by [Medusa's wor --- +## Payment Events + + + +--- + ## Product Events diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs index 3eda10d807..b3198c1a47 100644 --- a/www/apps/resources/generated/edit-dates.mjs +++ b/www/apps/resources/generated/edit-dates.mjs @@ -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", @@ -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" } \ No newline at end of file diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs index f925a51426..492fa0e3ec 100644 --- a/www/apps/resources/generated/files-map.mjs +++ b/www/apps/resources/generated/files-map.mjs @@ -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" @@ -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" diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs index 1fb051dad1..9d9a047972 100644 --- a/www/apps/resources/generated/sidebar.mjs +++ b/www/apps/resources/generated/sidebar.mjs @@ -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, @@ -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, diff --git a/www/apps/resources/sidebars/fulfillment.mjs b/www/apps/resources/sidebars/fulfillment.mjs index 0070c1d904..d343e63260 100644 --- a/www/apps/resources/sidebars/fulfillment.mjs +++ b/www/apps/resources/sidebars/fulfillment.mjs @@ -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", diff --git a/www/apps/resources/sidebars/payment.mjs b/www/apps/resources/sidebars/payment.mjs index 51050eaee2..ed5b689d18 100644 --- a/www/apps/resources/sidebars/payment.mjs +++ b/www/apps/resources/sidebars/payment.mjs @@ -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",