docs: generate OAS with events (#12394)

* docs: generate OAS with events * small change
2025-05-07 14:57:03 +03:00
parent 262064fe96
commit a3bdb3e383
515 changed files with 3808 additions and 189 deletions
@@ -80,6 +80,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteApiKeysWorkflow
+ * x-events: []
 * 
 */

@@ -80,6 +80,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteCampaignsWorkflow
+ * x-events: []
 * 
 */

@@ -85,6 +85,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemClaimActionWorkflow
+ * x-events: []
 * 
 */

@@ -71,6 +71,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemReturnActionWorkflow
+ * x-events: []
 * 
 */

@@ -71,6 +71,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeClaimShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -83,6 +83,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeAddItemClaimActionWorkflow
+ * x-events: []
 * 
 */

@@ -83,6 +83,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeClaimShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -62,6 +62,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: cancelBeginOrderClaimWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteCollectionsWorkflow
+ * x-events:
+ *   - name: product-collection.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product collection
+ *       }]
+ *       ```
+ *     description: Emitted when product collections are deleted.
+ *     deprecated: false
 * 
 */

@@ -79,6 +79,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteCustomerGroupsWorkflow
+ * x-events: []
 * 
 */

@@ -78,6 +78,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeCustomerAccountWorkflow
+ * x-events:
+ *   - name: customer.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the customer
+ *       }]
+ *       ```
+ *     description: Emitted when a customer is deleted.
+ *     deprecated: false
 * 
 */

@@ -103,6 +103,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteCustomerAddressesWorkflow
+ * x-events: []
 * 
 */

@@ -57,6 +57,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: cancelDraftOrderEditWorkflow
+ * x-events: []
 * 
 */

@@ -66,6 +66,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeDraftOrderActionItemWorkflow
+ * x-events: []
 * 
 */

@@ -65,6 +65,7 @@
 *     application/json:
 *       schema:
 *         $ref: "#/components/schemas/AdminRemoveDraftOrderPromotions"
+ * x-events: []
 * 
 */

@@ -66,6 +66,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeDraftOrderActionShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -66,6 +66,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeDraftOrderShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -71,6 +71,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemReturnActionWorkflow
+ * x-events: []
 * 
 */

@@ -71,6 +71,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeReturnShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -83,6 +83,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemExchangeActionWorkflow
+ * x-events: []
 * 
 */

@@ -83,6 +83,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeExchangeShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: cancelBeginOrderExchangeWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteFulfillmentSetsWorkflow
+ * x-events: []
 * 
 */

@@ -68,6 +68,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteServiceZonesWorkflow
+ * x-events: []
 * 
 */

@@ -79,6 +79,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteInventoryItemWorkflow
+ * x-events: []
 * 
 */

@@ -108,6 +108,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteInventoryLevelsWorkflow
+ * x-events: []
 * 
 */

@@ -77,6 +77,16 @@
 *   - api_token: []
 *   - cookie_auth: []
 *   - jwt_token: []
+ * x-events:
+ *   - name: invite.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the invite
+ *       }]
+ *       ```
+ *     description: Emitted when invites are deleted.
+ *     deprecated: false
 * 
 */

@@ -79,6 +79,17 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: cancelBeginOrderEditWorkflow
+ * x-events:
+ *   - name: order-edit.canceled
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         order_id, // The ID of the order
+ *         actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
+ *       }
+ *       ```
+ *     description: Emitted when an order edit request is canceled.
+ *     deprecated: false
 * 
 */

@@ -73,6 +73,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemOrderEditActionWorkflow
+ * x-events: []
 * 
 */

@@ -53,6 +53,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeOrderEditShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteOrderPaymentCollections
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deletePriceListsWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deletePricePreferencesWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteProductCategoriesWorkflow
+ * x-events:
+ *   - name: product-category.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product category
+ *       }]
+ *       ```
+ *     description: Emitted when product categories are deleted.
+ *     deprecated: false
 * 
 */

@@ -60,6 +60,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteProductTagsWorkflow
+ * x-events:
+ *   - name: product-tag.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product tag
+ *       }]
+ *       ```
+ *     description: Emitted when product tags are deleted.
+ *     deprecated: false
 * 
 */

