@blezgo/api-sdk 0.1.3 → 0.1.4

package/dist/campaigns/generated.d.ts

@@ -1204,6 +1204,106 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /**
+         * CampaignCreateRequest
+         * @description Request to create a new campaign.
+         */
+        CampaignCreateRequest: {
+            /**
+             * Name
+             * @description Campaign name (unique per org/company)
+             */
+            name: string;
+            /**
+             * Description
+             * @description Campaign description
+             */
+            description?: string | null;
+            /**
+             * Campaign Type
+             * @description Campaign type
+             */
+            campaign_type: string;
+            /**
+             * Starts At
+             * Format: date-time
+             * @description Campaign start datetime (UTC)
+             */
+            starts_at: string;
+            /**
+             * Ends At
+             * @description Campaign end datetime (UTC), null = no end
+             */
+            ends_at?: string | null;
+            /**
+             * Priority
+             * @description Campaign priority (0-100, higher = higher priority)
+             * @default 0
+             */
+            priority: number;
+            /**
+             * Budget Amount
+             * @description Total budget limit
+             */
+            budget_amount?: number | null;
+            /**
+             * Currency
+             * @description Currency code (ISO 4217)
+             * @default USD
+             */
+            currency: string;
+            /** @description Discount configuration (required for discount campaigns) */
+            discount?: components["schemas"]["CampaignDiscountRequest"] | null;
+            /**
+             * Targeting
+             * @description Targeting rules
+             */
+            targeting?: components["schemas"]["CampaignTargetingRequest"][] | null;
+        };
+        /**
+         * CampaignValidateRequest
+         * @description Advisory validation request - no side effects.
+         *
+         *     Used to check if a campaign would apply to a cart.
+         */
+        CampaignValidateRequest: {
+            /**
+             * Campaign Id
+             * @description Campaign external_id (camp_xxx)
+             */
+            campaign_id?: string | null;
+            /**
+             * Utm Campaign
+             * @description UTM campaign parameter for lookup
+             */
+            utm_campaign?: string | null;
+            /**
+             * Cart Total
+             * @description Cart total amount
+             */
+            cart_total: number;
+            /**
+             * Cart Currency
+             * @description Cart currency
+             * @default USD
+             */
+            cart_currency: string;
+            /**
+             * Product Ids
+             * @description Product IDs in cart
+             */
+            product_ids?: number[] | null;
+            /**
+             * Category Ids
+             * @description Category IDs of products in cart
+             */
+            category_ids?: number[] | null;
+            /**
+             * User Id
+             * @description User ID for per-user limit check
+             */
+            user_id?: number | null;
+        };
         /**
          * CampaignUpdateRequest
          * @description Request to update a campaign.
@@ -1243,10 +1343,10 @@ export interface components {
             targeting?: components["schemas"]["CampaignTargetingRequest"][] | null;
         };
         /**
-         * BulkArchiveRequest
-         * @description Request to bulk archive campaigns.
+         * BulkPauseRequest
+         * @description Request to bulk pause campaigns.
          */
