asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: generate references for 2.10.1 (#13344)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-08-29 12:51:43 +03:00
1 parent cf4da02e39
commit 899ac2f052
1325 files changed
+470691 -426567
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/modules/events/page.mdx
+127
View File
@@ -2276,6 +2276,133 @@ The following workflows emit this event when they're executed. These workflows a
---
## Shipping Option Type 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>
[shipping-option-type.updated](#shipping-option-typeupdated)
<Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when shipping option types are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[shipping-option-type.created](#shipping-option-typecreated)
<Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when shipping option types are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[shipping-option-type.deleted](#shipping-option-typedeleted)
<Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when shipping option types are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typeupdated", children: (<>shipping-option-type.updated
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.updated" payload={`\`\`\`ts
[{
id, // The ID of the shipping option type
}]
\`\`\``} />
Emitted when shipping option types are updated.
#### Payload
```ts
[{
id, // The ID of the shipping option type
}]
```
#### 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.
- [updateShippingOptionTypesWorkflow](/references/medusa-workflows/updateShippingOptionTypesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typecreated", children: (<>shipping-option-type.created
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.created" payload={`\`\`\`ts
[{
id, // The ID of the shipping option type
}]
\`\`\``} />
Emitted when shipping option types are created.
#### Payload
```ts
[{
id, // The ID of the shipping option type
}]
```
#### 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.
- [createShippingOptionTypesWorkflow](/references/medusa-workflows/createShippingOptionTypesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typedeleted", children: (<>shipping-option-type.deleted
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.deleted" payload={`\`\`\`ts
[{
id, // The ID of the shipping option type
}]
\`\`\``} />
Emitted when shipping option types are deleted.
#### Payload
```ts
[{
id, // The ID of the shipping option type
}]
```
#### 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.
- [deleteShippingOptionTypesWorkflow](/references/medusa-workflows/deleteShippingOptionTypesWorkflow)
---
## User Events
### Summary