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/inventory/_events/_events-table/page.mdx
-211
View File
@@ -1,211 +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 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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 blockStyle="inline"
{
// 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
-17
View File
@@ -1,17 +0,0 @@
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.
<Note type="soon">
Events are still in development, so this reference will change in the future.
</Note>
<EventsTable />