@@ -60,6 +60,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteProductTypesWorkflow
+ * x-events:
+ *   - name: product-type.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product type
+ *       }]
+ *       ```
+ *     description: Emitted when product types are deleted.
+ *     deprecated: false
 * 
 */

@@ -60,6 +60,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteProductsWorkflow
+ * x-events:
+ *   - name: product.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product
+ *       }]
+ *       ```
+ *     description: Emitted when products are deleted.
+ *     deprecated: false
 * 
 */

@@ -82,6 +82,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteProductOptionsWorkflow
+ * x-events:
+ *   - name: product-option.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product option
+ *       }]
+ *       ```
+ *     description: Emitted when product options are deleted.
+ *     deprecated: false
 * 
 */

@@ -79,6 +79,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteProductVariantsWorkflow
+ * x-events:
+ *   - name: product-variant.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product variant
+ *       }]
+ *       ```
+ *     description: Emitted when product variants are deleted.
+ *     deprecated: false
 * 
 */

@@ -68,6 +68,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: dismissLinksWorkflow
+ * x-events: []
 * 
 */

@@ -79,6 +79,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deletePromotionsWorkflow
+ * x-events: []
 * 
 */

@@ -62,6 +62,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteRefundReasonsWorkflow
+ * x-events: []
 * 
 */

@@ -79,6 +79,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteRegionsWorkflow
+ * x-events:
+ *   - name: region.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the region
+ *       }]
+ *       ```
+ *     description: Emitted when regions are deleted.
+ *     deprecated: false
 * 
 */

@@ -79,6 +79,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteReservationsWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteReturnReasonsWorkflow
+ * x-events: []
 * 
 */

@@ -82,6 +82,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemReturnActionWorkflow
+ * x-events: []
 * 
 */

@@ -82,6 +82,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemReceiveReturnActionWorkflow
+ * x-events: []
 * 
 */

@@ -79,6 +79,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: cancelReturnReceiveWorkflow
+ * x-events: []
 * 
 */

@@ -82,6 +82,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeItemReturnActionWorkflow
+ * x-events: []
 * 
 */

@@ -79,6 +79,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: cancelReturnRequestWorkflow
+ * x-events: []
 * 
 */

@@ -82,6 +82,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeReturnShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteSalesChannelsWorkflow
+ * x-events:
+ *   - name: sales-channel.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the sales channel
+ *       }]
+ *       ```
+ *     description: Emitted when sales channels are deleted.
+ *     deprecated: false
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteShippingOptionsWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteShippingProfileWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteStockLocationsWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteTaxRatesWorkflow
+ * x-events: []
 * 
 */

@@ -87,6 +87,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteTaxRateRulesWorkflow
+ * x-events: []
 * 
 */

@@ -60,6 +60,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteTaxRegionsWorkflow
+ * x-events: []
 * 
 */

@@ -79,6 +79,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteFilesWorkflow
+ * x-events: []
 * 
 */

@@ -57,6 +57,16 @@
 * security:
 *   - cookie_auth: []
 *   - jwt_token: []
