@redotech/redo-api-schema 2.2.187 → 2.2.192

package/lib/openapi.d.ts

@@ -114,6 +114,13 @@ export interface paths {
      */
     get: operations["Customer portal navigate"];
   };
+  "/stores/{storeId}/customer-subscriptions": {
+    /**
+     * Update customer subscriptions
+     * @description Update customer subscription status for SMS and email marketing and transactional messages.
+     */
+    patch: operations["updateCustomerSubscriptions"];
+  };
   "/stores/{storeId}/invoices": {
     /**
      * Get invoice
@@ -318,6 +325,46 @@ export interface components {
        */
       price: components["schemas"]["money.schema"];
     };
+    /** @description Email subscription updates */
+    "customer-subscription-email.schema": {
+      /**
+       * Format: email
+       * @description Email address
+       */
+      email: string;
+      subscriptions: {
+        marketing?: components["schemas"]["subscription-status-marketing.schema"];
+      };
+    };
+    /** @description SMS subscription updates */
+    "customer-subscription-sms.schema": {
+      /** @description Phone number in E.164 format (e.g., +12345678900) */
+      phoneNumber: string;
+      subscriptions: {
+        marketing?: components["schemas"]["subscription-status-marketing.schema"];
+        transactional?: components["schemas"]["subscription-status-transactional.schema"];
+      };
+    };
+    /** @description Customer subscription update response */
+    "customer-subscription-update-response.schema": {
+      /** @description Human-readable success message */
+      message: string;
+      /** @description Whether the operation was successful */
+      success: boolean;
+      /** @description Details of which subscriptions were updated */
+      updatedSubscriptions: {
+        email?: {
+          /** @description Whether email marketing was updated */
+          marketing?: boolean;
+        };
+        sms?: {
+          /** @description Whether SMS marketing was updated */
+          marketing?: boolean;
+          /** @description Whether SMS transactional was updated */
+          transactional?: boolean;
+        };
+      };
+    };
     /**
      * Problem details
      * @description Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
@@ -1145,6 +1192,37 @@ export interface components {
       urlWithParams?: string;
       [key: string]: unknown;
     };
+    /** @description Marketing subscription status */
+    "subscription-status-marketing.schema": {
+      /**
+       * @description Subscription status
+       * @enum {string}
+       */
+      subscriptionStatus: "subscribed" | "confirmed" | "unsubscribed";
+      /**
+       * @description Whether to trigger automations for this subscription change. Defaults to false.
+       * @default false
+       */
+      triggerAutomations?: boolean;
+      /**
+       * Format: date-time
+       * @description ISO 8601 timestamp. If not provided, defaults to now.
+       */
+      updatedAt?: string;
+    };
+    /** @description Transactional subscription status (order tracking) */
+    "subscription-status-transactional.schema": {
+      /**
+       * @description Subscription status. Only subscribed and unsubscribed are supported for transactional.
+       * @enum {string}
+       */
+      subscriptionStatus: "subscribed" | "unsubscribed";
+      /**
+       * Format: date-time
+       * @description ISO 8601 timestamp. If not provided, defaults to now.
+       */
+      updatedAt?: string;
+    };
     /**
      * Webhook create
      * @description Webhook create.
@@ -1279,10 +1357,14 @@ export interface components {
      * @example 20
      */
     "page-size.param"?: number;
+    /** @description Provider specific order name */
+    "provider-order-name"?: string;
     /** @description Return ID */
     "return-id.param": string;
     /** @description Shipment ID */
     "shipment-id.param": string;
+    /** @description Shopify specific order name */
+    "shopify-order-name"?: string;
     /** @description Store ID */
     "store-id.param": string;
     /**
@@ -1734,6 +1816,51 @@ export interface operations {
       };
     };
   };
+  /**
+   * Update customer subscriptions
+   * @description Update customer subscription status for SMS and email marketing and transactional messages.
+   */
+  updateCustomerSubscriptions: {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          email?: components["schemas"]["customer-subscription-email.schema"];
+          sms?: components["schemas"]["customer-subscription-sms.schema"];
+        };
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["customer-subscription-update-response.schema"];
+        };
+      };
+      /** @description Bad Request */
+      400: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Internal Server Error */
+      500: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Get invoice
    * @description Get a list of invoices.