-        BulkArchiveRequest: {
+        BulkPauseRequest: {
             /**
              * Campaign Ids
              * @description List of campaign external_ids
@@ -1259,25 +1359,31 @@ export interface components {
             reason?: string | null;
         };
         /**
-         * CampaignPreviewRequest
-         * @description Request to preview campaign targeting/discount for an existing campaign.
+         * CampaignTargetingRequest
+         * @description Targeting rule configuration.
          */
-        CampaignPreviewRequest: {
+        CampaignTargetingRequest: {
             /**
-             * Campaign Id
-             * @description Campaign external_id to preview
+             * Target Type
+             * @description Type of target: user_segment, product, category, bundle
              */
-            campaign_id: string;
+            target_type: string;
             /**
-             * Test User Id
-             * @description User ID to test targeting against
+             * Target Ids
+             * @description List of target IDs
              */
-            test_user_id?: number | null;
+            target_ids: number[];
             /**
-             * Test Context
-             * @description Test context (products, cart_amount, category_ids, etc.)
+             * Include Exclude
+             * @description Include or exclude these targets
+             * @default include
              */
-            test_context?: {
+            include_exclude: string;
+            /**
+             * Conditions
+             * @description Additional targeting conditions
+             */
+            conditions?: {
                 [key: string]: unknown;
             } | null;
         };
@@ -1312,60 +1418,11 @@ export interface components {
              */
             utm_medium?: string | null;
         };
-        /**
-         * BulkPauseRequest
-         * @description Request to bulk pause campaigns.
-         */
-        BulkPauseRequest: {
-            /**
-             * Campaign Ids
-             * @description List of campaign external_ids
-             */
-            campaign_ids: string[];
-            /**
-             * Reason
-             * @description Reason for bulk operation
-             */
-            reason?: string | null;
-        };
-        /**
-         * CampaignApplyRequest
-         * @description Apply campaign discount request - re-validates server-side.
-         *
-         *     Never trust prior /validate response.
-         */
-        CampaignApplyRequest: {
-            /**
-             * Campaign Id
-             * @description Campaign external_id (camp_xxx)
-             */
-            campaign_id: string;
-            /**
-             * Cart Id
-             * @description Cart external_id
-             */
-            cart_id: string;
-            /**
-             * Cart Total
-             * @description Current cart total
-             */
-            cart_total: number;
-            /**
-             * Cart Currency
-             * @description Cart currency
-             * @default USD
-             */
-            cart_currency: string;
-            /**
-             * Product Ids
-             * @description Product IDs in cart
-             */
-            product_ids: number[];
-            /**
-             * Category Ids
-             * @description Category IDs of products in cart
-             */
-            category_ids?: number[] | null;
+        InvalidParam: {
+            /** @example items[0].quantity */
+            field?: string;
+            /** @example Input should be greater than or equal to 1 */
+            error?: string;
         };
         /**
          * @example {
@@ -1395,116 +1452,114 @@ export interface components {
             error?: components["schemas"]["ErrorResponse"];
         };
         /**
-         * CampaignCreateRequest
-         * @description Request to create a new campaign.
+         * BulkArchiveRequest
+         * @description Request to bulk archive campaigns.
          */
-        CampaignCreateRequest: {
-            /**
-             * Name
-             * @description Campaign name (unique per org/company)
-             */
-            name: string;
+        BulkArchiveRequest: {
             /**
-             * Description
-             * @description Campaign description
+             * Campaign Ids
+             * @description List of campaign external_ids
              */
-            description?: string | null;
+            campaign_ids: string[];
             /**
-             * Campaign Type
-             * @description Campaign type
+             * Reason
+             * @description Reason for bulk operation
              */
-            campaign_type: string;
+            reason?: string | null;
+        };
+        Extensions: {
+            /** @example GENERIC_ERROR */
+            message_code?: string;
+            /** @example [] */
+            invalid_params?: components["schemas"]["InvalidParam"][];
+            extra_data?: Record<string, never> | null;
+            /** @example Detailed debug information */
+            debug?: string | null;
+        };
+        /**
+         * CampaignPreviewRequest
+         * @description Request to preview campaign targeting/discount for an existing campaign.
+         */
+        CampaignPreviewRequest: {
             /**
-             * Starts At
-             * Format: date-time
-             * @description Campaign start datetime (UTC)
+             * Campaign Id
+             * @description Campaign external_id to preview
              */
-            starts_at: string;
+            campaign_id: string;
             /**
-             * Ends At
-             * @description Campaign end datetime (UTC), null = no end
+             * Test User Id
+             * @description User ID to test targeting against
              */
-            ends_at?: string | null;
+            test_user_id?: number | null;
             /**
-             * Priority
-             * @description Campaign priority (0-100, higher = higher priority)
-             * @default 0
+             * Test Context
+             * @description Test context (products, cart_amount, category_ids, etc.)
              */
-            priority: number;
+            test_context?: {
+                [key: string]: unknown;
+            } | null;
+        };
+        /**
+         * CampaignDiscountRequest
+         * @description Discount configuration for discount-type campaigns.
+         */
+        CampaignDiscountRequest: {
             /**
-             * Budget Amount
-             * @description Total budget limit
+             * Discount Type
+             * @description Type of discount: percentage or fixed_amount
              */
-            budget_amount?: number | null;
+            discount_type: string;
             /**
-             * Currency
-             * @description Currency code (ISO 4217)
-             * @default USD
+             * Discount Value
+             * @description Discount value (0-100 for percentage, amount for fixed)
              */
-            currency: string;
-            /** @description Discount configuration (required for discount campaigns) */
-            discount?: components["schemas"]["CampaignDiscountRequest"] | null;
+            discount_value: number;
             /**
-             * Targeting
-             * @description Targeting rules
+             * Discount Currency
+             * @description Currency for fixed_amount (required for fixed_amount, null for percentage)
              */
-            targeting?: components["schemas"]["CampaignTargetingRequest"][] | null;
-        };
-        /**
-         * CampaignTargetingRequest
-         * @description Targeting rule configuration.
-         */
-        CampaignTargetingRequest: {
+            discount_currency?: string | null;
             /**
-             * Target Type
-             * @description Type of target: user_segment, product, category, bundle
+             * Max Discount Amount
+             * @description Maximum discount cap for percentage discounts
              */
-            target_type: string;
+            max_discount_amount?: number | null;
             /**
-             * Target Ids
-             * @description List of target IDs
+             * Min Order Value
+             * @description Minimum cart value to apply discount
              */
-            target_ids: number[];
+            min_order_value?: number | null;
             /**
-             * Include Exclude
-             * @description Include or exclude these targets
-             * @default include
+             * Max Redemptions Total
+             * @description Total redemption limit (null = unlimited)
              */
-            include_exclude: string;
+            max_redemptions_total?: number | null;
             /**
-             * Conditions
-             * @description Additional targeting conditions
+             * Max Redemptions Per User
+             * @description Per-user redemption limit (null = unlimited)
              */
-            conditions?: {
-                [key: string]: unknown;
-            } | null;
-        };
-        InvalidParam: {
-            /** @example items[0].quantity */
-            field?: string;
-            /** @example Input should be greater than or equal to 1 */
-            error?: string;
+            max_redemptions_per_user?: number | null;
         };
         /**
-         * CampaignValidateRequest
-         * @description Advisory validation request - no side effects.
+         * CampaignApplyRequest
+         * @description Apply campaign discount request - re-validates server-side.
          *
-         *     Used to check if a campaign would apply to a cart.
+         *     Never trust prior /validate response.
          */
-        CampaignValidateRequest: {
+        CampaignApplyRequest: {
             /**
              * Campaign Id
              * @description Campaign external_id (camp_xxx)
              */
-            campaign_id?: string | null;
+            campaign_id: string;
             /**
-             * Utm Campaign
-             * @description UTM campaign parameter for lookup
+             * Cart Id
+             * @description Cart external_id
              */
-            utm_campaign?: string | null;
+            cart_id: string;
             /**
              * Cart Total
-             * @description Cart total amount
+             * @description Current cart total
              */
             cart_total: number;
             /**
@@ -1517,26 +1572,12 @@ export interface components {
              * Product Ids
              * @description Product IDs in cart
              */
-            product_ids?: number[] | null;
+            product_ids: number[];
             /**
              * Category Ids
              * @description Category IDs of products in cart
              */
             category_ids?: number[] | null;
-            /**
-             * User Id
-             * @description User ID for per-user limit check
-             */
-            user_id?: number | null;
-        };
-        Extensions: {
-            /** @example GENERIC_ERROR */
-            message_code?: string;
-            /** @example [] */
-            invalid_params?: components["schemas"]["InvalidParam"][];
-            extra_data?: Record<string, never> | null;
-            /** @example Detailed debug information */
-            debug?: string | null;
         };
         ErrorResponse: {
             /** @example about:blank */
@@ -1553,47 +1594,6 @@ export interface components {
             instance?: string;
             extensions?: components["schemas"]["Extensions"];
         };
-        /**
-         * CampaignDiscountRequest
-         * @description Discount configuration for discount-type campaigns.
-         */
-        CampaignDiscountRequest: {
-            /**
-             * Discount Type
-             * @description Type of discount: percentage or fixed_amount
-             */
-            discount_type: string;
-            /**
-             * Discount Value
-             * @description Discount value (0-100 for percentage, amount for fixed)
-             */
-            discount_value: number;
-            /**
-             * Discount Currency
-             * @description Currency for fixed_amount (required for fixed_amount, null for percentage)
-             */
-            discount_currency?: string | null;
-            /**
-             * Max Discount Amount
-             * @description Maximum discount cap for percentage discounts
-             */
-            max_discount_amount?: number | null;
-            /**
-             * Min Order Value
-             * @description Minimum cart value to apply discount
-             */
-            min_order_value?: number | null;
-            /**
-             * Max Redemptions Total
-             * @description Total redemption limit (null = unlimited)
-             */
-            max_redemptions_total?: number | null;
-            /**
-             * Max Redemptions Per User
-             * @description Per-user redemption limit (null = unlimited)
-             */
-            max_redemptions_per_user?: number | null;
-        };
     };
     responses: never;
     parameters: never;