+ * x-events:
+ *   - name: user.deleted
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the user
+ *       }]
+ *       ```
+ *     description: Emitted when users are deleted.
+ *     deprecated: false
 * 
 */

@@ -111,7 +111,7 @@
 *         - type: string
 *           title: province
 *           description: Filter by an ISO 3166-2 province code. Must be lower-case.
- *           example: "us-ca"
+ *           example: us-ca
 *           externalDocs:
 *             url: https://en.wikipedia.org/wiki/ISO_3166-2
 *             description: Learn more about ISO 3166-2
@@ -121,7 +121,7 @@
 *             type: string
 *             title: province
 *             description: A ISO 3166-2 province code. Must be lower-case.
- *             example: "us-ca"
+ *             example: us-ca
 *             externalDocs:
 *               url: https://en.wikipedia.org/wiki/ISO_3166-2
 *               description: Learn more about ISO 3166-2
@@ -1470,6 +1470,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: getOrdersListWorkflow
+ * x-events: []
 * 
 */

@@ -74,6 +74,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: getOrderDetailWorkflow
+ * x-events: []
 * 
 */

@@ -681,6 +681,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: getOrdersListWorkflow
+ * x-events: []
 * 
 */

@@ -120,6 +120,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: getOrderDetailWorkflow
+ * x-events: []
 * 
 */

@@ -134,7 +134,7 @@
 *         - type: string
 *           title: province_code
 *           description: Filter by a ISO 3166-2 province code. Must be lower-case.
- *           example: "us-ca"
+ *           example: us-ca
 *           externalDocs:
 *             url: https://en.wikipedia.org/wiki/ISO_3166-2
 *             description: Learn more about ISO 3166-2
@@ -144,7 +144,7 @@
 *             type: string
 *             title: province_code
 *             description: A ISO 3166-2 province code.
- *             example: "us-ca"
+ *             example: us-ca
 *             externalDocs:
 *               url: https://en.wikipedia.org/wiki/ISO_3166-2
 *               description: Learn more about ISO 3166-2
@@ -70,6 +70,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createApiKeysWorkflow
+ * x-events: []
 * 
 */

@@ -83,6 +83,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateApiKeysWorkflow
+ * x-events: []
 * 
 */

@@ -78,6 +78,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: revokeApiKeysWorkflow
+ * x-events: []
 * 
 */

@@ -97,6 +97,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: linkSalesChannelsToApiKeyWorkflow
+ * x-events: []
 * 
 */

@@ -158,6 +158,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createCampaignsWorkflow
+ * x-events: []
 * 
 */

@@ -144,6 +144,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCampaignsWorkflow
+ * x-events: []
 * 
 */

@@ -97,6 +97,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: addOrRemoveCampaignPromotionsWorkflow
+ * x-events: []
 * 
 */

@@ -80,6 +80,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: beginClaimOrderWorkflow
+ * x-events: []
 * 
 */

@@ -65,6 +65,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: cancelOrderClaimWorkflow
+ * x-events: []
 * 
 */

@@ -85,6 +85,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: orderClaimItemWorkflow
+ * x-events: []
 * 
 */

@@ -92,6 +92,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateClaimItemWorkflow
+ * x-events: []
 * 
 */

@@ -77,6 +77,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: orderClaimRequestItemReturnWorkflow
+ * x-events: []
 * 
 */

@@ -81,6 +81,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateRequestItemReturnWorkflow
+ * x-events: []
 * 
 */

@@ -77,6 +77,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createClaimShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -93,6 +93,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateReturnShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -87,6 +87,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: orderClaimAddNewItemWorkflow
+ * x-events: []
 * 
 */

@@ -93,6 +93,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateClaimAddItemWorkflow
+ * x-events: []
 * 
 */

@@ -89,6 +89,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createClaimShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -93,6 +93,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateClaimShippingMethodWorkflow
+ * x-events: []
 * 
 */

@@ -76,6 +76,17 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: confirmClaimRequestWorkflow
+ * x-events:
+ *   - name: order.claim_created
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         order_id, // The ID of the order
+ *         claim_id, // The ID of the claim
+ *       }
+ *       ```
+ *     description: Emitted when a claim is created for an order.
+ *     deprecated: false
 * 
 */

@@ -78,6 +78,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createCollectionsWorkflow
+ * x-events:
+ *   - name: product-collection.created
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product collection
+ *       }]
+ *       ```
+ *     description: Emitted when product collections are created.
+ *     deprecated: false
 * 
 */

@@ -83,6 +83,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCollectionsWorkflow
+ * x-events:
+ *   - name: product-collection.updated
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the product collection
+ *       }]
+ *       ```
+ *     description: Emitted when product collections are updated.
+ *     deprecated: false
 * 
 */

@@ -97,6 +97,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: batchLinkProductsToCollectionWorkflow
+ * x-events: []
 * 
 */

