diff --git a/www/apps/book/app/advanced-development/events-and-subscribers/data-payload/page.mdx b/www/apps/book/app/advanced-development/events-and-subscribers/data-payload/page.mdx index e4d884506f..8bd5d7d84f 100644 --- a/www/apps/book/app/advanced-development/events-and-subscribers/data-payload/page.mdx +++ b/www/apps/book/app/advanced-development/events-and-subscribers/data-payload/page.mdx @@ -21,7 +21,6 @@ export const highlights = [ ```ts title="src/subscribers/product-created.ts" highlights={highlights} import { - ProductService, SubscriberArgs, type SubscriberConfig, } from "@medusajs/medusa" @@ -33,11 +32,11 @@ export default async function productCreateHandler({ } export const config: SubscriberConfig = { - event: ProductService.Events.CREATED, + event: "product.created", } ``` -This logs the product ID received in the `ProductService.Events.CREATED` (`product-created`) event’s data payload to the console. +This logs the product ID received in the `product.created` event’s data payload to the console. ## List of Events with Data Payload diff --git a/www/apps/book/app/basics/events-and-subscribers/page.mdx b/www/apps/book/app/basics/events-and-subscribers/page.mdx index c90d88ee5d..639d81c83b 100644 --- a/www/apps/book/app/basics/events-and-subscribers/page.mdx +++ b/www/apps/book/app/basics/events-and-subscribers/page.mdx @@ -21,10 +21,7 @@ The subscriber is created in a TypeScript or JavaScript file under the `src/subs For example, create the file `src/subscribers/product-created.ts` with the following content: ```ts title="src/subscribers/product-created.ts" -import { - ProductService, - type SubscriberConfig, -} from "@medusajs/medusa" +import { type SubscriberConfig } from "@medusajs/medusa" // subscriber function export default async function productCreateHandler() { @@ -33,7 +30,7 @@ export default async function productCreateHandler() { // subscriber config export const config: SubscriberConfig = { - event: ProductService.Events.CREATED, + event: "product.created", } ``` @@ -42,7 +39,7 @@ A subscriber file must export: - The subscriber function that is an asynchronous function executed whenever the associated event is triggered. - A configuration object defining the event this subscriber is listening to. -The above subscriber listens to the `ProductService.Events.CREATED` (`product-created`) event. Whenever the event is emitted, it logs in the terminal `A product is created`. +The above subscriber listens to the `product.created` event. Whenever the event is emitted, it logs in the terminal `A product is created`. {/* TODO add when we have the admin dashboard to use with V2 for easy testing. */} @@ -91,7 +88,6 @@ export const highlights = [ ```ts title="src/subscribers/product-created.ts" highlights={highlights} import { - ProductService, SubscriberArgs, type SubscriberConfig, } from "@medusajs/medusa" @@ -111,7 +107,7 @@ export default async function productCreateHandler({ } export const config: SubscriberConfig = { - event: ProductService.Events.CREATED, + event: `product.created`, } ``` diff --git a/www/apps/resources/app/commerce-modules/api-key/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/api-key/events/_events-table/page.mdx new file mode 100644 index 0000000000..9b5ddf7f0e --- /dev/null +++ b/www/apps/resources/app/commerce-modules/api-key/events/_events-table/page.mdx @@ -0,0 +1,35 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `api-key.deleted` + + + + + Triggered when an API key is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted API key + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/api-key/events/page.mdx b/www/apps/resources/app/commerce-modules/api-key/events/page.mdx new file mode 100644 index 0000000000..a4f503cdb4 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/api-key/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `API Key Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the API Key Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/auth/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/auth/events/_events-table/page.mdx new file mode 100644 index 0000000000..bfc76b0c57 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/auth/events/_events-table/page.mdx @@ -0,0 +1,35 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `auth.deleted` + + + + + Triggered when an auth user is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted auth user + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/auth/events/page.mdx b/www/apps/resources/app/commerce-modules/auth/events/page.mdx new file mode 100644 index 0000000000..d3eab00127 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/auth/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Auth Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Auth Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/cart/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/cart/events/_events-table/page.mdx new file mode 100644 index 0000000000..7cd1ec77a2 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/cart/events/_events-table/page.mdx @@ -0,0 +1,189 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `cart.deleted` + + + + + Triggered when a cart is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted cart + id, + } + ``` + + + + + + + `address.deleted` + + + + + Triggered when an address is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted address + id, + } + ``` + + + + + + + `line-item.deleted` + + + + + Triggered when a line item is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted line item + id, + } + ``` + + + + + + + `line-item-adjustment.deleted` + + + + + Triggered when a line item adjustment is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted line item adjustment + id, + } + ``` + + + + + + + `line-item-tax-line.deleted` + + + + + Triggered when a line item tax line is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted line item tax line + id, + } + ``` + + + + + + + `shipping-method.deleted` + + + + + Triggered when a shipping method is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted shipping method + id, + } + ``` + + + + + + + `shipping-method-adjustment.deleted` + + + + + Triggered when a shipping method adjustment is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted shipping method adjustment + id, + } + ``` + + + + + + + `shipping-method-tax-line.deleted` + + + + + Triggered when a shipping method tax line is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted shipping method tax line + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/cart/events/page.mdx b/www/apps/resources/app/commerce-modules/cart/events/page.mdx new file mode 100644 index 0000000000..060ecb2a7a --- /dev/null +++ b/www/apps/resources/app/commerce-modules/cart/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Cart Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Cart Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/currency/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/currency/events/_events-table/page.mdx new file mode 100644 index 0000000000..304c72e5b0 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/currency/events/_events-table/page.mdx @@ -0,0 +1,35 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `currency.deleted` + + + + + Triggered when a currency is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted currency + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/currency/events/page.mdx b/www/apps/resources/app/commerce-modules/currency/events/page.mdx new file mode 100644 index 0000000000..3e42f4ed63 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/currency/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Currency Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Currency Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/customer/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/customer/events/_events-table/page.mdx new file mode 100644 index 0000000000..07bbcbad99 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/customer/events/_events-table/page.mdx @@ -0,0 +1,101 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `customer.deleted` + + + + + Triggered when a customer is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted customer + id, + } + ``` + + + + + + + `address.deleted` + + + + + Triggered when a address is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted address + id, + } + ``` + + + + + + + `customer-group.deleted` + + + + + Triggered when a customer group is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted customer group + id, + } + ``` + + + + + + + `customer-group-customer.deleted` + + + + + Triggered when a customer group customer (the data model of the relation between customer groups and customers) is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted customer group customer + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/customer/events/page.mdx b/www/apps/resources/app/commerce-modules/customer/events/page.mdx new file mode 100644 index 0000000000..9956db6dc0 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/customer/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Customer Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Customer Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/fulfillment/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/fulfillment/events/_events-table/page.mdx new file mode 100644 index 0000000000..d1da5f3fe5 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/fulfillment/events/_events-table/page.mdx @@ -0,0 +1,255 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `fulfillment-set.created` + + + + + Triggered when a fulfillment set is created. + + + + + ```ts noCopy noReport + { + // the ID of the fulfillment set + id, + } + ``` + + + + + + + `fulfillment-set.deleted` + + + + + Triggered when a fulfillment set is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted fulfillment set + id, + } + ``` + + + + + + + `service-zone.created` + + + + + Triggered when a service zone is created. + + + + + ```ts noCopy noReport + { + // the ID of the service zone + id, + } + ``` + + + + + + + `service-zone.deleted` + + + + + Triggered when a service zone is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted service zone + id, + } + ``` + + + + + + + `geo-zone.created` + + + + + Triggered when a geo zone is created. + + + + + ```ts noCopy noReport + { + // the ID of the geo zone + id, + } + ``` + + + + + + + `geo-zone.deleted` + + + + + Triggered when a geo zone is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted geo zone + id, + } + ``` + + + + + + + `shipping-option.created` + + + + + Triggered when a shipping option is created. + + + + + ```ts noCopy noReport + { + // the ID of the shipping option + id, + } + ``` + + + + + + + `shipping-profile.created` + + + + + Triggered when a shipping profile is created. + + + + + ```ts noCopy noReport + { + // the ID of the shipping profile + id, + } + ``` + + + + + + + `shipping-option-rule.created` + + + + + Triggered when a shipping option rule is created. + + + + + ```ts noCopy noReport + { + // the ID of the shipping option rule + id, + } + ``` + + + + + + + `shipping-option-type.created` + + + + + Triggered when a shipping option type is created. + + + + + ```ts noCopy noReport + { + // the ID of the shipping option type + id, + } + ``` + + + + + + + `fulfillment-provider.created` + + + + + Triggered when a fulfillment provider is created. + + + + + ```ts noCopy noReport + { + // the ID of the fulfillment provider + id, + } + ``` + + + + +
\ 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..19fd440e58 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Fulfillment Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Fulfillment Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/inventory/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/inventory/events/_events-table/page.mdx new file mode 100644 index 0000000000..52ccadc5d3 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/inventory/events/_events-table/page.mdx @@ -0,0 +1,211 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `inventory-item.created` + + + + + Triggered when a inventory item is created. + + + + + ```ts noCopy noReport + { + // the ID of the inventory item + id, + } + ``` + + + + + + + `inventory-item.updated` + + + + + Triggered when a inventory item is updated. + + + + + ```ts noCopy noReport + { + // the ID of the inventory item + id, + } + ``` + + + + + + + `inventory-item.deleted` + + + + + Triggered when a inventory item is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted inventory item + id, + } + ``` + + + + + + + `inventory-level.created` + + + + + Triggered when a inventory level is created. + + + + + ```ts noCopy noReport + { + // the ID of the inventory level + id, + } + ``` + + + + + + + `inventory-level.updated` + + + + + Triggered when a inventory level is updated. + + + + + ```ts noCopy noReport + { + // the ID of the inventory level + id, + } + ``` + + + + + + + `inventory-level.deleted` + + + + + Triggered when a inventory level is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted inventory level + id, + } + ``` + + + + + + + `reservation-item.created` + + + + + Triggered when a reservation item is created. + + + + + ```ts noCopy noReport + { + // the ID of the reservation item + id, + } + ``` + + + + + + + `reservation-item.updated` + + + + + Triggered when a reservation item is updated. + + + + + ```ts noCopy noReport + { + // the ID of the reservation item + id, + } + ``` + + + + + + + `reservation-item.deleted` + + + + + Triggered when a reservation item is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted reservation item + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/inventory/events/page.mdx b/www/apps/resources/app/commerce-modules/inventory/events/page.mdx new file mode 100644 index 0000000000..c37ba69f55 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/inventory/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Inventory Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Inventory Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/order/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/order/events/_events-table/page.mdx new file mode 100644 index 0000000000..0db26d710f --- /dev/null +++ b/www/apps/resources/app/commerce-modules/order/events/_events-table/page.mdx @@ -0,0 +1,321 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `order.deleted` + + + + + Triggered when an order is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted order + id, + } + ``` + + + + + + + `address.deleted` + + + + + Triggered when an address is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted address + id, + } + ``` + + + + + + + `line-item.deleted` + + + + + Triggered when a line item is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted line item + id, + } + ``` + + + + + + + `line-item-adjustment.deleted` + + + + + Triggered when a line item adjustment is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted line item adjustment + id, + } + ``` + + + + + + + `line-item-tax-line.deleted` + + + + + Triggered when a line item tax line is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted line item tax line + id, + } + ``` + + + + + + + `shipping-method.deleted` + + + + + Triggered when a shipping method is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted shipping method + id, + } + ``` + + + + + + + `shipping-method-adjustment.deleted` + + + + + Triggered when a shipping method adjustment is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted shipping method adjustment + id, + } + ``` + + + + + + + `shipping-method-tax-line.deleted` + + + + + Triggered when a shipping method tax line is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted shipping method tax line + id, + } + ``` + + + + + + + `transaction.deleted` + + + + + Triggered when a transaction is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted transaction + id, + } + ``` + + + + + + + `order-change.deleted` + + + + + Triggered when an order change is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted order change + id, + } + ``` + + + + + + + `order-change-action.deleted` + + + + + Triggered when an order change action is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted order change action + id, + } + ``` + + + + + + + `order-item.deleted` + + + + + Triggered when an order item is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted order item + id, + } + ``` + + + + + + + `order-summary.deleted` + + + + + Triggered when an order summary is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted order summary + id, + } + ``` + + + + + + + `order-shipping-method.deleted` + + + + + Triggered when an order shipping method is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted order shipping method + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/order/events/page.mdx b/www/apps/resources/app/commerce-modules/order/events/page.mdx new file mode 100644 index 0000000000..3365fd59b6 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/order/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Order Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Order Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/payment/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/payment/events/_events-table/page.mdx new file mode 100644 index 0000000000..a80eb468dd --- /dev/null +++ b/www/apps/resources/app/commerce-modules/payment/events/_events-table/page.mdx @@ -0,0 +1,123 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `payment.deleted` + + + + + Triggered when a payment is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted payment + id, + } + ``` + + + + + + + `payment-collection.deleted` + + + + + Triggered when a payment collection is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted payment collection + id, + } + ``` + + + + + + + `payment-session.deleted` + + + + + Triggered when a payment session is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted payment session + id, + } + ``` + + + + + + + `capture.deleted` + + + + + Triggered when a capture is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted capture + id, + } + ``` + + + + + + + `refund.deleted` + + + + + Triggered when a refund is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted refund + id, + } + ``` + + + + +
\ 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..305f780183 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/payment/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Payment Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Payment Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/pricing/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/pricing/events/_events-table/page.mdx new file mode 100644 index 0000000000..fac799f90a --- /dev/null +++ b/www/apps/resources/app/commerce-modules/pricing/events/_events-table/page.mdx @@ -0,0 +1,189 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `price-set.deleted` + + + + + Triggered when a price set is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted price set + id, + } + ``` + + + + + + + `price-list.deleted` + + + + + Triggered when a price list is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted price list + id, + } + ``` + + + + + + + `price-list-rule.deleted` + + + + + Triggered when a price list rule is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted price list rule + id, + } + ``` + + + + + + + `price-list-rule-value.deleted` + + + + + Triggered when a price list rule value is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted price list rule value + id, + } + ``` + + + + + + + `price-rule.deleted` + + + + + Triggered when a price rule is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted price rule + id, + } + ``` + + + + + + + `price.deleted` + + + + + Triggered when a price is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted price + id, + } + ``` + + + + + + + `price-set-rule-type.deleted` + + + + + Triggered when a price set rule type is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted price set rule type + id, + } + ``` + + + + + + + `rule-type.deleted` + + + + + Triggered when a rule type is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted rule type + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/pricing/events/page.mdx b/www/apps/resources/app/commerce-modules/pricing/events/page.mdx new file mode 100644 index 0000000000..8a161a5e80 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/pricing/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Pricing Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Pricing Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/product/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/product/events/_events-table/page.mdx new file mode 100644 index 0000000000..4c13fc8b56 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/product/events/_events-table/page.mdx @@ -0,0 +1,299 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `product.created` + + + + + Triggered when a product is created. + + + + + ```ts noCopy noReport + { + // the ID of the product + id, + } + ``` + + + + + + + `product.updated` + + + + + Triggered when a product is updated. + + + + + ```ts noCopy noReport + { + // the ID of the product + id, + } + ``` + + + + + + + `product.deleted` + + + + + Triggered when a product is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted product + id, + } + ``` + + + + + + + `product-collection.created` + + + + + Triggered when a product collection is created. + + + + + ```ts noCopy noReport + { + // the ID of the product collection + id, + } + ``` + + + + + + + `product-collection.updated` + + + + + Triggered when a product collection is updated. + + + + + ```ts noCopy noReport + { + // the ID of the product collection + id, + } + ``` + + + + + + + `product-collection.deleted` + + + + + Triggered when a product collection is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted product collection + id, + } + ``` + + + + + + + `product-category.created` + + + + + Triggered when a product category is created. + + + + + ```ts noCopy noReport + { + // the ID of the product category + id, + } + ``` + + + + + + + `product-category.updated` + + + + + Triggered when a product category is updated. + + + + + ```ts noCopy noReport + { + // the ID of the product category + id, + } + ``` + + + + + + + `product-category.deleted` + + + + + Triggered when a product category is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted product category + id, + } + ``` + + + + + + + `product-option.deleted` + + + + + Triggered when a product option is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted product option + id, + } + ``` + + + + + + + `product-tag.deleted` + + + + + Triggered when a product tag is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted product tag + id, + } + ``` + + + + + + + `product-type.deleted` + + + + + Triggered when a product type is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted product type + id, + } + ``` + + + + + + + `product-variant.deleted` + + + + + Triggered when a product variant is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted product variant + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/product/events/page.mdx b/www/apps/resources/app/commerce-modules/product/events/page.mdx new file mode 100644 index 0000000000..e0d4e09186 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/product/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Product Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Product Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/promotion/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/promotion/events/_events-table/page.mdx new file mode 100644 index 0000000000..14a2030910 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/promotion/events/_events-table/page.mdx @@ -0,0 +1,145 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `promotion.deleted` + + + + + Triggered when a promotion is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted promotion + id, + } + ``` + + + + + + + `application-method.deleted` + + + + + Triggered when a application method is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted application method + id, + } + ``` + + + + + + + `campaign.deleted` + + + + + Triggered when a campaign is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted campaign + id, + } + ``` + + + + + + + `campaign-budget.deleted` + + + + + Triggered when a campaign budget is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted campaign budget + id, + } + ``` + + + + + + + `promotion-rule.deleted` + + + + + Triggered when a promotion rule is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted promotion rule + id, + } + ``` + + + + + + + `promotion-rule-value.deleted` + + + + + Triggered when a promotion rule value is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted promotion rule value + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/promotion/events/page.mdx b/www/apps/resources/app/commerce-modules/promotion/events/page.mdx new file mode 100644 index 0000000000..edb96a2ce2 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/promotion/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Promotion Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Promotion Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/region/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/region/events/_events-table/page.mdx new file mode 100644 index 0000000000..4fa1cf989d --- /dev/null +++ b/www/apps/resources/app/commerce-modules/region/events/_events-table/page.mdx @@ -0,0 +1,57 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `region.deleted` + + + + + Triggered when a region is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted region + id, + } + ``` + + + + + + + `country.deleted` + + + + + Triggered when a country is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted country + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/region/events/page.mdx b/www/apps/resources/app/commerce-modules/region/events/page.mdx new file mode 100644 index 0000000000..84b31aeecb --- /dev/null +++ b/www/apps/resources/app/commerce-modules/region/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Region Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Region Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/sales-channel/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/sales-channel/events/_events-table/page.mdx new file mode 100644 index 0000000000..b48781309e --- /dev/null +++ b/www/apps/resources/app/commerce-modules/sales-channel/events/_events-table/page.mdx @@ -0,0 +1,35 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `sales-channel.deleted` + + + + + Triggered when a sales channel is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted sales channel + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx b/www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx new file mode 100644 index 0000000000..ca9c133a22 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Sales Channel Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Sales Channel Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/stock-location/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/stock-location/events/_events-table/page.mdx new file mode 100644 index 0000000000..8e62bffac5 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/stock-location/events/_events-table/page.mdx @@ -0,0 +1,57 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `stock-location.deleted` + + + + + Triggered when a stock location is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted stock location + id, + } + ``` + + + + + + + `stock-location-address.deleted` + + + + + Triggered when a stock location address is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted stock location address + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/stock-location/events/page.mdx b/www/apps/resources/app/commerce-modules/stock-location/events/page.mdx new file mode 100644 index 0000000000..1cd83b1a5b --- /dev/null +++ b/www/apps/resources/app/commerce-modules/stock-location/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Stock Location Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Stock Location Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/store/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/store/events/_events-table/page.mdx new file mode 100644 index 0000000000..a85ea1ebac --- /dev/null +++ b/www/apps/resources/app/commerce-modules/store/events/_events-table/page.mdx @@ -0,0 +1,35 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `store.deleted` + + + + + Triggered when a store is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted store + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/store/events/page.mdx b/www/apps/resources/app/commerce-modules/store/events/page.mdx new file mode 100644 index 0000000000..8466518395 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/store/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Store Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Store Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/tax/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/tax/events/_events-table/page.mdx new file mode 100644 index 0000000000..4f56e9ef01 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/tax/events/_events-table/page.mdx @@ -0,0 +1,101 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `tax-rate.deleted` + + + + + Triggered when a tax rate is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted tax rate + id, + } + ``` + + + + + + + `tax-region.deleted` + + + + + Triggered when a tax region is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted tax region + id, + } + ``` + + + + + + + `tax-rate-rule.deleted` + + + + + Triggered when a tax rate rule is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted tax rate rule + id, + } + ``` + + + + + + + `tax-provider.deleted` + + + + + Triggered when a tax provider is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted tax provider + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/tax/events/page.mdx b/www/apps/resources/app/commerce-modules/tax/events/page.mdx new file mode 100644 index 0000000000..dc2866fadb --- /dev/null +++ b/www/apps/resources/app/commerce-modules/tax/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `Tax Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the Tax Module. + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/user/events/_events-table/page.mdx b/www/apps/resources/app/commerce-modules/user/events/_events-table/page.mdx new file mode 100644 index 0000000000..838d6a8d5c --- /dev/null +++ b/www/apps/resources/app/commerce-modules/user/events/_events-table/page.mdx @@ -0,0 +1,167 @@ +import { Table } from "docs-ui" + + + + + Event Name + Description + Data Payload + + + + + + + `user.created` + + + + + Triggered when a user is created. + + + + + ```ts noCopy noReport + { + // the ID of the user + id, + } + ``` + + + + + + + `user.updated` + + + + + Triggered when a user is updated. + + + + + ```ts noCopy noReport + { + // the ID of the user + id, + } + ``` + + + + + + + `user.deleted` + + + + + Triggered when a user is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted user + id, + } + ``` + + + + + + + `invite.created` + + + + + Triggered when an invite is created. + + + + + ```ts noCopy noReport + { + // the ID of the invite + id, + } + ``` + + + + + + + `invite.updated` + + + + + Triggered when an invite is updated. + + + + + ```ts noCopy noReport + { + // the ID of the invite + id, + } + ``` + + + + + + + `invite.deleted` + + + + + Triggered when an invite is deleted. + + + + + ```ts noCopy noReport + { + // the ID of the deleted invite + id, + } + ``` + + + + + + + `invite.token_generated` + + + + + Triggered when an invite's token is generated for the first time or refreshed. + + + + + ```ts noCopy noReport + { + // the ID of the invite + id, + } + ``` + + + + +
\ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/user/events/page.mdx b/www/apps/resources/app/commerce-modules/user/events/page.mdx new file mode 100644 index 0000000000..a8ce44deb7 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/user/events/page.mdx @@ -0,0 +1,11 @@ +import EventsTable from "./_events-table/page.mdx" + +export const metadata = { + title: `User Module Events Reference`, +} + +# {metadata.title} + +Find in this reference the list of events emitted by the User Module. + + \ 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 6dcfcffcd2..c4ef34ccde 100644 --- a/www/apps/resources/app/events-reference/page.mdx +++ b/www/apps/resources/app/events-reference/page.mdx @@ -1,4 +1,22 @@ import { Table } from "docs-ui" +import ApiKeyEvents from "../commerce-modules/api-key/events/_events-table/page.mdx" +import AuthEvents from "../commerce-modules/auth/events/_events-table/page.mdx" +import CartEvents from "../commerce-modules/cart/events/_events-table/page.mdx" +import CurrencyEvents from "../commerce-modules/currency/events/_events-table/page.mdx" +import CustomerEvents from "../commerce-modules/customer/events/_events-table/page.mdx" +import FulfillmentEvents from "../commerce-modules/fulfillment/events/_events-table/page.mdx" +import InventoryEvents from "../commerce-modules/inventory/events/_events-table/page.mdx" +import OrderEvents from "../commerce-modules/order/events/_events-table/page.mdx" +import PaymentEvents from "../commerce-modules/payment/events/_events-table/page.mdx" +import PricingEvents from "../commerce-modules/pricing/events/_events-table/page.mdx" +import ProductEvents from "../commerce-modules/product/events/_events-table/page.mdx" +import PromotionEvents from "../commerce-modules/promotion/events/_events-table/page.mdx" +import RegionEvents from "../commerce-modules/region/events/_events-table/page.mdx" +import SalesChannelEvents from "../commerce-modules/sales-channel/events/_events-table/page.mdx" +import StockLocationEvents from "../commerce-modules/stock-location/events/_events-table/page.mdx" +import StoreEvents from "../commerce-modules/store/events/_events-table/page.mdx" +import TaxEvents from "../commerce-modules/tax/events/_events-table/page.mdx" +import UserEvents from "../commerce-modules/user/events/_events-table/page.mdx" export const metadata = { title: `Events Reference`, @@ -6,3306 +24,76 @@ export const metadata = { # {metadata.title} - +This documentation page includes the list of all events triggered by Medusa's commerce modules. -These events aren't fully supported in Medusa v2 yet. +## API Key Module Events - + -This documentation page includes the list of events emitted by the Medusa application and their expected data payload. +## Auth Module Events -## Batch Jobs Events + -This section holds all events related to batch jobs. +## Cart Module Events - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - + -`batch.created` +## Currency Module Events - - -Triggered when a batch job is created. - - -Object of the following format: + -```js noReport noCopy -{ - id // string ID of batch job -} -``` +## Customer Module Events - - + - - +## Fulfillment Module Events -`batch.updated` + - - -Triggered when a batch job is updated. - - -Object of the following format: +## Inventory Module Events -```js noReport noCopy -{ - id // string ID of batch job -} -``` + - - +## Order Module Events - - + -`batch.canceled` +## Payment Module Events - - -Triggered when a batch job is canceled. - - -Object of the following format: + -```js noReport noCopy -{ - id // string ID of batch job -} -``` +## Pricing Module Events - - + - - +## Product Module Events -`batch.pre_processed` + - - +## Promotion Module Events -Triggered after the `preProcessBatchJob` of a batch job strategy is done executing. + - - -Object of the following format: +## Region Module Events -```js noReport noCopy -{ - id // string ID of batch job -} -``` + - - +## Sales Channel Module Events - - + -`batch.confirmed` +## Stock Location Module Events - - + -Triggered after the batch job is done pre-processing and the batch job is not in dry-run mode. +## Store Module Events - - -Object of the following format: + -```js noReport noCopy -{ - id // string ID of batch job -} -``` +## Tax Module Events - - + - - +## User Module Events -`batch.processing` - - - -Triggered when a batch job starts processing after it's confirmed. - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of batch job -} -``` - - - - - - - -`batch.completed` - - - -Triggered when a batch job is done processing and is completed. - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of batch job -} -``` - - - - - - - -`batch.failed` - - - -Triggered when an error occurs while running a batch job and the batch job fails. - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of batch job -} -``` - - - - - -
- -## Cart Events - -This section holds all events related to a cart. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - - -`cart.customer_updated` - - - -Triggered when a cart is associated with a different email than it was already associated with, or if a customer logs in after adding items to their cart as a guest. - - -The cart ID passed as a string parameter. - - - - - - -`cart.created` - - - -Triggered when a cart is created. - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of cart -} -``` - - - - - - - -`cart.updated` - - - - -Triggered when a cart and data associated with it (payment sessions, shipping methods, user details, etc…) are updated. - - - - -An object with at least the ID of the cart, however, in most cases the entire cart model is available. You can refer to the [Cart entity](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/cart.ts) for an idea of what fields to expect. - - - - - -
- -## Claim Events - -This section holds all events related to claims. - - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`claim.created` - - - - -Triggered when a claim is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of claim - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`claim.updated` - - - - -Triggered when a claim is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of claim - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`claim.canceled` - - - - -Triggered when a claim is canceled. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of claim - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`claim.fulfillment_created` - - - - -Triggered when fulfillment is created for a claim. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of claim - fulfillment_id, // string ID of the fulfillment created - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`claim.shipment_created` - - - - -Triggered when a claim fulfillment is set as “shipped”. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of claim - fulfillment_id, // string ID of the fulfillment created - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`claim.refund_processed` - - - - -Triggered when a claim of type “refunded” has been refunded. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of claim - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - -
- -## Claim Item Events - -This section holds all events related to claim items. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`claim_item.created` - - - - -Triggered when claim items are created and associated with a claim. This happens during the creation of claims. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of claim item -} -``` - - - - - - - -`claim_item.updated` - - - - -Triggered when a claim item is updated. This happens when a claim is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of claim item -} -``` - - - - - - - -`claim_item.canceled` - - - - -Triggered when a claim is canceled. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of claim item -} -``` - - - - - -
- -## Currency Events - -This section holds all events related to currencies. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`currency.updated` - - - - -Triggered when a currency is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - code // string 3 character ISO code of the updated currency. -} -``` - - - - - -
- -## Customer Events - -This section holds all events related to customers. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`customer.created` - - - - -Triggered when a customer is created. - - - - -The entire customer passed as an object. You can refer to the [Customer entity](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/customer.ts) for an idea of what fields to expect. - - - - - - - -`customer.updated` - - - - -Triggered when a customer is updated including their information or password, or when a customer account is created that is associated with an existing email (for example, if a customer placed an order with their email as a guest, then created an account with that email). - - - - -The entire customer passed as an object. You can refer to the [Customer entity](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/customer.ts) for an idea of what fields to expect. - - - - - - - -`customer.password_reset` - - - - -Triggered when a customer requests to reset their password. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of customer - email, // string email of the customer - first_name, // string first name of the customer - last_name, // string last name of the customer - token // string reset password token -} -``` - - - - - -
- -## Discount Events - -This section holds all events related to discounts. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`discount.created` - - - - -Triggered when a discount is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of discount -} -``` - - - - -
- -## Draft Order Events - -This section holds all events related to draft orders. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`draft_order.created` - - - - -Triggered when a draft order is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of draft order -} -``` - - - - - - - -`draft_order.updated` - - - - -Triggered when a draft order and data associated with it (email, billing address, discount, etc…) are updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of draft order -} -``` - - - - - -
- -## Gift Card Events - -This section holds all events related to gift cards. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`gift_card.created` - - - - - -Triggered when a gift card is created. - - - - - -Object of the following format: - -``` -{ - id //string ID of gift card -} -``` - - - - -
- -## Inventory Item Events - -This section holds all events related to inventory items. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`inventory-item.created` - - - - -Triggered when an inventory item is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the inventory item -} -``` - - - - - - -`inventory-item.updated` - - - - -Triggered when an inventory item is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the inventory item -} -``` - - - - - - -`inventory-item.deleted` - - - - -Triggered when an inventory item is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the inventory item -} -``` - - - - -
- -## Inventory Level Events - -This section holds all events related to inventory levels. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`inventory-level.created` - - - - -Triggered when an inventory level is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the inventory level -} -``` - - - - - - -`inventory-level.updated` - - - - -Triggered when an inventory level is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the inventory level -} -``` - - - - - - -`inventory-level.deleted` - - - - -Triggered when an inventory level is deleted, which can be done either directly using its ID or based on the ID of a location. The returned ID depends on how the inventory level was deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // (optional) string ID of the inventory level, available if it was deleted directly - location_id // (optional) string ID of location, available if level was deleted by location ID -} -``` - - - - -
- -## Invite Events - -This section holds all events related to invites. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`invite.created` - - - - -Triggered when an invite is created for a user to join the admin team. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of invite - token, // string token generated to validate the invited user - user_email // string email of invited user -} -``` - - - - -
- -## Note Events - -This section holds all events related to notes. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`note.created` - - - - -Triggered when a note is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of note -} -``` - - - - - - - -`note.updated` - - - - -Triggered when a note is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of note -} -``` - - - - - - - -`note.deleted` - - - - -Triggered when a note is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of note -} -``` - - - - - -
- -## App Authentication Events - -This section holds all events related to app authentications. - - - -Event names of app authentication are scoped specifically towards each application. When listening to these events, you must replace `` with the name of the application you’re targeting. - - - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`oauth.token_generated.` - - - - -Triggered when a token is generated for an application. - - - - -The returned data from the method `generateToken` in the auth handler service of the application. - - - - - - - -`oauth.token_refreshed.` - - - - -Triggered when the token of an application is refreshed. - - - - -The returned data from the method `refreshToken` in the auth handler service of the application. - - - - - - -
- -## Order Events - -This section holds all events related to orders. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`order.placed` - - - - -Triggered when a new order is placed. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.updated` - - - - -Triggered when an order and data associated with it (shipping method, shipping address, etc…) are updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - no_notification // (optional) boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.canceled` - - - - -Triggered when an order is canceled. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.completed` - - - - -Triggered when an order is completed. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.orders_claimed` - - - - -Triggered when an order is claimed. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order -} -``` - - - - - - - -`order.gift_card_created` - - - - -Triggered when a gift card in an order is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of order -} -``` - - - - - - - -`order.payment_captured` - - - - -Triggered when the payment of an order is captured. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.payment_capture_failed` - - - - -Triggered when capturing the payment of an order fails. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - payment_id, // string ID of Payment - error, // string error message - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.fulfillment_created` - - - - -Triggered when fulfillment is created for an order. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - fulfillment_id, // string ID of fulfillment - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.shipment_created` - - - - -Triggered when a shipment is created for fulfillment and the fulfillment is registered as “shipped”. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - fulfillment_id, // string ID of fulfillment - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.fulfillment_canceled` - - - - -Triggered when fulfillment of an order is canceled. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - fulfillment_id, // string ID of fulfillment - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.return_requested` - - - - -Triggered when a return of an order is requested. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - return_id, // string ID of return - no_notification // (optional) boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.items_returned` - - - - -Triggered when the items of an order have been returned and the order has been registered as “returned”. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - return_id, // string ID of return - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.return_action_required` - - - - -Triggered when the order is being registered as “returned” but there are additional actions required related to refunding the payment. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - return_id, // string ID of return - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.refund_created` - - - - -Triggered when the order’s payment is refunded. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of order - refund_id, // string ID of refund - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`order.refund_failed` - - - - -Triggered when the refund of the order’s payment fails. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order -} -``` - - - - - - - -`order.swap_created` - - - - -Triggered when a swap for an order is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order -} -``` - - - - - -
- -## Order Edit Events - -This section holds all events related to order edits. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`order-edit.created` - - - - -Triggered when a order edit is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order edit -} -``` - - - - - - - -`order-edit.updated` - - - - -Triggered when an order edit is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order edit -} -``` - - - - - - - -`order-edit.canceled` - - - - -Triggered when an order edit is canceled. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order edit -} -``` - - - - - - - -`order-edit.declined` - - - - -Triggered when an order edit is declined. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order edit -} -``` - - - - - - - -`order-edit.requested` - - - - -Triggered when an order edit is requested. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of order edit -} -``` - - - - - - - -`order-edit.confirmed` - - - - -Triggered when an order edit is confirmed. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of order edit -} -``` - - - - - -
- -## Order Edit Item Changes Events - -This section holds all events related to order edit item changes. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`order-edit-item-change.CREATED` - - - - -Triggered when an order edit item change is created. - - - - -```js noReport noCopy -{ - id // string ID of item change -} -``` - - - - - - - -`order-edit-item-change.DELETED` - - - - -Triggered when an order edit item change is deleted. - - - - -```js noReport noCopy -{ - id // string ID of item change -} -``` - - - - - -
- -## Payment Events - -This section holds all events related to payment. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - - -`payment.created` - - - - -Triggered when a payment is created. - - - - -The entire payment passed as an object. You can refer to the [Payment entity](/references/entities/classes/Payment) for an idea of what fields to expect. - - - - - - - -`payment.updated` - - - - -Triggered when a payment is updated. - - - - -The entire payment passed as an object. You can refer to the [Payment entity](/references/entities/classes/Payment) for an idea of what fields to expect. - - - - - - - -`payment.payment_captured` - - - - -Triggered when a payment is captured. - - - - -The entire payment passed as an object. You can refer to the [Payment entity](/references/entities/classes/Payment) for an idea of what fields to expect. - - - - - - - -`payment.payment_capture_failed` - - - - -Triggered when the capturing of a payment fails. - - - - -The entire payment passed as an object. You can refer to the [Payment entity](/references/entities/classes/Payment) for an idea of what fields to expect. - -In addition, an error object is passed within the same object as the Payment Processor: - -```js noReport noCopy -{ - id, //string ID of payment - //... other payment fields - error: { - name, //string - message, //string - stack, //(optional) string - } -} -``` - - - - - - - -`payment.payment_refund_created` - - - - -Triggered when a refund of a payment is created. - - - - -The entire refund passed as an object. You can refer to the [Refund entity](/references/entities/classes/Refund) for an idea of what fields to expect. - - - - - - - -`payment.payment_refund_failed` - - - - -Triggered when a payment's refund fails. - - - - -The entire payment passed as an object. You can refer to the [Payment entity](/references/entities/classes/Payment) for an idea of what fields to expect. - - - - - -
- -## Payment Collection Events - -This section holds all events related to payment collections. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - - -`payment-collection.created` - - - - -Triggered when a payment collection is created. - - - - -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](/references/entities/classes/PaymentCollection) for an idea of what fields to expect. - - - - - - - -`payment-collection.updated` - - - - -Triggered when a payment collection is update. - - - - -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](/references/entities/classes/PaymentCollection) for an idea of what fields to expect. - - - - - - - -`payment-collection.deleted` - - - - -Triggered when a payment collection is deleted. - - - - -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](/references/entities/classes/PaymentCollection) for an idea of what fields to expect. - - - - - - - -`payment-collection.payment_authorized` - - - - -Triggered when a payment collection is either marked authorized or its payment session is authorized. - - - - -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](/references/entities/classes/PaymentCollection) for an idea of what fields to expect. - - - - - -
- -## Product Events - -This section holds all events related to products. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - - -`product.created` - - - - -Triggered when a product is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of product -} -``` - - - - - - - -`product.updated` - - - - -Triggered when a product and data associated with it (options, variant orders, etc…) is updated. - - - - -The entire product passed as an object. You can refer to the [Product entity](/references/entities/classes/Product) for an idea of what fields to expect. - -In one case, when the `/admin/products/{id}` API Route is used to update the product, the payload is an object of the following format: - -```js noReport noCopy -{ - id, // id of product - fields // an array of field names that were updated -} -``` - - - - - - - -`product.deleted` - - - - -Triggered when a product is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of product -} -``` - - - - - -
- -## Product Category Events - -This section holds all events related to product categories. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`product-category.created` - - - - -Triggered when a product category is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of category -} -``` - - - - - - - -`product-category.updated` - - - - -Triggered when a product category is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of category -} -``` - - - - - - - -`product-category.deleted` - - - - -Triggered when a product category is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of category -} -``` - - - - - -
- -## Product Variant Events - -This section holds all events related to product variants. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`product-variant.created` - - - - -Triggered when a product variant is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of variant - product_id // string ID of product -} -``` - - - - - - - -`product-variant.updated` - - - - -Triggered when a product variant is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of variant - product_id, // string ID of product - fields // array of names of updated fields -} -``` - - - - - - - -`product-variant.deleted` - - - - -Triggered when a product variant is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of variant - product_id, // string ID of product - metadata // object of the `metadata` field of the variant -} -``` - - - - - -
- -## Publishable API Key Events - -This section holds all events related to publishable API keys. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - - -`publishable_api_key.created` - - - - -Triggered when a publishable API key is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of publishable API key -} -``` - - - - - - - -`publishable_api_key.revoked` - - - - -Triggered when a publishable API key is revoked. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of publishable API key -} -``` - - - - - -
- -## Region Events - -This section holds all events related to regions. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`region.created` - - - - -Triggered when a region is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of region -} -``` - - - - - - - -`region.updated` - - - - -Triggered when a region or data associated with it (countries, fulfillment providers, etc…) are updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of region - fields // array of names of updated fields -} -``` - - - - - - - -`region.deleted` - - - - -Triggered when a region is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of region -} -``` - - - - -
- -## Reservation Item Events - -This section holds all events related to reservation items. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`reservation-item.created` - - - - -Triggered when a reservation item is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the reservation item -} -``` - - - - - - -`reservation-item.updated` - - - - -Triggered when an reservation item is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the reservation item -} -``` - - - - - - -`reservation-item.deleted` - - - - -Triggered when a reservation item is deleted, which can be done either directly using its ID or based on the ID of a location or a line item. The returned ID depends on how the reservation item was deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // (optional) string ID of the reservation item, available if it was deleted directly - location_id // (optional) string ID of location, available if item was deleted by location ID - line_item_id // (optional) string ID of line item, available if reservation item was deleted by line item ID -} -``` - - - - -
- -## Sales Channel Events - -This section holds all events related to sales channels. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`sales_channel.created` - - - - -Triggered when a sales channel is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of sales channel -} -``` - - - - - - - -`sales_channel.updated` - - - - -Triggered when a sales channel is updated - - - - -Object of the following format: - -```js noReport noCopy -{ - id, //string ID of sales channel -} -``` - - - - - - - -`sales_channel.deleted` - - - - -Triggered when a sales channel is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of sales channel -} -``` - - - - -
- -## Stock Location Events - -This section holds all events related to stock locations. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`stock-location.created` - - - - -Triggered when a stock location is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the stock location -} -``` - - - - - - -`stock-location.updated` - - - - -Triggered when an stock location is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the stock location -} -``` - - - - - - -`stock-location.deleted` - - - - -Triggered when a stock location is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of the stock location -} -``` - - - - -
- -## Swap Events - -This section holds all events related to swaps. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`swap.created` - - - - -Triggered when a swap is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.received` - - - - -Triggered when a swap is registered as received. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - order_id, // string ID of order - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.fulfillment_created` - - - - -Triggered when fulfillment is created for a swap. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - fulfillment_id, // string ID of fulfillment - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.shipment_created` - - - - -Triggered when a shipment is created for a swap and the fulfillment associated with it is set as “shipped”. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - fulfillment_id, // string ID of fulfillment - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.payment_completed` - - - - -Triggered when payment is completed for a swap which happens when the cart associated with the swap is registered as completed. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.payment_captured` - - - - -Triggered when the payment is captured for a swap. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.payment_capture_failed` - - - - -Triggered when the capturing of the payment of a swap fails. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.refund_processed` - - - - -Triggered when a swap’s amount difference is processed and refunded. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - - - -`swap.process_refund_failed` - - - - -Triggered when processing and refunding a swap’s amount difference fails. - - - - -Object of the following format: - -```js noReport noCopy -{ - id, // string ID of swap - no_notification // boolean indicating whether a notification should be sent -} -``` - - - - - -
- -## Token Events - -This section holds all events related to tokens. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`order-update-token.created` - - - - -Triggered when a customer requests to claim an order and a token is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - old_email, //string email of order - new_customer_id, //string ID of customer - orders, //array of string IDs of orders - token, //string token used for verification -} -``` - - - - - -
- -## User Events - -This section holds all events related to users. - - - - - -Event Name - - -Description - - -Event Data Payload - - - - - - - -`user.created` - - - - -Triggered when a user is created. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of user -} -``` - - - - - - - -`user.updated` - - - - -Triggered when a user is updated. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of user -} -``` - - - - - - - -`user.password_reset` - - - - -Triggered when a user requests to reset their password. - - - - -Object of the following format: - -```js noReport noCopy -{ - email, // string email of user requesting to reset their password - token // token create to reset the password -} -``` - - - - - - - -`user.deleted` - - - - -Triggered when a user is deleted. - - - - -Object of the following format: - -```js noReport noCopy -{ - id // string ID of user -} -``` - - - - -
\ 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 2abc873e5e..aa3476be1e 100644 --- a/www/apps/resources/generated/files-map.mjs +++ b/www/apps/resources/generated/files-map.mjs @@ -203,6 +203,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx", "pathname": "/architectural-modules/workflow-engine/redis" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/api-key/events/_events-table/page.mdx", + "pathname": "/commerce-modules/api-key/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/api-key/events/page.mdx", + "pathname": "/commerce-modules/api-key/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/api-key/examples/page.mdx", "pathname": "/commerce-modules/api-key/examples" @@ -227,6 +235,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/auth/auth-providers/page.mdx", "pathname": "/commerce-modules/auth/auth-providers" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/auth/events/_events-table/page.mdx", + "pathname": "/commerce-modules/auth/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/auth/events/page.mdx", + "pathname": "/commerce-modules/auth/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/auth/examples/page.mdx", "pathname": "/commerce-modules/auth/examples" @@ -251,6 +267,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/cart/concepts/page.mdx", "pathname": "/commerce-modules/cart/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/cart/events/_events-table/page.mdx", + "pathname": "/commerce-modules/cart/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/cart/events/page.mdx", + "pathname": "/commerce-modules/cart/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/cart/examples/page.mdx", "pathname": "/commerce-modules/cart/examples" @@ -271,6 +295,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/cart/tax-lines/page.mdx", "pathname": "/commerce-modules/cart/tax-lines" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/currency/events/_events-table/page.mdx", + "pathname": "/commerce-modules/currency/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/currency/events/page.mdx", + "pathname": "/commerce-modules/currency/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/currency/examples/page.mdx", "pathname": "/commerce-modules/currency/examples" @@ -283,6 +315,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/customer/customer-accounts/page.mdx", "pathname": "/commerce-modules/customer/customer-accounts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/customer/events/_events-table/page.mdx", + "pathname": "/commerce-modules/customer/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/customer/events/page.mdx", + "pathname": "/commerce-modules/customer/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/customer/examples/page.mdx", "pathname": "/commerce-modules/customer/examples" @@ -299,6 +339,14 @@ 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/_events-table/page.mdx", + "pathname": "/commerce-modules/fulfillment/events/_events-table" + }, + { + "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" @@ -327,6 +375,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/inventory/concepts/page.mdx", "pathname": "/commerce-modules/inventory/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/inventory/events/_events-table/page.mdx", + "pathname": "/commerce-modules/inventory/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/inventory/events/page.mdx", + "pathname": "/commerce-modules/inventory/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/inventory/examples/page.mdx", "pathname": "/commerce-modules/inventory/examples" @@ -347,6 +403,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/order/concepts/page.mdx", "pathname": "/commerce-modules/order/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/order/events/_events-table/page.mdx", + "pathname": "/commerce-modules/order/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/order/events/page.mdx", + "pathname": "/commerce-modules/order/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/order/order-change/page.mdx", "pathname": "/commerce-modules/order/order-change" @@ -383,6 +447,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/page.mdx", "pathname": "/commerce-modules" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/payment/events/_events-table/page.mdx", + "pathname": "/commerce-modules/payment/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/payment/events/page.mdx", + "pathname": "/commerce-modules/payment/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/payment/examples/page.mdx", "pathname": "/commerce-modules/payment/examples" @@ -431,6 +503,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/pricing/concepts/page.mdx", "pathname": "/commerce-modules/pricing/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/pricing/events/_events-table/page.mdx", + "pathname": "/commerce-modules/pricing/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/pricing/events/page.mdx", + "pathname": "/commerce-modules/pricing/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/pricing/examples/page.mdx", "pathname": "/commerce-modules/pricing/examples" @@ -447,6 +527,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/pricing/relations-to-other-modules/page.mdx", "pathname": "/commerce-modules/pricing/relations-to-other-modules" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/product/events/_events-table/page.mdx", + "pathname": "/commerce-modules/product/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/product/events/page.mdx", + "pathname": "/commerce-modules/product/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/product/examples/page.mdx", "pathname": "/commerce-modules/product/examples" @@ -467,6 +555,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/promotion/concepts/page.mdx", "pathname": "/commerce-modules/promotion/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/promotion/events/_events-table/page.mdx", + "pathname": "/commerce-modules/promotion/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/promotion/events/page.mdx", + "pathname": "/commerce-modules/promotion/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/promotion/examples/page.mdx", "pathname": "/commerce-modules/promotion/examples" @@ -479,6 +575,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/promotion/relations-to-other-modules/page.mdx", "pathname": "/commerce-modules/promotion/relations-to-other-modules" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/region/events/_events-table/page.mdx", + "pathname": "/commerce-modules/region/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/region/events/page.mdx", + "pathname": "/commerce-modules/region/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/region/examples/page.mdx", "pathname": "/commerce-modules/region/examples" @@ -491,6 +595,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/region/relations-to-other-modules/page.mdx", "pathname": "/commerce-modules/region/relations-to-other-modules" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/events/_events-table/page.mdx", + "pathname": "/commerce-modules/sales-channel/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx", + "pathname": "/commerce-modules/sales-channel/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/examples/page.mdx", "pathname": "/commerce-modules/sales-channel/examples" @@ -511,6 +623,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/stock-location/concepts/page.mdx", "pathname": "/commerce-modules/stock-location/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/stock-location/events/_events-table/page.mdx", + "pathname": "/commerce-modules/stock-location/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/stock-location/events/page.mdx", + "pathname": "/commerce-modules/stock-location/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/stock-location/examples/page.mdx", "pathname": "/commerce-modules/stock-location/examples" @@ -523,6 +643,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/stock-location/relations-to-other-modules/page.mdx", "pathname": "/commerce-modules/stock-location/relations-to-other-modules" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/store/events/_events-table/page.mdx", + "pathname": "/commerce-modules/store/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/store/events/page.mdx", + "pathname": "/commerce-modules/store/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/store/examples/page.mdx", "pathname": "/commerce-modules/store/examples" @@ -531,6 +659,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/store/page.mdx", "pathname": "/commerce-modules/store" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/tax/events/_events-table/page.mdx", + "pathname": "/commerce-modules/tax/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/tax/events/page.mdx", + "pathname": "/commerce-modules/tax/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/tax/examples/page.mdx", "pathname": "/commerce-modules/tax/examples" @@ -555,6 +691,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/tax/tax-region/page.mdx", "pathname": "/commerce-modules/tax/tax-region" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/user/events/_events-table/page.mdx", + "pathname": "/commerce-modules/user/events/_events-table" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/user/events/page.mdx", + "pathname": "/commerce-modules/user/events" + }, { "filePath": "/www/apps/resources/app/commerce-modules/user/examples/page.mdx", "pathname": "/commerce-modules/user/examples" diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs index 49d70e86f4..dd3fdcfbae 100644 --- a/www/apps/resources/generated/sidebar.mjs +++ b/www/apps/resources/generated/sidebar.mjs @@ -162,6 +162,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/api-key/events", + "title": "Events Reference", + "children": [] } ] } @@ -328,6 +335,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/auth/events", + "title": "Events Reference", + "children": [] } ] } @@ -830,6 +844,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/cart/events", + "title": "Events Reference", + "children": [] } ] } @@ -919,6 +940,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/currency/events", + "title": "Events Reference", + "children": [] } ] } @@ -1197,6 +1225,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/customer/events", + "title": "Events Reference", + "children": [] } ] } @@ -1825,6 +1860,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/fulfillment/events", + "title": "Events Reference", + "children": [] } ] } @@ -2173,6 +2215,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/inventory/events", + "title": "Events Reference", + "children": [] } ] } @@ -2780,6 +2829,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/order/events", + "title": "Events Reference", + "children": [] } ] } @@ -3121,6 +3177,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/payment/events", + "title": "Events Reference", + "children": [] } ] } @@ -3588,6 +3651,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/pricing/events", + "title": "Events Reference", + "children": [] } ] } @@ -4118,6 +4188,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/product/events", + "title": "Events Reference", + "children": [] } ] } @@ -4431,6 +4508,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/promotion/events", + "title": "Events Reference", + "children": [] } ] } @@ -4604,6 +4688,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/region/events", + "title": "Events Reference", + "children": [] } ] } @@ -4756,6 +4847,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/sales-channel/events", + "title": "Events Reference", + "children": [] } ] } @@ -4915,6 +5013,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/stock-location/events", + "title": "Events Reference", + "children": [] } ] } @@ -5046,6 +5151,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/store/events", + "title": "Events Reference", + "children": [] } ] } @@ -5317,6 +5429,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/tax/events", + "title": "Events Reference", + "children": [] } ] } @@ -5539,6 +5658,13 @@ export const generatedSidebar = [ ] } ] + }, + { + "loaded": true, + "isPathHref": true, + "path": "/commerce-modules/user/events", + "title": "Events Reference", + "children": [] } ] } diff --git a/www/apps/resources/sidebar.mjs b/www/apps/resources/sidebar.mjs index b7c0bd7046..983d378c5e 100644 --- a/www/apps/resources/sidebar.mjs +++ b/www/apps/resources/sidebar.mjs @@ -65,6 +65,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/api-key/events", + title: "Events Reference", + }, ], }, ], @@ -133,6 +137,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/auth/events", + title: "Events Reference", + }, ], }, ], @@ -197,6 +205,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/cart/events", + title: "Events Reference", + }, ], }, ], @@ -240,6 +252,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/currency/events", + title: "Events Reference", + }, ], }, ], @@ -296,6 +312,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/customer/events", + title: "Events Reference", + }, ], }, ], @@ -364,6 +384,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/fulfillment/events", + title: "Events Reference", + }, ], }, ], @@ -425,6 +449,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/inventory/events", + title: "Events Reference", + }, ], }, ], @@ -501,6 +529,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/order/events", + title: "Events Reference", + }, ], }, ], @@ -585,6 +617,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/payment/events", + title: "Events Reference", + }, ], }, ], @@ -645,6 +681,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/pricing/events", + title: "Events Reference", + }, ], }, ], @@ -697,6 +737,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/product/events", + title: "Events Reference", + }, ], }, ], @@ -757,6 +801,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/promotion/events", + title: "Events Reference", + }, ], }, ], @@ -809,6 +857,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/region/events", + title: "Events Reference", + }, ], }, ], @@ -866,6 +918,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/sales-channel/events", + title: "Events Reference", + }, ], }, ], @@ -924,6 +980,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/stock-location/events", + title: "Events Reference", + }, ], }, ], @@ -967,6 +1027,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/store/events", + title: "Events Reference", + }, ], }, ], @@ -1035,6 +1099,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/tax/events", + title: "Events Reference", + }, ], }, ], @@ -1091,6 +1159,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, + { + path: "/commerce-modules/user/events", + title: "Events Reference", + }, ], }, ], diff --git a/www/packages/docs-ui/src/components/Table/index.tsx b/www/packages/docs-ui/src/components/Table/index.tsx index 00bcfbe3b6..284ed925bd 100644 --- a/www/packages/docs-ui/src/components/Table/index.tsx +++ b/www/packages/docs-ui/src/components/Table/index.tsx @@ -10,7 +10,8 @@ const Root = ({ className, ...props }: RootProps) => { className={clsx( className, "table-fixed mb-docs_1", - "[&_pre_span]:!max-w-full [&_pre_span]:!break-words [&_pre_span]:!whitespace-break-spaces" + "[&_pre_span]:!max-w-full [&_pre_span]:!break-words [&_pre_span]:!whitespace-break-spaces", + "[&_pre>div]:mt-docs_1" )} {...props} /> diff --git a/www/packages/eslint-config-docs/content.js b/www/packages/eslint-config-docs/content.js index 2cde3e3498..97896d7838 100644 --- a/www/packages/eslint-config-docs/content.js +++ b/www/packages/eslint-config-docs/content.js @@ -18,7 +18,8 @@ module.exports = { plugins: ["prettier", "markdown"], ignorePatterns: [ "**/references/**", - "**/events-reference/**" + "**/events-reference/**", + "**/_events-table/**" ], rules: { "no-undef": "off",