docs: update events reference (#7321)

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