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

docs: document events reference (#9080)

Browse Source 
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
This commit is contained in:
Shahed Nasser
2024-09-10 12:20:09 +00:00
committed by GitHub
parent 3fb2f10ccb
commit 4b663a4559
42 changed files with 843 additions and 3025 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
@@ -1,321 +0,0 @@
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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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
-17
View File
@@ -1,17 +0,0 @@
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.
<Note type="soon">
Events are still in development, so this reference will change in the future.
</Note>
<EventsTable />