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/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 />