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

chore(docs): Generated References (automated) (#14182)

Browse Source 
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `helper_steps`
- `inventory_next_models`
- `js_sdk`
- `module_events`
- `modules`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values.
> 
> - **Docs Generation**:
>   - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples.
> - **Fulfillment Workflows/Steps**:
>   - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`).
>   - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag.
>   - Refreshed example snippets and sample values.
> - **Notification Step** (`sendNotificationsStep`):
>   - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional.
>   - Output includes `provider_data` and `attachments` fields.
> - **Order Steps/Workflows**:
>   - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions.
>   - Example payloads adjusted (IDs, currencies, amounts).
> - **Meta**:
>   - Updated `<SourceCodeLink>` URLs to new commit hashes throughout.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]Oli JuhlShahed Nasser
 authored and GitHub committed 2025-12-02 06:59:52 +00:00
1 parent aba10608ae
commit 21f61ec160
983 files changed
+427349 -403173
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/module_events/module_events.Customer/page.mdx
+12 -12
View File
@@ -52,9 +52,9 @@ Emitted when a customer is deleted.
</Table>
<EventHeader headerLvl="2" headerProps={{ id: "customercreated", children: (<>customer.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.created" payload={`\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``} />
Emitted when a customer is created.
@@ -62,9 +62,9 @@ Emitted when a customer is created.
### Payload
```ts
[{
{
id, // The ID of the customer
}]
}
```
### Workflows Emitting this Event
@@ -77,9 +77,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="2" headerProps={{ id: "customerupdated", children: (<>customer.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``} />
Emitted when a customer is updated.
@@ -87,9 +87,9 @@ Emitted when a customer is updated.
### Payload
```ts
[{
{
id, // The ID of the customer
}]
}
```
### Workflows Emitting this Event
@@ -101,9 +101,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="2" headerProps={{ id: "customerdeleted", children: (<>customer.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``} />
Emitted when a customer is deleted.
@@ -111,9 +111,9 @@ Emitted when a customer is deleted.
### Payload
```ts
[{
{
id, // The ID of the customer
}]
}
```
### Workflows Emitting this Event
www/apps/resources/references/module_events/module_events.Fulfillment/page.mdx
+12 -12
View File
@@ -145,9 +145,9 @@ Emitted when shipping option types are 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.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the shipping option type
}]
}
\`\`\``} />
Emitted when shipping option types are updated.
@@ -155,9 +155,9 @@ Emitted when shipping option types are updated.
#### Payload
```ts
[{
{
id, // The ID of the shipping option type
}]
}
```
#### Workflows Emitting this Event
@@ -172,9 +172,9 @@ The following workflows emit this event when they're executed. These workflows a
<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.
@@ -182,9 +182,9 @@ Emitted when shipping option types are created.
#### Payload
```ts
[{
{
id, // The ID of the shipping option type
}]
}
```
#### Workflows Emitting this Event
@@ -199,9 +199,9 @@ The following workflows emit this event when they're executed. These workflows a
<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.
@@ -209,9 +209,9 @@ Emitted when shipping option types are deleted.
#### Payload
```ts
[{
{
id, // The ID of the shipping option type
}]
}
```
#### Workflows Emitting this Event
www/apps/resources/references/module_events/module_events.Order/page.mdx
+8 -8
View File
@@ -338,9 +338,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "ordercompleted", children: (<>order.completed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.completed" payload={`\`\`\`ts
[{
{
id, // The ID of the order
}]
}
\`\`\``} />
Emitted when orders are completed.
@@ -348,9 +348,9 @@ Emitted when orders are completed.
#### Payload
```ts
[{
{
id, // The ID of the order
}]
}
```
#### Workflows Emitting this Event
@@ -362,9 +362,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "orderarchived", children: (<>order.archived</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.archived" payload={`\`\`\`ts
[{
{
id, // The ID of the order
}]
}
\`\`\``} />
Emitted when an order is archived.
@@ -372,9 +372,9 @@ Emitted when an order is archived.
#### Payload
```ts
[{
{
id, // The ID of the order
}]
}
```
#### Workflows Emitting this Event
www/apps/resources/references/module_events/module_events.Product/page.mdx
+84 -84
View File
@@ -54,9 +54,9 @@ Emitted when product categories are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-categorycreated", children: (<>product-category.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``} />
Emitted when product categories are created.
@@ -64,9 +64,9 @@ Emitted when product categories are created.
#### Payload
```ts
[{
{
id, // The ID of the product category
}]
}
```
#### Workflows Emitting this Event
@@ -78,9 +78,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-categoryupdated", children: (<>product-category.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``} />
Emitted when product categories are updated.
@@ -88,9 +88,9 @@ Emitted when product categories are updated.
#### Payload
```ts
[{
{
id, // The ID of the product category
}]
}
```
#### Workflows Emitting this Event
@@ -102,9 +102,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-categorydeleted", children: (<>product-category.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``} />
Emitted when product categories are deleted.
@@ -112,9 +112,9 @@ Emitted when product categories are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product category
}]
}
```
#### Workflows Emitting this Event
@@ -169,9 +169,9 @@ Emitted when product collections are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-collectioncreated", children: (<>product-collection.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``} />
Emitted when product collections are created.
@@ -179,9 +179,9 @@ Emitted when product collections are created.
#### Payload
```ts
[{
{
id, // The ID of the product collection
}]
}
```
#### Workflows Emitting this Event
@@ -193,9 +193,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-collectionupdated", children: (<>product-collection.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``} />
Emitted when product collections are updated.
@@ -203,9 +203,9 @@ Emitted when product collections are updated.
#### Payload
```ts
[{
{
id, // The ID of the product collection
}]
}
```
#### Workflows Emitting this Event
@@ -217,9 +217,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-collectiondeleted", children: (<>product-collection.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``} />
Emitted when product collections are deleted.
@@ -227,9 +227,9 @@ Emitted when product collections are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product collection
}]
}
```
#### Workflows Emitting this Event
@@ -284,9 +284,9 @@ Emitted when product options are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-optionupdated", children: (<>product-option.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``} />
Emitted when product options are updated.
@@ -294,9 +294,9 @@ Emitted when product options are updated.
#### Payload
```ts
[{
{
id, // The ID of the product option
}]
}
```
#### Workflows Emitting this Event
@@ -308,9 +308,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-optioncreated", children: (<>product-option.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``} />
Emitted when product options are created.
@@ -318,9 +318,9 @@ Emitted when product options are created.
#### Payload
```ts
[{
{
id, // The ID of the product option
}]
}
```
#### Workflows Emitting this Event
@@ -332,9 +332,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-optiondeleted", children: (<>product-option.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``} />
Emitted when product options are deleted.
@@ -342,9 +342,9 @@ Emitted when product options are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product option
}]
}
```
#### Workflows Emitting this Event
@@ -399,9 +399,9 @@ Emitted when product tags are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-tagupdated", children: (<>product-tag.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``} />
Emitted when product tags are updated.
@@ -409,9 +409,9 @@ Emitted when product tags are updated.
#### Payload
```ts
[{
{
id, // The ID of the product tag
}]
}
```
#### Workflows Emitting this Event
@@ -423,9 +423,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-tagcreated", children: (<>product-tag.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``} />
Emitted when product tags are created.
@@ -433,9 +433,9 @@ Emitted when product tags are created.
#### Payload
```ts
[{
{
id, // The ID of the product tag
}]
}
```
#### Workflows Emitting this Event
@@ -447,9 +447,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-tagdeleted", children: (<>product-tag.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``} />
Emitted when product tags are deleted.
@@ -457,9 +457,9 @@ Emitted when product tags are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product tag
}]
}
```
#### Workflows Emitting this Event
@@ -514,9 +514,9 @@ Emitted when product types are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-typeupdated", children: (<>product-type.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``} />
Emitted when product types are updated.
@@ -524,9 +524,9 @@ Emitted when product types are updated.
#### Payload
```ts
[{
{
id, // The ID of the product type
}]
}
```
#### Workflows Emitting this Event
@@ -538,9 +538,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-typecreated", children: (<>product-type.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``} />
Emitted when product types are created.
@@ -548,9 +548,9 @@ Emitted when product types are created.
#### Payload
```ts
[{
{
id, // The ID of the product type
}]
}
```
#### Workflows Emitting this Event
@@ -562,9 +562,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-typedeleted", children: (<>product-type.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``} />
Emitted when product types are deleted.
@@ -572,9 +572,9 @@ Emitted when product types are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product type
}]
}
```
#### Workflows Emitting this Event
@@ -629,9 +629,9 @@ Emitted when product variants are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-variantupdated", children: (<>product-variant.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``} />
Emitted when product variants are updated.
@@ -639,9 +639,9 @@ Emitted when product variants are updated.
#### Payload
```ts
[{
{
id, // The ID of the product variant
}]
}
```
#### Workflows Emitting this Event
@@ -654,9 +654,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-variantcreated", children: (<>product-variant.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``} />
Emitted when product variants are created.
@@ -664,9 +664,9 @@ Emitted when product variants are created.
#### Payload
```ts
[{
{
id, // The ID of the product variant
}]
}
```
#### Workflows Emitting this Event
@@ -682,9 +682,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-variantdeleted", children: (<>product-variant.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``} />
Emitted when product variants are deleted.
@@ -692,9 +692,9 @@ Emitted when product variants are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product variant
}]
}
```
#### Workflows Emitting this Event
@@ -750,9 +750,9 @@ Emitted when products are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "productupdated", children: (<>product.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``} />
Emitted when products are updated.
@@ -760,9 +760,9 @@ Emitted when products are updated.
#### Payload
```ts
[{
{
id, // The ID of the product
}]
}
```
#### Workflows Emitting this Event
@@ -776,9 +776,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "productcreated", children: (<>product.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``} />
Emitted when products are created.
@@ -786,9 +786,9 @@ Emitted when products are created.
#### Payload
```ts
[{
{
id, // The ID of the product
}]
}
```
#### Workflows Emitting this Event
@@ -802,9 +802,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "productdeleted", children: (<>product.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``} />
Emitted when products are deleted.
@@ -812,9 +812,9 @@ Emitted when products are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product
}]
}
```
#### Workflows Emitting this Event
www/apps/resources/references/module_events/module_events.Region/page.mdx
+12 -12
View File
@@ -52,9 +52,9 @@ Emitted when regions are deleted.
</Table>
<EventHeader headerLvl="2" headerProps={{ id: "regionupdated", children: (<>region.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``} />
Emitted when regions are updated.
@@ -62,9 +62,9 @@ Emitted when regions are updated.
### Payload
```ts
[{
{
id, // The ID of the region
}]
}
```
### Workflows Emitting this Event
@@ -76,9 +76,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="2" headerProps={{ id: "regioncreated", children: (<>region.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.created" payload={`\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``} />
Emitted when regions are created.
@@ -86,9 +86,9 @@ Emitted when regions are created.
### Payload
```ts
[{
{
id, // The ID of the region
}]
}
```
### Workflows Emitting this Event
@@ -100,9 +100,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="2" headerProps={{ id: "regiondeleted", children: (<>region.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``} />
Emitted when regions are deleted.
@@ -110,9 +110,9 @@ Emitted when regions are deleted.
### Payload
```ts
[{
{
id, // The ID of the region
}]
}
```
### Workflows Emitting this Event
www/apps/resources/references/module_events/module_events.Sales_Channel/page.mdx
+12 -12
View File
@@ -52,9 +52,9 @@ Emitted when sales channels are deleted.
</Table>
<EventHeader headerLvl="2" headerProps={{ id: "sales-channelcreated", children: (<>sales-channel.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.created" payload={`\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``} />
Emitted when sales channels are created.
@@ -62,9 +62,9 @@ Emitted when sales channels are created.
### Payload
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
### Workflows Emitting this Event
@@ -76,9 +76,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="2" headerProps={{ id: "sales-channelupdated", children: (<>sales-channel.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``} />
Emitted when sales channels are updated.
@@ -86,9 +86,9 @@ Emitted when sales channels are updated.
### Payload
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
### Workflows Emitting this Event
@@ -100,9 +100,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="2" headerProps={{ id: "sales-channeldeleted", children: (<>sales-channel.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``} />
Emitted when sales channels are deleted.
@@ -110,9 +110,9 @@ Emitted when sales channels are deleted.
### Payload
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
### Workflows Emitting this Event
www/apps/resources/references/module_events/module_events.User/page.mdx
+24 -24
View File
@@ -89,9 +89,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "invitecreated", children: (<>invite.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.created" payload={`\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``} />
Emitted when invites are created. You can listen to this event
@@ -100,9 +100,9 @@ to send an email to the invited users, for example.
#### Payload
```ts
[{
{
id, // The ID of the invite
}]
}
```
#### Workflows Emitting this Event
@@ -114,9 +114,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "invitedeleted", children: (<>invite.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``} />
Emitted when invites are deleted.
@@ -124,9 +124,9 @@ Emitted when invites are deleted.
#### Payload
```ts
[{
{
id, // The ID of the invite
}]
}
```
#### Workflows Emitting this Event
@@ -138,9 +138,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "inviteresent", children: (<>invite.resent</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.resent" payload={`\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``} />
Emitted when invites should be resent because their token was
@@ -150,9 +150,9 @@ for example.
#### Payload
```ts
[{
{
id, // The ID of the invite
}]
}
```
#### Workflows Emitting this Event
@@ -207,9 +207,9 @@ Emitted when users are deleted.
</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.
@@ -217,9 +217,9 @@ Emitted when users are created.
#### Payload
```ts
[{
{
id, // The ID of the user
}]
}
```
#### Workflows Emitting this Event
@@ -233,9 +233,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<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.
@@ -243,9 +243,9 @@ Emitted when users are updated.
#### Payload
```ts
[{
{
id, // The ID of the user
}]
}
```
#### Workflows Emitting this Event
@@ -257,9 +257,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<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.
@@ -267,9 +267,9 @@ Emitted when users are deleted.
#### Payload
```ts
[{
{
id, // The ID of the user
}]
}
```
#### Workflows Emitting this Event