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

docs: fix events payloads (#14131)

Browse Source
This commit is contained in:
Shahed Nasser
2025-11-26 16:12:00 +02:00
committed by GitHub
parent c1ede88a7e
commit c3cebdfe80
139 changed files with 1057 additions and 904 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/events-output.json
+41 -41
View File
@@ -51,7 +51,7 @@
"name": "customer.created",
"parentName": "CustomerWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the customer\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the customer\n}\n```",
"description": "Emitted when a customer is created.",
"workflows": [
"createCustomersWorkflow",
@@ -63,7 +63,7 @@
"name": "customer.updated",
"parentName": "CustomerWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the customer\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the customer\n}\n```",
"description": "Emitted when a customer is updated.",
"workflows": [
"updateCustomersWorkflow"
@@ -74,7 +74,7 @@
"name": "customer.deleted",
"parentName": "CustomerWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the customer\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the customer\n}\n```",
"description": "Emitted when a customer is deleted.",
"workflows": [
"deleteCustomersWorkflow",
@@ -121,7 +121,7 @@
"name": "order.completed",
"parentName": "OrderWorkflowEvents",
"propertyName": "COMPLETED",
"payload": "```ts\n[{\n id, // The ID of the order\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the order\n}\n```",
"description": "Emitted when orders are completed.",
"workflows": [
"completeOrderWorkflow"
@@ -132,7 +132,7 @@
"name": "order.archived",
"parentName": "OrderWorkflowEvents",
"propertyName": "ARCHIVED",
"payload": "```ts\n[{\n id, // The ID of the order\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the order\n}\n```",
"description": "Emitted when an order is archived.",
"workflows": [
"archiveOrderWorkflow"
@@ -258,7 +258,7 @@
"name": "user.created",
"parentName": "UserWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the user\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the user\n}\n```",
"description": "Emitted when users are created.",
"workflows": [
"createUsersWorkflow",
@@ -271,7 +271,7 @@
"name": "user.updated",
"parentName": "UserWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the user\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the user\n}\n```",
"description": "Emitted when users are updated.",
"workflows": [
"updateUsersWorkflow"
@@ -282,7 +282,7 @@
"name": "user.deleted",
"parentName": "UserWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the user\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the user\n}\n```",
"description": "Emitted when users are deleted.",
"workflows": [
"deleteUsersWorkflow",
@@ -305,7 +305,7 @@
"name": "sales-channel.created",
"parentName": "SalesChannelWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the sales channel\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the sales channel\n}\n```",
"description": "Emitted when sales channels are created.",
"workflows": [
"createSalesChannelsWorkflow"
@@ -316,7 +316,7 @@
"name": "sales-channel.updated",
"parentName": "SalesChannelWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the sales channel\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the sales channel\n}\n```",
"description": "Emitted when sales channels are updated.",
"workflows": [
"updateSalesChannelsWorkflow"
@@ -327,7 +327,7 @@
"name": "sales-channel.deleted",
"parentName": "SalesChannelWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the sales channel\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the sales channel\n}\n```",
"description": "Emitted when sales channels are deleted.",
"workflows": [
"deleteSalesChannelsWorkflow"
@@ -338,7 +338,7 @@
"name": "product-category.created",
"parentName": "ProductCategoryWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the product category\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product category\n}\n```",
"description": "Emitted when product categories are created.",
"workflows": [
"createProductCategoriesWorkflow"
@@ -349,7 +349,7 @@
"name": "product-category.updated",
"parentName": "ProductCategoryWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the product category\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product category\n}\n```",
"description": "Emitted when product categories are updated.",
"workflows": [
"updateProductCategoriesWorkflow"
@@ -360,7 +360,7 @@
"name": "product-category.deleted",
"parentName": "ProductCategoryWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the product category\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product category\n}\n```",
"description": "Emitted when product categories are deleted.",
"workflows": [
"deleteProductCategoriesWorkflow"
@@ -371,7 +371,7 @@
"name": "product-collection.created",
"parentName": "ProductCollectionWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the product collection\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product collection\n}\n```",
"description": "Emitted when product collections are created.",
"workflows": [
"createCollectionsWorkflow"
@@ -382,7 +382,7 @@
"name": "product-collection.updated",
"parentName": "ProductCollectionWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the product collection\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product collection\n}\n```",
"description": "Emitted when product collections are updated.",
"workflows": [
"updateCollectionsWorkflow"
@@ -393,7 +393,7 @@
"name": "product-collection.deleted",
"parentName": "ProductCollectionWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the product collection\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product collection\n}\n```",
"description": "Emitted when product collections are deleted.",
"workflows": [
"deleteCollectionsWorkflow"
@@ -404,7 +404,7 @@
"name": "product-variant.updated",
"parentName": "ProductVariantWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the product variant\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product variant\n}\n```",
"description": "Emitted when product variants are updated.",
"workflows": [
"updateProductVariantsWorkflow",
@@ -416,7 +416,7 @@
"name": "product-variant.created",
"parentName": "ProductVariantWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the product variant\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product variant\n}\n```",
"description": "Emitted when product variants are created.",
"workflows": [
"createProductVariantsWorkflow",
@@ -431,7 +431,7 @@
"name": "product-variant.deleted",
"parentName": "ProductVariantWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the product variant\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product variant\n}\n```",
"description": "Emitted when product variants are deleted.",
"workflows": [
"deleteProductVariantsWorkflow",
@@ -443,7 +443,7 @@
"name": "product.updated",
"parentName": "ProductWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the product\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product\n}\n```",
"description": "Emitted when products are updated.",
"workflows": [
"updateProductsWorkflow",
@@ -456,7 +456,7 @@
"name": "product.created",
"parentName": "ProductWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the product\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product\n}\n```",
"description": "Emitted when products are created.",
"workflows": [
"createProductsWorkflow",
@@ -469,7 +469,7 @@
"name": "product.deleted",
"parentName": "ProductWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the product\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product\n}\n```",
"description": "Emitted when products are deleted.",
"workflows": [
"deleteProductsWorkflow",
@@ -482,7 +482,7 @@
"name": "product-type.updated",
"parentName": "ProductTypeWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the product type\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product type\n}\n```",
"description": "Emitted when product types are updated.",
"workflows": [
"updateProductTypesWorkflow"
@@ -493,7 +493,7 @@
"name": "product-type.created",
"parentName": "ProductTypeWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the product type\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product type\n}\n```",
"description": "Emitted when product types are created.",
"workflows": [
"createProductTypesWorkflow"
@@ -504,7 +504,7 @@
"name": "product-type.deleted",
"parentName": "ProductTypeWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the product type\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product type\n}\n```",
"description": "Emitted when product types are deleted.",
"workflows": [
"deleteProductTypesWorkflow"
@@ -515,7 +515,7 @@
"name": "product-tag.updated",
"parentName": "ProductTagWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the product tag\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product tag\n}\n```",
"description": "Emitted when product tags are updated.",
"workflows": [
"updateProductTagsWorkflow"
@@ -526,7 +526,7 @@
"name": "product-tag.created",
"parentName": "ProductTagWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the product tag\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product tag\n}\n```",
"description": "Emitted when product tags are created.",
"workflows": [
"createProductTagsWorkflow"
@@ -537,7 +537,7 @@
"name": "product-tag.deleted",
"parentName": "ProductTagWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the product tag\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product tag\n}\n```",
"description": "Emitted when product tags are deleted.",
"workflows": [
"deleteProductTagsWorkflow"
@@ -548,7 +548,7 @@
"name": "product-option.updated",
"parentName": "ProductOptionWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the product option\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product option\n}\n```",
"description": "Emitted when product options are updated.",
"workflows": [
"updateProductOptionsWorkflow"
@@ -559,7 +559,7 @@
"name": "product-option.created",
"parentName": "ProductOptionWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the product option\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product option\n}\n```",
"description": "Emitted when product options are created.",
"workflows": [
"createProductOptionsWorkflow"
@@ -570,7 +570,7 @@
"name": "product-option.deleted",
"parentName": "ProductOptionWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the product option\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the product option\n}\n```",
"description": "Emitted when product options are deleted.",
"workflows": [
"deleteProductOptionsWorkflow"
@@ -592,7 +592,7 @@
"name": "invite.created",
"parentName": "InviteWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the invite\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the invite\n}\n```",
"description": "Emitted when invites are created. You can listen to this event\nto send an email to the invited users, for example.",
"workflows": [
"createInvitesWorkflow"
@@ -603,7 +603,7 @@
"name": "invite.deleted",
"parentName": "InviteWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the invite\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the invite\n}\n```",
"description": "Emitted when invites are deleted.",
"workflows": [
"deleteInvitesWorkflow"
@@ -614,7 +614,7 @@
"name": "invite.resent",
"parentName": "InviteWorkflowEvents",
"propertyName": "RESENT",
"payload": "```ts\n[{\n id, // The ID of the invite\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the invite\n}\n```",
"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.",
"workflows": [
"refreshInviteTokensWorkflow"
@@ -625,7 +625,7 @@
"name": "region.updated",
"parentName": "RegionWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the region\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the region\n}\n```",
"description": "Emitted when regions are updated.",
"workflows": [
"updateRegionsWorkflow"
@@ -636,7 +636,7 @@
"name": "region.created",
"parentName": "RegionWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the region\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the region\n}\n```",
"description": "Emitted when regions are created.",
"workflows": [
"createRegionsWorkflow"
@@ -647,7 +647,7 @@
"name": "region.deleted",
"parentName": "RegionWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the region\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the region\n}\n```",
"description": "Emitted when regions are deleted.",
"workflows": [
"deleteRegionsWorkflow"
@@ -680,7 +680,7 @@
"name": "shipping-option-type.updated",
"parentName": "ShippingOptionTypeWorkflowEvents",
"propertyName": "UPDATED",
"payload": "```ts\n[{\n id, // The ID of the shipping option type\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the shipping option type\n}\n```",
"description": "Emitted when shipping option types are updated.",
"workflows": [
"updateShippingOptionTypesWorkflow"
@@ -692,7 +692,7 @@
"name": "shipping-option-type.created",
"parentName": "ShippingOptionTypeWorkflowEvents",
"propertyName": "CREATED",
"payload": "```ts\n[{\n id, // The ID of the shipping option type\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the shipping option type\n}\n```",
"description": "Emitted when shipping option types are created.",
"workflows": [
"createShippingOptionTypesWorkflow"
@@ -704,7 +704,7 @@
"name": "shipping-option-type.deleted",
"parentName": "ShippingOptionTypeWorkflowEvents",
"propertyName": "DELETED",
"payload": "```ts\n[{\n id, // The ID of the shipping option type\n}]\n```",
"payload": "```ts\n{\n id, // The ID of the shipping option type\n}\n```",
"description": "Emitted when shipping option types are deleted.",
"workflows": [
"deleteShippingOptionTypesWorkflow"