docs: sort events in reference alphabetically (#12845)
This commit is contained in:
Shahed Nasser
@@ -10,125 +10,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the User Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## User Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.created](#usercreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.updated](#userupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.deleted](#userdeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "usercreated", children: (<>user.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.created" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when users are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [createUsersWorkflow](/references/medusa-workflows/createUsersWorkflow)
|
||||
- [createUserAccountWorkflow](/references/medusa-workflows/createUserAccountWorkflow)
|
||||
- [acceptInviteWorkflow](/references/medusa-workflows/acceptInviteWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "userupdated", children: (<>user.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.updated" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when users are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [updateUsersWorkflow](/references/medusa-workflows/updateUsersWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "userdeleted", children: (<>user.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.deleted" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when users are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [deleteUsersWorkflow](/references/medusa-workflows/deleteUsersWorkflow)
|
||||
- [removeUserAccountWorkflow](/references/medusa-workflows/removeUserAccountWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Invite Events
|
||||
## Invite Events
|
||||
|
||||
### Summary
|
||||
|
||||
@@ -278,3 +160,121 @@ for example.
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [refreshInviteTokensWorkflow](/references/medusa-workflows/refreshInviteTokensWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## User Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.created](#usercreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.updated](#userupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.deleted](#userdeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "usercreated", children: (<>user.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.created" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when users are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [createUsersWorkflow](/references/medusa-workflows/createUsersWorkflow)
|
||||
- [createUserAccountWorkflow](/references/medusa-workflows/createUserAccountWorkflow)
|
||||
- [acceptInviteWorkflow](/references/medusa-workflows/acceptInviteWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "userupdated", children: (<>user.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.updated" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when users are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [updateUsersWorkflow](/references/medusa-workflows/updateUsersWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "userdeleted", children: (<>user.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.deleted" payload={`\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when users are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [deleteUsersWorkflow](/references/medusa-workflows/deleteUsersWorkflow)
|
||||
- [removeUserAccountWorkflow](/references/medusa-workflows/removeUserAccountWorkflow)
|
||||
|
||||
Reference in New Issue
Block a user