@redotech/redo-api-schema 2.2.245 → 2.2.320

package/lib/openapi.d.ts

@@ -121,6 +121,24 @@ export interface paths {
      */
     post: operations["Customer subscriptions update"];
   };
+  "/stores/{storeId}/events": {
+    /**
+     * Create custom event
+     * @description Create a custom event to trigger flows with merchant-defined event names and properties.
+     *
+     * Custom events allow merchants to trigger flows based on events from their own systems.
+     * Events can include custom properties that are accessible in email and SMS templates.
+     *
+     * ## Customer Matching
+     * The API matches customers by email or phone number. At least one must be provided.
+     *
+     * If no matching customer is found, the request will fail with a 404 error.
+     *
+     * ## Rate Limiting
+     * This endpoint is rate-limited to 100 requests per second per store.
+     */
+    post: operations["Custom event create"];
+  };
   "/stores/{storeId}/invoices": {
     /**
      * List Invoices
@@ -325,6 +343,42 @@ export interface components {
        */
       price: components["schemas"]["money.schema"];
     };
+    /**
+     * Custom Event Request
+     * @description Custom event to trigger flows with merchant-defined event names and properties.
+     */
+    "custom-event-request.schema": {
+      /** @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'). */
+      event_name: string;
+      /**
+       * Format: date-time
+       * @description ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
+       */
+      event_timestamp?: string;
+      /** @description Customer phone number (one of email or phone is required). */
+      phone?: string;
+      /** @description Custom properties for this event. Access in templates using dot notation (e.g., {{ properties.product_name }}). */
+      properties?: {
+        [key: string]: unknown;
+      };
+    };
+    /**
+     * Custom Event Response
+     * @description Response after successfully creating a custom event.
+     */
+    "custom-event-response.schema": {
+      /** @description The unique identifier for the created event. */
+      event_id: string;
+      /** @description The name of the custom event that was created. */
+      event_name: string;
+      /**
+       * @description Status of the event processing.
+       * @enum {string}
+       */
+      status: "processed";
+    };
     /** @description Email subscription updates */
     "customer-subscription-email.schema": {
       /**
@@ -913,6 +967,11 @@ export interface components {
        * @description Carrier code
        */
       carrier?: string;
+      /**
+       * Postage Label
+       * @description Postage label URL
+       */
+      postageLabel?: string;
       /**
        * Status
        * @description Status of shipment
@@ -1862,6 +1921,65 @@ export interface operations {
       };
     };
   };
+  /**
+   * Create custom event
+   * @description Create a custom event to trigger flows with merchant-defined event names and properties.
+   *
+   * Custom events allow merchants to trigger flows based on events from their own systems.
+   * Events can include custom properties that are accessible in email and SMS templates.
+   *
+   * ## Customer Matching
+   * The API matches customers by email or phone number. At least one must be provided.
+   *
+   * If no matching customer is found, the request will fail with a 404 error.
+   *
+   * ## Rate Limiting
+   * This endpoint is rate-limited to 100 requests per second per store.
+   */
+  "Custom event create": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["custom-event-request.schema"];
+      };
+    };
+    responses: {
+      /** @description Event created successfully */
+      200: {
+        content: {
+          "application/json": components["schemas"]["custom-event-response.schema"];
+        };
+      };
+      /** @description Invalid request body or missing required customer identifier */
+      400: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Customer not found with provided identifier */
+      404: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Rate limit exceeded */
+      429: {
+        content: {
+          "application/json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * List Invoices
    * @description Get a list of invoices.

package/lib/openapi.yaml

@@ -217,6 +217,52 @@ components:
         - price
       title: Coverage product
       type: object
+    custom-event-request.schema:
+      additionalProperties: false
+      description: Custom event to trigger flows with merchant-defined event names and properties.
+      properties:
+        email:
+          description: Customer email address (one of email or phone is required).
+          type: string
+        event_name:
+          description: The name of the custom event (e.g., 'user_registered', 'purchase_completed').
+          type: string
+        event_timestamp:
+          description: ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
+          format: date-time
+          type: string
+        phone:
+          description: Customer phone number (one of email or phone is required).
+          type: string
+        properties:
+          additionalProperties: true
+          description: Custom properties for this event. Access in templates using dot notation (e.g., {{ properties.product_name }}).
+          type: object
+      required:
+        - event_name
+      title: Custom Event Request
+      type: object
+    custom-event-response.schema:
+      additionalProperties: false
+      description: Response after successfully creating a custom event.
+      properties:
+        event_id:
+          description: The unique identifier for the created event.
+          type: string
+        event_name:
+          description: The name of the custom event that was created.
+          type: string
+        status:
+          description: Status of the event processing.
+          enum:
+            - processed
+          type: string
+      required:
+        - event_id
+        - status
+        - event_name
+      title: Custom Event Response
+      type: object
     customer-subscription-email.schema:
       description: Email subscription updates
       properties:
@@ -991,6 +1037,10 @@ components:
           description: Carrier code
           title: Carrier
           type: string
+        postageLabel:
+          description: Postage label URL
+          title: Postage Label
+          type: string
         status:
           description: Status of shipment
           enum:
@@ -2087,6 +2137,85 @@ paths:
       tags:
         - Customer Subscriptions
     summary: Customer subscriptions
+  /stores/{storeId}/events:
+    post:
+      description: |
+        Create a custom event to trigger flows with merchant-defined event names and properties.
+
+        Custom events allow merchants to trigger flows based on events from their own systems.
+        Events can include custom properties that are accessible in email and SMS templates.
+
+        ## Customer Matching
+        The API matches customers by email or phone number. At least one must be provided.
+
+        If no matching customer is found, the request will fail with a 404 error.
+
+        ## Rate Limiting
+        This endpoint is rate-limited to 100 requests per second per store.
+      operationId: Custom event create
+      parameters:
+        - $ref: '#/components/parameters/store-id.param'
+      requestBody:
+        content:
+          application/json:
+            examples:
+              purchase_milestone:
+                summary: Purchase milestone event
+                value:
+                  event_name: purchase_milestone_reached
+                  phone: '+12065551234'
+                  properties:
+                    milestone_type: 100th_purchase
+                    total_spent: 5000
+                    vip_tier: gold
+              user_registered:
+                summary: User registration event
+                value:
+                  email: customer@example.com
+                  event_name: user_registered
+                  properties:
+                    plan_type: premium
+                    referral_code: FRIEND123
+                    source: mobile_app
+            schema:
+              $ref: '#/components/schemas/custom-event-request.schema'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/custom-event-response.schema'
+          description: Event created successfully
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Invalid request body or missing required customer identifier
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Customer not found with provided identifier
+        '429':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Rate limit exceeded
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Create custom event
+      tags:
+        - Custom Events
   /stores/{storeId}/invoices:
     description: Return a list of invoices.
     get:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.245"
+  "version": "2.2.320"
 }