@redotech/redo-api-schema 2.2.144 → 2.2.146

package/lib/openapi.d.ts

@@ -957,40 +957,64 @@ export interface components {
      * Storefront Event
      * @description Shopify pixel event for storefront tracking.
      */
-    "storefront-event.schema": {
-      /** @description Cart information if relevant to the event. */
-      cart?: components["schemas"]["storefront-cart.schema"];
-      /** @description Identifier for the client that generated the event. */
-      clientId: string;
+    "storefront-event.schema": ({
+      /** @description Anonymous identifier for users without account. */
+      anonymousId?: string;
+      /** @description Cart information. */
+      cart?: Record<string, never> | null;
+      /** @description Information about specific cart line item. */
+      cartLine?: Record<string, never>;
+      /** @description Checkout information. */
+      checkout?: Record<string, never>;
+      /** @description Collection information. */
+      collection?: Record<string, never>;
       /** @description Customer information if available. */
-      customer?: components["schemas"]["storefront-customer.schema"];
-      /** @description Shopify customer ID if available. */
-      customerId?: string;
+      customer?: Record<string, never> | null;
+      /**
+       * Format: email
+       * @description Customer email if available.
+       */
+      customerEmail?: string;
+      /** @description Customer phone if available. */
+      customerPhone?: string;
       /** @description Unique identifier for the event. */
-      eventId: string;
+      eventId?: string;
       /**
-       * @description Name of the Shopify pixel event (e.g., 'product_viewed', 'checkout_started').
+       * @description Name of the Shopify pixel event.
        * @enum {string}
        */
-      eventName: "product_viewed" | "product_added" | "checkout_started" | "checkout_completed" | "page_viewed";
-      /** @description Additional context information. */
-      metadata?: {
-        [key: string]: unknown;
-      };
-      /** @description Product ID if event is related to a specific product. */
-      productId?: string;
-      /** @description Whether the Redo protection was selected in the UI. */
-      redoSelected?: boolean;
-      /** @description The Shopify shop domain. */
-      shopDomain: string;
+      eventName?: "product_added_to_cart" | "product_removed_from_cart" | "product_viewed" | "checkout_started" | "checkout_completed" | "checkout_contact_info_submitted" | "page_viewed" | "collection_viewed";
+      /** @description Product variant information. */
+      productVariant?: Record<string, never>;
       /**
        * Format: date-time
        * @description ISO 8601 timestamp when the event occurred.
        */
-      timestamp: string;
-      /** @description Variant ID if event is related to a specific product variant. */
-      variantId?: string;
-    };
+      timestamp?: string;
+      /** @description Page URL without query parameters. */
+      urlWithoutParams?: string;
+      /** @description Complete page URL with query parameters. */
+      urlWithParams?: string;
+      [key: string]: unknown;
+    }) & ({
+      /** @enum {unknown} */
+      eventName?: "product_added_to_cart";
+    } | {
+      /** @enum {unknown} */
+      eventName?: "product_removed_from_cart";
+    } | {
+      /** @enum {unknown} */
+      eventName?: "product_viewed";
+    } | ({
+      /** @enum {unknown} */
+      eventName?: "checkout_started" | "checkout_completed" | "checkout_contact_info_submitted";
+    }) | {
+      /** @enum {unknown} */
+      eventName?: "page_viewed";
+    } | {
+      /** @enum {unknown} */
+      eventName?: "collection_viewed";
+    });
     /**
      * Webhook create
      * @description Webhook create.

package/lib/openapi.yaml

@@ -1045,59 +1045,115 @@ components:
       title: Storefront Customer
       type: object
     storefront-event.schema:
-      additionalProperties: false
+      additionalProperties: true
+      allOf:
+        - required:
+            - eventName
+            - eventId
+            - timestamp
+        - oneOf:
+            - required:
+                - customer
+            - required:
+                - anonymousId
       description: Shopify pixel event for storefront tracking.
+      oneOf:
+        - properties:
+            eventName:
+              enum:
+                - product_added_to_cart
+          required:
+            - cartLine
+            - cart
+        - properties:
+            eventName:
+              enum:
+                - product_removed_from_cart
+          required:
+            - cartLine
+            - cart
+        - properties:
+            eventName:
+              enum:
+                - product_viewed
+          required:
+            - productVariant
+        - properties:
+            eventName:
+              enum:
+                - checkout_started
+                - checkout_completed
+                - checkout_contact_info_submitted
+          required:
+            - checkout
+        - properties:
+            eventName:
+              enum:
+                - page_viewed
+        - properties:
+            eventName:
+              enum:
+                - collection_viewed
+          required:
+            - collection
       properties:
-        cart:
-          $ref: '#/components/schemas/storefront-cart.schema'
-          description: Cart information if relevant to the event.
-        clientId:
-          description: Identifier for the client that generated the event.
+        anonymousId:
+          description: Anonymous identifier for users without account.
           type: string
+        cart:
+          description: Cart information.
+          type:
+            - object
+            - 'null'
+        cartLine:
+          description: Information about specific cart line item.
+          type: object
+        checkout:
+          description: Checkout information.
+          type: object
+        collection:
+          description: Collection information.
+          type: object
         customer:
-          $ref: '#/components/schemas/storefront-customer.schema'
           description: Customer information if available.
-        customerId:
-          description: Shopify customer ID if available.
+          type:
+            - object
+            - 'null'
+        customerEmail:
+          description: Customer email if available.
+          format: email
+          type: string
+        customerPhone:
+          description: Customer phone if available.
           type: string
         eventId:
           description: Unique identifier for the event.
           type: string
         eventName:
-          description: Name of the Shopify pixel event (e.g., 'product_viewed', 'checkout_started').
+          description: Name of the Shopify pixel event.
           enum:
+            - product_added_to_cart
+            - product_removed_from_cart
             - product_viewed
-            - product_added
             - checkout_started
             - checkout_completed
+            - checkout_contact_info_submitted
             - page_viewed
+            - collection_viewed
           type: string
-        metadata:
-          additionalProperties: true
-          description: Additional context information.
+        productVariant:
+          description: Product variant information.
           type: object
-        productId:
-          description: Product ID if event is related to a specific product.
-          type: string
-        redoSelected:
-          description: Whether the Redo protection was selected in the UI.
-          type: boolean
-        shopDomain:
-          description: The Shopify shop domain.
-          type: string
         timestamp:
           description: ISO 8601 timestamp when the event occurred.
           format: date-time
           type: string
-        variantId:
-          description: Variant ID if event is related to a specific product variant.
+        urlWithParams:
+          description: Complete page URL with query parameters.
+          type: string
+        urlWithoutParams:
+          description: Page URL without query parameters.
           type: string
-      required:
-        - eventName
-        - eventId
-        - timestamp
-        - clientId
-        - shopDomain
       title: Storefront Event
       type: object
     webhook-create.schema:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.144"
+  "version": "2.2.146"
 }