@@ -78,6 +78,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createCustomerGroupsWorkflow
+ * x-events: []
 * 
 */

@@ -84,6 +84,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCustomerGroupsWorkflow
+ * x-events: []
 * 
 */

@@ -97,6 +97,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: linkCustomersToCustomerGroupWorkflow
+ * x-events: []
 * 
 */

@@ -125,6 +125,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createCustomersWorkflow
+ * x-events:
+ *   - name: customer.created
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the customer
+ *       }]
+ *       ```
+ *     description: Emitted when a customer is created.
+ *     deprecated: false
 * 
 */

@@ -131,6 +131,16 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCustomersWorkflow
+ * x-events:
+ *   - name: customer.updated
+ *     payload: |-
+ *       ```ts
+ *       [{
+ *         id, // The ID of the customer
+ *       }]
+ *       ```
+ *     description: Emitted when a customer is updated.
+ *     deprecated: false
 * 
 */

@@ -95,7 +95,7 @@
 *                 type: string
 *                 title: province
 *                 description: The address's ISO 3166-2 province code. Must be lower-case.
- *                 example: "us-ca"
+ *                 example: us-ca
 *                 externalDocs:
 *                   url: https://en.wikipedia.org/wiki/ISO_3166-2
 *                   description: Learn more about ISO 3166-2
@@ -182,6 +182,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createCustomerAddressesWorkflow
+ * x-events: []
 * 
 */

@@ -101,7 +101,7 @@
 *                 type: string
 *                 title: province
 *                 description: The address's ISO 3166-2 province code. Must be lower-case.
- *                 example: "us-ca"
+ *                 example: us-ca
 *                 externalDocs:
 *                   url: https://en.wikipedia.org/wiki/ISO_3166-2
 *                   description: Learn more about ISO 3166-2
@@ -188,6 +188,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateCustomerAddressesWorkflow
+ * x-events: []
 * 
 */

@@ -101,6 +101,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: linkCustomerGroupsToCustomerWorkflow
+ * x-events: []
 * 
 */

@@ -108,7 +108,7 @@
 *                     type: string
 *                     title: province
 *                     description: The billing address's ISO 3166-2 province code. Must be lower-case.
- *                     example: "us-ca"
+ *                     example: us-ca
 *                     externalDocs:
 *                       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *                       description: Learn more about ISO 3166-2
@@ -171,7 +171,7 @@
 *                     type: string
 *                     title: province
 *                     description: The shipping address's ISO 3166-2 province code. Must be lower-case.
- *                     example: "us-ca"
+ *                     example: us-ca
 *                     externalDocs:
 *                       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *                       description: Learn more about ISO 3166-2
@@ -393,6 +393,7 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createOrderWorkflow
+ * x-events: []
 * 
 */

@@ -2,7 +2,8 @@
 * @oas [post] /admin/draft-orders/{id}
 * operationId: PostDraftOrdersId
 * summary: Update a Draft Order
- * description: Update a draft order's details. This doesn't include updating the draft order's items, shipping methods, or promotions. To update those, you need to create an edit that you can later request or confirm.
+ * description: Update a draft order's details. This doesn't include updating the draft order's items, shipping methods, or promotions. To update those, you need to create an edit that you can later
+ *   request or confirm.
 * x-authenticated: true
 * parameters:
 *   - name: id
@@ -81,6 +82,18 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateDraftOrderWorkflow
+ * x-events:
+ *   - name: order.updated
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the order
+ *       }
+ *       ```
+ *     description: |-
+ *       Emitted when the details of an order or draft order is updated. This
+ *       doesn't include updates made by an edit.
+ *     deprecated: false
 * 
 */

@@ -71,6 +71,18 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: convertDraftOrderWorkflow
+ * x-events:
+ *   - name: order.placed
+ *     payload: |-
+ *       ```ts
+ *       {
+ *         id, // The ID of the order
+ *       }
+ *       ```
+ *     description: |-
+ *       Emitted when an order is placed, or when a draft order is converted to an
+ *       order.
+ *     deprecated: false
 * 
 */

--- a/Show More
+++ b/Show More