@@ -1770,6 +1897,8 @@ export interface operations {
       query?: {
         updated_at_max?: components["parameters"]["updated-at-max.param"];
         updated_at_min?: components["parameters"]["updated-at-min.param"];
+        shopify_order_name?: components["parameters"]["shopify-order-name"];
+        provider_order_name?: components["parameters"]["provider-order-name"];
       };
       header?: {
         "X-Page-Continue"?: components["parameters"]["page-continue.param"];

package/lib/openapi.yaml

@@ -36,6 +36,13 @@ components:
         maximum: 500
         minimum: 1
         type: integer
+    provider-order-name:
+      description: Provider specific order name
+      in: query
+      name: provider_order_name
+      schema:
+        example: XYZ1025
+        type: string
     return-id.param:
       description: Return ID
       in: path
@@ -52,6 +59,13 @@ components:
       schema:
         example: 67c7e87a2c8c262c0ddc9861
         type: string
+    shopify-order-name:
+      description: Shopify specific order name
+      in: query
+      name: shopify_order_name
+      schema:
+        example: XYZ1025
+        type: string
     store-id.param:
       description: Store ID
       in: path
@@ -203,6 +217,72 @@ components:
         - price
       title: Coverage product
       type: object
+    customer-subscription-email.schema:
+      description: Email subscription updates
+      properties:
+        email:
+          description: Email address
+          format: email
+          type: string
+        subscriptions:
+          properties:
+            marketing:
+              $ref: '#/components/schemas/subscription-status-marketing.schema'
+          type: object
+      required:
+        - email
+        - subscriptions
+      type: object
+    customer-subscription-sms.schema:
+      description: SMS subscription updates
+      properties:
+        phoneNumber:
+          description: Phone number in E.164 format (e.g., +12345678900)
+          type: string
+        subscriptions:
+          properties:
+            marketing:
+              $ref: '#/components/schemas/subscription-status-marketing.schema'
+            transactional:
+              $ref: '#/components/schemas/subscription-status-transactional.schema'
+          type: object
+      required:
+        - phoneNumber
+        - subscriptions
+      type: object
+    customer-subscription-update-response.schema:
+      description: Customer subscription update response
+      properties:
+        message:
+          description: Human-readable success message
+          type: string
+        success:
+          description: Whether the operation was successful
+          type: boolean
+        updatedSubscriptions:
+          description: Details of which subscriptions were updated
+          properties:
+            email:
+              properties:
+                marketing:
+                  description: Whether email marketing was updated
+                  type: boolean
+              type: object
+            sms:
+              properties:
+                marketing:
+                  description: Whether SMS marketing was updated
+                  type: boolean
+                transactional:
+                  description: Whether SMS transactional was updated
+                  type: boolean
+              type: object
+          type: object
+      required:
+        - success
+        - message
+        - updatedSubscriptions
+      type: object
     error.schema:
       description: Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
       properties:
@@ -1297,6 +1377,43 @@ components:
         - source
       title: Storefront Event
       type: object
+    subscription-status-marketing.schema:
+      description: Marketing subscription status
+      properties:
+        subscriptionStatus:
+          description: Subscription status
+          enum:
+            - subscribed
+            - confirmed
+            - unsubscribed
+          type: string
+        triggerAutomations:
+          default: false
+          description: Whether to trigger automations for this subscription change. Defaults to false.
+          type: boolean
+        updatedAt:
+          description: ISO 8601 timestamp. If not provided, defaults to now.
+          format: date-time
+          type: string
+      required:
+        - subscriptionStatus
+      type: object
+    subscription-status-transactional.schema:
+      description: Transactional subscription status (order tracking)
+      properties:
+        subscriptionStatus:
+          description: Subscription status. Only subscribed and unsubscribed are supported for transactional.
+          enum:
+            - subscribed
+            - unsubscribed
+          type: string
+        updatedAt:
+          description: ISO 8601 timestamp. If not provided, defaults to now.
+          format: date-time
+          type: string
+      required:
+        - subscriptionStatus
+      type: object
     webhook-create.schema:
       description: Webhook create.
       properties:
@@ -1921,6 +2038,55 @@ paths:
       tags:
         - Customer portal
     summary: Customer portal
+  /stores/{storeId}/customer-subscriptions:
+    description: Update customer subscription preferences for marketing and transactional messages.
+    patch:
+      description: Update customer subscription status for SMS and email marketing and transactional messages.
+      operationId: updateCustomerSubscriptions
+      parameters:
+        - $ref: '#/components/parameters/store-id.param'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                email:
+                  $ref: '#/components/schemas/customer-subscription-email.schema'
+                sms:
+                  $ref: '#/components/schemas/customer-subscription-sms.schema'
+              type: object
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/customer-subscription-update-response.schema'
+          description: Success
+        '400':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Bad Request
+        '500':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Internal Server Error
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Update customer subscriptions
+      tags:
+        - Customer Subscriptions
+    summary: Customer subscriptions
   /stores/{storeId}/invoices:
     description: Return a list of invoices.
     get:
@@ -1964,6 +2130,8 @@ paths:
         - $ref: '#/components/parameters/page-size.param'
         - $ref: '#/components/parameters/updated-at-max.param'
         - $ref: '#/components/parameters/updated-at-min.param'
+        - $ref: '#/components/parameters/shopify-order-name'
+        - $ref: '#/components/parameters/provider-order-name'
       responses:
         '200':
           content:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.187"
+  "version": "2.2.192"
 }