asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 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 authored and GitHub committed 2024-09-10 12:20:09 +00:00
1 parent 3fb2f10ccb
commit 4b663a4559
42 files changed
+843 -3025
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/app/commerce-modules/fulfillment/_events/_events-table/page.mdx
-255
View File
@@ -1,255 +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>
`fulfillment-set.created`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment set is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the fulfillment set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`fulfillment-set.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment set is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the deleted fulfillment set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`service-zone.created`
</Table.Cell>
<Table.Cell>
Triggered when a service zone is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the service zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`service-zone.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a service zone is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the deleted service zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`geo-zone.created`
</Table.Cell>
<Table.Cell>
Triggered when a geo zone is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the geo zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`geo-zone.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a geo zone is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the deleted geo zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the shipping option
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-profile.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping profile is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the shipping profile
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option-rule.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option rule is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the shipping option rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option-type.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option type is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the shipping option type
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`fulfillment-provider.created`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment provider is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the fulfillment provider
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/fulfillment/_events/page.mdx
-17
View File
@@ -1,17 +0,0 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Fulfillment Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Fulfillment Module.
<Note type="soon">
Events are still in development, so this reference will change in the future.
</Note>
<EventsTable />