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,145 @@
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>
`promotion.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`application-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a application method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted application method
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a campaign is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted campaign
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign-budget.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a campaign budget is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted campaign budget
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion-rule-value.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion rule value is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion rule value
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Promotion Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Promotion Module.
<EventsTable />