@redotech/redo-api-schema 2.2.418 → 2.2.427

package/lib/openapi.d.ts

@@ -76,6 +76,11 @@ export interface paths {
     /**
      * Update Return Status
      * @description Update return status.
+     *
+     * Certain status transitions trigger additional side effects to maintain data consistency:
+     *
+     * - Setting status to **complete** will also mark all return items as complete.
+     * - Setting status to **open** from **complete** or **rejected** will reopen the return, resetting all processed/rejected items back to open, clearing pending processing info, resetting the expiration date, and marking the return as reopened. **Note:** Reopening a processed return does not reverse any refunds, exchanges, or other actions that were performed during processing.
      */
     put: operations["Return status update"];
   };
@@ -427,6 +432,19 @@ export interface components {
      * @description Custom event to trigger flows with merchant-defined event names and properties.
      */
     "custom-event-request.schema": {
+      /** @description Cart context for product recommendations in triggered emails. If not provided, no cart-aware recommendations will be made. */
+      cart_context?: ({
+        /** @description Items already in the customer's cart. */
+        alreadyInCart: {
+            productId: string;
+            quantity?: number;
+            variantId: string;
+          }[];
+        /** @description The ID of an existing cart to use for recommendations. */
+        existingCartId: string | null;
+        /** @description Product IDs to use as the basis for recommendations. */
+        productIdsForRecommendations: string[];
+      }) | null;
       /** @description Customer email address (one of email or phone is required). */
       email?: string;
       /** @description The name of the custom event (e.g., 'user_registered', 'purchase_completed'). */
@@ -1878,6 +1896,11 @@ export interface operations {
   /**
    * Update Return Status
    * @description Update return status.
+   *
+   * Certain status transitions trigger additional side effects to maintain data consistency:
+   *
+   * - Setting status to **complete** will also mark all return items as complete.
+   * - Setting status to **open** from **complete** or **rejected** will reopen the return, resetting all processed/rejected items back to open, clearing pending processing info, resetting the expiration date, and marking the return as reopened. **Note:** Reopening a processed return does not reverse any refunds, exchanges, or other actions that were performed during processing.
    */
   "Return status update": {
     parameters: {

package/lib/openapi.yaml

@@ -830,7 +830,13 @@ paths:
       tags:
         - Returns
     put:
-      description: Update return status.
+      description: |
+        Update return status.
+
+        Certain status transitions trigger additional side effects to maintain data consistency:
+
+        - Setting status to **complete** will also mark all return items as complete.
+        - Setting status to **open** from **complete** or **rejected** will reopen the return, resetting all processed/rejected items back to open, clearing pending processing info, resetting the expiration date, and marking the return as reopened. **Note:** Reopening a processed return does not reverse any refunds, exchanges, or other actions that were performed during processing.
       operationId: Return status update
       parameters:
         - $ref: '#/components/parameters/return-id.param'
@@ -1535,6 +1541,39 @@ components:
           description: ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
           format: date-time
           type: string
+        cart_context:
+          description: Cart context for product recommendations in triggered emails. If not provided, no cart-aware recommendations will be made.
+          nullable: true
+          type: object
+          properties:
+            existingCartId:
+              description: The ID of an existing cart to use for recommendations.
+              type: string
+              nullable: true
+            productIdsForRecommendations:
+              description: Product IDs to use as the basis for recommendations.
+              type: array
+              items:
+                type: string
+            alreadyInCart:
+              description: Items already in the customer's cart.
+              type: array
+              items:
+                type: object
+                properties:
+                  productId:
+                    type: string
+                  variantId:
+                    type: string
+                  quantity:
+                    type: number
+                required:
+                  - productId
+                  - variantId
+          required:
+            - existingCartId
+            - productIdsForRecommendations
+            - alreadyInCart
       required:
         - event_name
       title: Custom Event Request

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.418"
+  "version": "2.2.427"
 }