asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update events reference (#7321)

Browse Source 
* change subscribers events

* add event references for modules
This commit is contained in:
Shahed Nasser
2024-05-16 09:01:12 +02:00
committed by GitHub
parent 1160a34f3d
commit 9b1998b9b2
44 changed files with 2995 additions and 3280 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/commerce-modules/api-key/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`api-key.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an API key is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted API key
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/api-key/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/auth/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`auth.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an auth user is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted auth user
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/auth/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/cart/events/_events-table/page.mdx
+189
View File
@@ -0,0 +1,189 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`cart.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a cart is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted cart
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted address
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item tax line
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method tax line
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/cart/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/currency/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`currency.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a currency is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted currency
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/currency/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/customer/events/_events-table/page.mdx
+101
View File
@@ -0,0 +1,101 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`customer.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a customer is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted customer
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted address
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer-group.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a customer group is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted customer group
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer-group-customer.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a customer group customer (the data model of the relation between customer groups and customers) is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted customer group customer
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/customer/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/fulfillment/events/_events-table/page.mdx
+255
View File
@@ -0,0 +1,255 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`fulfillment-set.created`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment set is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the fulfillment set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`fulfillment-set.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment set is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted fulfillment set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`service-zone.created`
</Table.Cell>
<Table.Cell>
Triggered when a service zone is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the service zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`service-zone.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a service zone is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted service zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`geo-zone.created`
</Table.Cell>
<Table.Cell>
Triggered when a geo zone is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the geo zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`geo-zone.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a geo zone is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted geo zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping option
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-profile.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping profile is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping profile
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option-rule.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option rule is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping option rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option-type.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option type is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping option type
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`fulfillment-provider.created`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment provider is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the fulfillment provider
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/inventory/events/_events-table/page.mdx
+211
View File
@@ -0,0 +1,211 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`inventory-item.created`
</Table.Cell>
<Table.Cell>
Triggered when a inventory item is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-item.updated`
</Table.Cell>
<Table.Cell>
Triggered when a inventory item is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a inventory item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted inventory item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`inventory-level.created`
</Table.Cell>
<Table.Cell>
Triggered when a inventory level is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory level
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-level.updated`
</Table.Cell>
<Table.Cell>
Triggered when a inventory level is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory level
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-level.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a inventory level is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted inventory level
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`reservation-item.created`
</Table.Cell>
<Table.Cell>
Triggered when a reservation item is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the reservation item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation-item.updated`
</Table.Cell>
<Table.Cell>
Triggered when a reservation item is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the reservation item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a reservation item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted reservation item
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/inventory/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/order/events/_events-table/page.mdx
+321
View File
@@ -0,0 +1,321 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`order.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted address
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item tax line
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method tax line
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`transaction.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a transaction is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted transaction
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-change.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order change is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order change
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-change-action.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order change action is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order change action
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-summary.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order summary is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order summary
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-shipping-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order shipping method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order shipping method
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/order/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/payment/events/_events-table/page.mdx
+123
View File
@@ -0,0 +1,123 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`payment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a payment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted payment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`payment-collection.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a payment collection is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted payment collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`payment-session.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a payment session is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted payment session
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`capture.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a capture is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted capture
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`refund.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a refund is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted refund
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/payment/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/pricing/events/_events-table/page.mdx
+189
View File
@@ -0,0 +1,189 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`price-set.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price set is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-list.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price list is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price list
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-list-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price list rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price list rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-list-rule-value.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price list rule value is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price list rule value
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-set-rule-type.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price set rule type is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price set rule type
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`rule-type.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a rule type is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted rule type
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/pricing/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/product/events/_events-table/page.mdx
+299
View File
@@ -0,0 +1,299 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product.created`
</Table.Cell>
<Table.Cell>
Triggered when a product is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.updated`
</Table.Cell>
<Table.Cell>
Triggered when a product is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-collection.created`
</Table.Cell>
<Table.Cell>
Triggered when a product collection is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-collection.updated`
</Table.Cell>
<Table.Cell>
Triggered when a product collection is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-collection.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product collection is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-category.created`
</Table.Cell>
<Table.Cell>
Triggered when a product category is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product category
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-category.updated`
</Table.Cell>
<Table.Cell>
Triggered when a product category is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product category
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-category.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product category is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product category
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-option.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product option is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product option
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-tag.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product tag is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product tag
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-type.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product type is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product type
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-variant.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product variant is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product variant
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/product/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/promotion/events/_events-table/page.mdx
+145
View File
@@ -0,0 +1,145 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`promotion.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`application-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a application method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted application method
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a campaign is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted campaign
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign-budget.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a campaign budget is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted campaign budget
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion-rule-value.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion rule value is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion rule value
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/promotion/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/region/events/_events-table/page.mdx
+57
View File
@@ -0,0 +1,57 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`region.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a region is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted region
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`country.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a country is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted country
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/region/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/sales-channel/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`sales-channel.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a sales channel is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted sales channel
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/stock-location/events/_events-table/page.mdx
+57
View File
@@ -0,0 +1,57 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`stock-location.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a stock location is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted stock location
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`stock-location-address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a stock location address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted stock location address
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/stock-location/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/store/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`store.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a store is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted store
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/store/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/tax/events/_events-table/page.mdx
+101
View File
@@ -0,0 +1,101 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`tax-rate.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax rate is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax rate
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax-region.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax region is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax region
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax-rate-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax rate rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax rate rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax-provider.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax provider is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax provider
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/tax/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/commerce-modules/user/events/_events-table/page.mdx
+167
View File
@@ -0,0 +1,167 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`user.created`
</Table.Cell>
<Table.Cell>
Triggered when a user is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the user
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.updated`
</Table.Cell>
<Table.Cell>
Triggered when a user is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the user
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a user is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted user
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`invite.created`
</Table.Cell>
<Table.Cell>
Triggered when an invite is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the invite
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.updated`
</Table.Cell>
<Table.Cell>
Triggered when an invite is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the invite
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an invite is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted invite
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.token_generated`
</Table.Cell>
<Table.Cell>
Triggered when an invite's token is generated for the first time or refreshed.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the invite
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/user/events/page.mdx
+11
View File
@@ -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.
<EventsTable />
www/apps/resources/app/events-reference/page.mdx
+55 -3267
View File
File diff suppressed because it is too large Load Diff