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

Generated the following references:
- `_index.mdx`
- `api_key`
- `api_key_models`
- `auth`
- `auth_models`
- `auth_provider`
- `cart`
- `cart_models`
- `core_flows`
- `currency`
- `currency_models`
- `customer`
- `customer_models`
- `events`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `fulfillment_provider`
- `inventory_next`
- `inventory_next_models`
- `js_sdk`
- `locking`
- `medusa`
- `module_events`
- `modules`
- `modules_sdk`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region`
- `region_models`
- `sales_channel`
- `sales_channel_models`
- `stock_location_next`
- `stock_location_next_models`
- `store`
- `store_models`
- `tax`
- `tax_models`
- `tax_provider`
- `types`
- `user`
- `user_models`
- `utils`
- `workflows`

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:
authored and GitHub committed 2025-05-13 13:31:57 +00:00
1 parent a4ffc0b2ee
commit 5c36bafc1d
1978 files changed
+332243 -279592

No files matched your search

@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# AuthWorkflowEvents
`Const` **AuthWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"PASSWORD_RESET","type":"`string`","description":"Emitted when a reset password token is generated. You can listen to this event\nto send a reset password email to the user or customer, for example.","optional":false,"defaultValue":"\"auth.password_reset\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CartWorkflowEvents
`Const` **CartWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a cart is created.","optional":false,"defaultValue":"\"cart.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a cart's details are updated.","optional":false,"defaultValue":"\"cart.updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_UPDATED","type":"`string`","description":"Emitted when the customer in the cart is updated.","optional":false,"defaultValue":"\"cart.customer_updated\"","expandable":false,"children":[]},{"name":"REGION_UPDATED","type":"`string`","description":"Emitted when the cart's region is updated. This\nevent is emitted alongside the `cart.updated` event.","optional":false,"defaultValue":"\"cart.region_updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_TRANSFERRED","type":"`string`","description":"Emitted when the customer in the cart is transferred.","optional":false,"defaultValue":"\"cart.customer_transferred\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CustomerWorkflowEvents
`Const` **CustomerWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a customer is created.","optional":false,"defaultValue":"\"customer.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a customer is updated.","optional":false,"defaultValue":"\"customer.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when a customer is deleted.","optional":false,"defaultValue":"\"customer.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CustomerWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# FulfillmentWorkflowEvents
`Const` **FulfillmentWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"SHIPMENT_CREATED","type":"`string`","description":"Emitted when a shipment is created for an order.","optional":false,"defaultValue":"\"shipment.created\"","expandable":false,"children":[]},{"name":"DELIVERY_CREATED","type":"`string`","description":"Emitted when a fulfillment is marked as delivered.","optional":false,"defaultValue":"\"delivery.created\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# OrderEditWorkflowEvents
`Const` **OrderEditWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"REQUESTED","type":"`string`","description":"Emitted when an order edit is requested.","optional":false,"defaultValue":"\"order-edit.requested\"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`string`","description":"Emitted when an order edit request is confirmed.","optional":false,"defaultValue":"\"order-edit.confirmed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"Emitted when an order edit request is canceled.","optional":false,"defaultValue":"\"order-edit.canceled\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderEditWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# OrderWorkflowEvents
`Const` **OrderWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when the details of an order or draft order is updated. This\ndoesn't include updates made by an edit.","optional":false,"defaultValue":"\"order.updated\"","expandable":false,"children":[]},{"name":"PLACED","type":"`string`","description":"Emitted when an order is placed, or when a draft order is converted to an\norder.","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"Emitted when an order is canceld.","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"Emitted when orders are completed.","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`string`","description":"Emitted when an order is archived.","optional":false,"defaultValue":"\"order.archived\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CREATED","type":"`string`","description":"Emitted when a fulfillment is created for an order.","optional":false,"defaultValue":"\"order.fulfillment_created\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CANCELED","type":"`string`","description":"Emitted when an order's fulfillment is canceled.","optional":false,"defaultValue":"\"order.fulfillment_canceled\"","expandable":false,"children":[]},{"name":"RETURN_REQUESTED","type":"`string`","description":"Emitted when a return request is confirmed.","optional":false,"defaultValue":"\"order.return_requested\"","expandable":false,"children":[]},{"name":"RETURN_RECEIVED","type":"`string`","description":"Emitted when a return is marked as received.","optional":false,"defaultValue":"\"order.return_received\"","expandable":false,"children":[]},{"name":"CLAIM_CREATED","type":"`string`","description":"Emitted when a claim is created for an order.","optional":false,"defaultValue":"\"order.claim_created\"","expandable":false,"children":[]},{"name":"EXCHANGE_CREATED","type":"`string`","description":"Emitted when an exchange is created for an order.","optional":false,"defaultValue":"\"order.exchange_created\"","expandable":false,"children":[]},{"name":"TRANSFER_REQUESTED","type":"`string`","description":"Emitted when an order is requested to be transferred to\nanother customer.","optional":false,"defaultValue":"\"order.transfer_requested\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ProductCategoryWorkflowEvents
`Const` **ProductCategoryWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when product categories are created.","optional":false,"defaultValue":"\"product-category.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when product categories are updated.","optional":false,"defaultValue":"\"product-category.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product categories are deleted.","optional":false,"defaultValue":"\"product-category.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCategoryWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ProductCollectionWorkflowEvents
`Const` **ProductCollectionWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when product collections are created.","optional":false,"defaultValue":"\"product-collection.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when product collections are updated.","optional":false,"defaultValue":"\"product-collection.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product collections are deleted.","optional":false,"defaultValue":"\"product-collection.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCollectionWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ProductOptionWorkflowEvents
`Const` **ProductOptionWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product options are updated.","optional":false,"defaultValue":"\"product-option.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product options are created.","optional":false,"defaultValue":"\"product-option.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product options are deleted.","optional":false,"defaultValue":"\"product-option.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductOptionWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ProductTagWorkflowEvents
`Const` **ProductTagWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product tags are updated.","optional":false,"defaultValue":"\"product-tag.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product tags are created.","optional":false,"defaultValue":"\"product-tag.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product tags are deleted.","optional":false,"defaultValue":"\"product-tag.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTagWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ProductTypeWorkflowEvents
`Const` **ProductTypeWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product types are updated.","optional":false,"defaultValue":"\"product-type.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product types are created.","optional":false,"defaultValue":"\"product-type.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product types are deleted.","optional":false,"defaultValue":"\"product-type.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTypeWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ProductVariantWorkflowEvents
`Const` **ProductVariantWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product variants are updated.","optional":false,"defaultValue":"\"product-variant.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product variants are created.","optional":false,"defaultValue":"\"product-variant.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product variants are deleted.","optional":false,"defaultValue":"\"product-variant.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductVariantWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ProductWorkflowEvents
`Const` **ProductWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when products are updated.","optional":false,"defaultValue":"\"product.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when products are created.","optional":false,"defaultValue":"\"product.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when products are deleted.","optional":false,"defaultValue":"\"product.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# RegionWorkflowEvents
`Const` **RegionWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when regions are updated.","optional":false,"defaultValue":"\"region.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when regions are created.","optional":false,"defaultValue":"\"region.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when regions are deleted.","optional":false,"defaultValue":"\"region.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RegionWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# SalesChannelWorkflowEvents
`Const` **SalesChannelWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when sales channels are created.","optional":false,"defaultValue":"\"sales-channel.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when sales channels are updated.","optional":false,"defaultValue":"\"sales-channel.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when sales channels are deleted.","optional":false,"defaultValue":"\"sales-channel.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SalesChannelWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# InviteWorkflowEvents
`Const` **InviteWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"ACCEPTED","type":"`string`","description":"Emitted when an invite is accepted.","optional":false,"defaultValue":"\"invite.accepted\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when invites are created. You can listen to this event\nto send an email to the invited users, for example.","optional":false,"defaultValue":"\"invite.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when invites are deleted.","optional":false,"defaultValue":"\"invite.deleted\"","expandable":false,"children":[]},{"name":"RESENT","type":"`string`","description":"Emitted when invites should be resent because their token was\nrefreshed. You can listen to this event to send an email to the invited users,\nfor example.","optional":false,"defaultValue":"\"invite.resent\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InviteWorkflowEvents"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# UserWorkflowEvents
`Const` **UserWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when users are created.","optional":false,"defaultValue":"\"user.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when users are updated.","optional":false,"defaultValue":"\"user.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when users are deleted.","optional":false,"defaultValue":"\"user.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UserWorkflowEvents"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Auth
## Variables
- [AuthWorkflowEvents](../Auth/variables/utils.Auth.AuthWorkflowEvents/page.mdx)
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Cart
## Variables
- [CartWorkflowEvents](../Cart/variables/utils.Cart.CartWorkflowEvents/page.mdx)
@@ -4,140 +4,52 @@ import { TypeList } from "docs-ui"
## Variables
- [AuthWorkflowEvents](page.mdx#authworkflowevents)
- [CartWorkflowEvents](page.mdx#cartworkflowevents)
- [CustomerWorkflowEvents](page.mdx#customerworkflowevents)
- [InviteWorkflowEvents](page.mdx#inviteworkflowevents)
- [OrderWorkflowEvents](page.mdx#orderworkflowevents)
- [ProductCategoryWorkflowEvents](page.mdx#productcategoryworkflowevents)
- [ProductCollectionWorkflowEvents](page.mdx#productcollectionworkflowevents)
- [ProductOptionWorkflowEvents](page.mdx#productoptionworkflowevents)
- [ProductTagWorkflowEvents](page.mdx#producttagworkflowevents)
- [ProductTypeWorkflowEvents](page.mdx#producttypeworkflowevents)
- [ProductVariantWorkflowEvents](page.mdx#productvariantworkflowevents)
- [ProductWorkflowEvents](page.mdx#productworkflowevents)
- [RegionWorkflowEvents](page.mdx#regionworkflowevents)
- [SalesChannelWorkflowEvents](page.mdx#saleschannelworkflowevents)
- [UserWorkflowEvents](page.mdx#userworkflowevents)
- [AuthWorkflowEvents](../Auth/variables/utils.Auth.AuthWorkflowEvents/page.mdx)
- [CartWorkflowEvents](../Cart/variables/utils.Cart.CartWorkflowEvents/page.mdx)
- [CustomerWorkflowEvents](../Customer/variables/utils.Customer.CustomerWorkflowEvents/page.mdx)
- [FulfillmentWorkflowEvents](../Fulfillment/variables/utils.Fulfillment.FulfillmentWorkflowEvents/page.mdx)
- [InviteWorkflowEvents](../User/variables/utils.User.InviteWorkflowEvents/page.mdx)
- [OrderEditWorkflowEvents](../Order/variables/utils.Order.OrderEditWorkflowEvents/page.mdx)
- [OrderWorkflowEvents](../Order/variables/utils.Order.OrderWorkflowEvents/page.mdx)
- [ProductCategoryWorkflowEvents](../Product/variables/utils.Product.ProductCategoryWorkflowEvents/page.mdx)
- [ProductCollectionWorkflowEvents](../Product/variables/utils.Product.ProductCollectionWorkflowEvents/page.mdx)
- [ProductOptionWorkflowEvents](../Product/variables/utils.Product.ProductOptionWorkflowEvents/page.mdx)
- [ProductTagWorkflowEvents](../Product/variables/utils.Product.ProductTagWorkflowEvents/page.mdx)
- [ProductTypeWorkflowEvents](../Product/variables/utils.Product.ProductTypeWorkflowEvents/page.mdx)
- [ProductVariantWorkflowEvents](../Product/variables/utils.Product.ProductVariantWorkflowEvents/page.mdx)
- [ProductWorkflowEvents](../Product/variables/utils.Product.ProductWorkflowEvents/page.mdx)
- [RegionWorkflowEvents](../Region/variables/utils.Region.RegionWorkflowEvents/page.mdx)
- [SalesChannelWorkflowEvents](../Sales_Channel/variables/utils.Sales_Channel.SalesChannelWorkflowEvents/page.mdx)
- [UserWorkflowEvents](../User/variables/utils.User.UserWorkflowEvents/page.mdx)
## Variables
___
### AuthWorkflowEvents
___
`Const` **AuthWorkflowEvents**: `Object`
___
#### Properties
___
<TypeList types={[{"name":"PASSWORD_RESET","type":"`string`","description":"","optional":false,"defaultValue":"\"auth.password_reset\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthWorkflowEvents"/>
___
### CartWorkflowEvents
___
`Const` **CartWorkflowEvents**: `Object`
___
#### Properties
___
<TypeList types={[{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"cart.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"cart.updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"cart.customer_updated\"","expandable":false,"children":[]},{"name":"REGION_UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"cart.region_updated\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartWorkflowEvents"/>
___
### CustomerWorkflowEvents
___
`Const` **CustomerWorkflowEvents**: `Object`
___
#### Properties
___
<TypeList types={[{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"customer.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"customer.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"customer.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CustomerWorkflowEvents"/>
___
### InviteWorkflowEvents
___
`Const` **InviteWorkflowEvents**: `Object`
___
#### Properties
<TypeList types={[{"name":"ACCEPTED","type":"`string`","description":"","optional":false,"defaultValue":"\"invite.accepted\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"invite.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"invite.deleted\"","expandable":false,"children":[]},{"name":"RESENT","type":"`string`","description":"","optional":false,"defaultValue":"\"invite.resent\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InviteWorkflowEvents"/>
### OrderWorkflowEvents
`Const` **OrderWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.updated\"","expandable":false,"children":[]},{"name":"PLACED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.archived\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.fulfillment_created\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.fulfillment_canceled\"","expandable":false,"children":[]},{"name":"RETURN_REQUESTED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.return_requested\"","expandable":false,"children":[]},{"name":"RETURN_RECEIVED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.return_received\"","expandable":false,"children":[]},{"name":"CLAIM_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.claim_created\"","expandable":false,"children":[]},{"name":"EXCHANGE_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.exchange_created\"","expandable":false,"children":[]},{"name":"TRANSFER_REQUESTED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.transfer_requested\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderWorkflowEvents"/>
### ProductCategoryWorkflowEvents
`Const` **ProductCategoryWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-category.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-category.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-category.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCategoryWorkflowEvents"/>
### ProductCollectionWorkflowEvents
`Const` **ProductCollectionWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCollectionWorkflowEvents"/>
### ProductOptionWorkflowEvents
`Const` **ProductOptionWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-option.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-option.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-option.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductOptionWorkflowEvents"/>
### ProductTagWorkflowEvents
`Const` **ProductTagWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-tag.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-tag.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-tag.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTagWorkflowEvents"/>
### ProductTypeWorkflowEvents
`Const` **ProductTypeWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-type.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-type.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-type.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTypeWorkflowEvents"/>
### ProductVariantWorkflowEvents
`Const` **ProductVariantWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-variant.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-variant.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-variant.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductVariantWorkflowEvents"/>
### ProductWorkflowEvents
`Const` **ProductWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductWorkflowEvents"/>
### RegionWorkflowEvents
`Const` **RegionWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"region.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"region.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"region.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RegionWorkflowEvents"/>
### SalesChannelWorkflowEvents
`Const` **SalesChannelWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales-channel.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales-channel.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales-channel.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SalesChannelWorkflowEvents"/>
### UserWorkflowEvents
`Const` **UserWorkflowEvents**: `Object`
#### Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"user.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"user.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"user.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UserWorkflowEvents"/>
___
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Customer
## Variables
- [CustomerWorkflowEvents](../Customer/variables/utils.Customer.CustomerWorkflowEvents/page.mdx)
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Fulfillment
## Variables
- [FulfillmentWorkflowEvents](../Fulfillment/variables/utils.Fulfillment.FulfillmentWorkflowEvents/page.mdx)
@@ -0,0 +1,10 @@
import { TypeList } from "docs-ui"
# Order
## Variables
- [OrderEditWorkflowEvents](../Order/variables/utils.Order.OrderEditWorkflowEvents/page.mdx)
- [OrderWorkflowEvents](../Order/variables/utils.Order.OrderWorkflowEvents/page.mdx)
___
@@ -0,0 +1,25 @@
import { TypeList } from "docs-ui"
# Product
## Variables
- [ProductCategoryWorkflowEvents](../Product/variables/utils.Product.ProductCategoryWorkflowEvents/page.mdx)
- [ProductCollectionWorkflowEvents](../Product/variables/utils.Product.ProductCollectionWorkflowEvents/page.mdx)
- [ProductOptionWorkflowEvents](../Product/variables/utils.Product.ProductOptionWorkflowEvents/page.mdx)
- [ProductTagWorkflowEvents](../Product/variables/utils.Product.ProductTagWorkflowEvents/page.mdx)
- [ProductTypeWorkflowEvents](../Product/variables/utils.Product.ProductTypeWorkflowEvents/page.mdx)
- [ProductVariantWorkflowEvents](../Product/variables/utils.Product.ProductVariantWorkflowEvents/page.mdx)
- [ProductWorkflowEvents](../Product/variables/utils.Product.ProductWorkflowEvents/page.mdx)
___
___
___
___
___
___
@@ -66,4 +66,4 @@ ___
### ProductEvents
`Const` **ProductEvents**: ReturnType&#60;["product", "productVariant", "productOption", "productOptionValue", "productType", "productTag", "productCategory", "productCollection"]&#62;
`Const` **ProductEvents**: ReturnType&#60;["product", "productVariant", "productOption", "productOptionValue", "productType", "productTag", "productCategory", "productCollection", "productImage"]&#62;
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Region
## Variables
- [RegionWorkflowEvents](../Region/variables/utils.Region.RegionWorkflowEvents/page.mdx)
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Sales Channel
## Variables
- [SalesChannelWorkflowEvents](../Sales_Channel/variables/utils.Sales_Channel.SalesChannelWorkflowEvents/page.mdx)
@@ -0,0 +1,10 @@
import { TypeList } from "docs-ui"
# User
## Variables
- [InviteWorkflowEvents](../User/variables/utils.User.InviteWorkflowEvents/page.mdx)
- [UserWorkflowEvents](../User/variables/utils.User.UserWorkflowEvents/page.mdx)
___