docs: document events reference (#9080)

- 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 authored and GitHub committed 2024-09-10 12:20:09 +00:00
1 parent 3fb2f10ccb
commit 4b663a4559
42 files changed
+843 -3025

No files matched your search

@@ -1,189 +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>
`cart.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a cart is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// 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 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.Body>
</Table>
@@ -1,17 +0,0 @@
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.
<Note type="soon">
Events are still in development, so this reference will change in the future.
</Note>
<EventsTable />