@blezgo/api-sdk 0.1.3 → 0.1.4

package/dist/channel/generated.d.ts

@@ -1355,6 +1355,28 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /**
+         * CapabilityCheckRequest
+         * @description Check channel capability for a recipient.
+         */
+        CapabilityCheckRequest: {
+            /**
+             * Channel
+             * @description Channel to check: sms, email, whatsapp
+             */
+            channel: string;
+            /**
+             * Recipient
+             * @description Phone (E.164) or email address
+             */
+            recipient: string;
+            /**
+             * Purpose
+             * @description Purpose: otp, marketing, transactional
+             * @default otp
+             */
+            purpose: string;
+        };
         /**
          * QuotaSettingsUpdateRequest
          * @description Request schema for updating quota settings (auto-recharge, daily caps).
@@ -1392,28 +1414,156 @@ export interface components {
              */
             daily_quota_cap?: number | null;
         };
+        InvalidParam: {
+            /** @example items[0].quantity */
+            field?: string;
+            /** @example Input should be greater than or equal to 1 */
+            error?: string;
+        };
         /**
-         * QuotaUpdateRequest
-         * @description Request schema for admin quota adjustments (add/subtract quota manually).
+         * @example {
+         *       "status": "success",
+         *       "message": "Operation successful",
+         *       "message_code": "api_suc_20001",
+         *       "data": {},
+         *       "metadata": {
+         *         "timestamp": "2026-03-26T10:00:00.000Z",
+         *         "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
+         *         "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
+         *         "version": "v1",
+         *         "executionTime": 42,
+         *         "language": "en-US"
+         *       }
+         *     }
+         */
+        StandardResponse: {
+            /** @example success */
+            status?: string;
+            data?: Record<string, never> | null;
+            /** @example Operation successful */
+            message?: string | null;
+            /** @example api_suc_20001 */
+            message_code?: string | null;
+            metadata?: Record<string, never> | null;
+            error?: components["schemas"]["ErrorResponse"];
+        };
+        /**
+         * RoutingRuleUpdateRequest
+         * @description Update an existing routing rule.
+         */
+        RoutingRuleUpdateRequest: {
+            /** Primary Channel */
+            primary_channel?: string | null;
+            /** Fallback Channel */
+            fallback_channel?: string | null;
+            /** Sms Credential Id */
+            sms_credential_id?: string | null;
+            /** Whatsapp Credential Id */
+            whatsapp_credential_id?: string | null;
+            /** Email Credential Id */
+            email_credential_id?: string | null;
+            /** Sms Enabled */
+            sms_enabled?: boolean | null;
+            /** Sms Requires Dlt */
+            sms_requires_dlt?: boolean | null;
+            /** Sms Requires Sender Id */
+            sms_requires_sender_id?: boolean | null;
+            /** Whatsapp Enabled */
+            whatsapp_enabled?: boolean | null;
+            /** Email Enabled */
+            email_enabled?: boolean | null;
+            /** Sms Daily Limit */
+            sms_daily_limit?: number | null;
+            /** Sms Hourly Limit */
+            sms_hourly_limit?: number | null;
+            /** Is Active */
+            is_active?: boolean | null;
+        };
+        /**
+         * DLTRegistrationCreateRequest
+         * @description Create a new DLT registration (India compliance).
+         */
+        DLTRegistrationCreateRequest: {
+            /**
+             * Credential Id
+             * @description External ID of SMS credential
+             */
+            credential_id: string;
+            /**
+             * Entity Id
+             * @description DLT Entity ID from provider
+             */
+            entity_id: string;
+            /**
+             * Sender Id
+             * @description 6-char alphanumeric sender ID
+             */
+            sender_id: string;
+            /**
+             * Template Id
+             * @description Pre-registered template ID
+             */
+            template_id?: string | null;
+            /**
+             * Template Name
+             * @description Human-friendly template name
+             */
+            template_name?: string | null;
+            /**
+             * Template Content
+             * @description Template with {#var#} placeholders
+             */
+            template_content?: string | null;
+            /**
+             * Template Type
+             * @description transactional, promotional, service
+             * @default transactional
+             */
+            template_type: string;
+        };
+        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;
+        };
+        /**
+         * ChannelType
+         * @description Channel types for quota.
+         * @enum {string}
+         */
+        ChannelType: "sms" | "whatsapp";
+        /**
+         * QuotaRefundRequest
+         * @description Request schema for refunding quota.
          *
          *     Example:
          *         {
          *             "channel_type": "sms",
-         *             "amount": 5000,
-         *             "notes": "Bonus quota for premium customer"
+         *             "amount": 1000,
+         *             "refund_reference_id": "refund_abc123",
+         *             "notes": "Refund for unused quota"
          *         }
          */
-        QuotaUpdateRequest: {
+        QuotaRefundRequest: {
             /** @description Channel type (sms or whatsapp) */
             channel_type: components["schemas"]["ChannelType"];
             /**
              * Amount
-             * @description Quota amount (positive to add, negative to subtract)
+             * @description Quota amount to refund
              */
             amount: number;
+            /**
+             * Refund Reference Id
+             * @description Refund reference ID
+             */
+            refund_reference_id?: string | null;
             /**
              * Notes
-             * @description Reason for adjustment
+             * @description Refund reason
              */
             notes?: string | null;
         };
@@ -1443,88 +1593,25 @@ export interface components {
             is_default?: boolean | null;
         };
         /**
-         * @example {
-         *       "status": "success",
-         *       "message": "Operation successful",
-         *       "message_code": "api_suc_20001",
-         *       "data": {},
-         *       "metadata": {
-         *         "timestamp": "2026-03-26T10:00:00.000Z",
-         *         "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
-         *         "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
-         *         "version": "v1",
-         *         "executionTime": 42,
-         *         "language": "en-US"
-         *       }
-         *     }
-         */
-        StandardResponse: {
-            /** @example success */
-            status?: string;
-            data?: Record<string, never> | null;
-            /** @example Operation successful */
-            message?: string | null;
-            /** @example api_suc_20001 */
-            message_code?: string | null;
-            metadata?: Record<string, never> | null;
-            error?: components["schemas"]["ErrorResponse"];
-        };
-        /**
-         * CredentialCreateRequest
-         * @description Request schema for creating a new channel credential.
-         *
-         *     Example (SMTP):
-         *         {
-         *             "provider_code": "smtp",
-         *             "display_name": "Marketing SMTP",
-         *             "credentials": {
-         *                 "host": "smtp.gmail.com",
-         *                 "port": 587,
-         *                 "user": "marketing@example.com",
-         *                 "password": "app_password_here",
-         *                 "from_email": "marketing@example.com",
-         *                 "from_name": "Marketing Team",
-         *                 "use_tls": true
-         *             },
-         *             "is_default": true
-         *         }
-         *
-         *     Example (Twilio SMS):
-         *         {
-         *             "provider_code": "twilio_sms",
-         *             "display_name": "Main Twilio Account",
-         *             "credentials": {
-         *                 "account_sid": "AC1234567890abcdef1234567890abcdef",
-         *                 "auth_token": "your_auth_token_here",
-         *                 "from_number": "+15551234567"
-         *             },
-         *             "is_default": false
-         *         }
+         * DLTRegistrationUpdateRequest
+         * @description Update DLT registration.
          */
-        CredentialCreateRequest: {
-            /**
-             * Provider Code
-             * @description Provider code (smtp, ses_email_identity, twilio_sms, etc.)
-             */
-            provider_code: string;
-            /**
-             * Display Name
-             * @description User-friendly name (e.g., 'Marketing SMTP')
-             */
-            display_name?: string | null;
-            /**
-             * Credentials
-             * @description Provider-specific credentials (will be encrypted)
-             */
-            credentials: {
-                [key: string]: unknown;
-            };
+        DLTRegistrationUpdateRequest: {
+            /** Template Id */
+            template_id?: string | null;
+            /** Template Name */
+            template_name?: string | null;
+            /** Template Content */
+            template_content?: string | null;
+            /** Template Type */
+            template_type?: string | null;
             /**
-             * Is Default
-             * @description Set as default credential for this channel type
-             * @default false
+             * Registration Status
+             * @description pending, approved, rejected, expired
              */
-            is_default: boolean;
+            registration_status?: string | null;
+            /** Is Active */
+            is_active?: boolean | null;
         };
         /**
          * RoutingRuleCreateRequest
@@ -1605,188 +1692,86 @@ export interface components {
             sms_hourly_limit: number;
         };
         /**
-         * DLTRegistrationUpdateRequest
-         * @description Update DLT registration.
-         */
-        DLTRegistrationUpdateRequest: {
-            /** Template Id */
-            template_id?: string | null;
-            /** Template Name */
-            template_name?: string | null;
-            /** Template Content */
-            template_content?: string | null;
-            /** Template Type */
-            template_type?: string | null;
-            /**
-             * Registration Status
-             * @description pending, approved, rejected, expired
-             */
-            registration_status?: string | null;
-            /** Is Active */
-            is_active?: boolean | null;
-        };
-        /**
-         * DLTRegistrationCreateRequest
-         * @description Create a new DLT registration (India compliance).
-         */
-        DLTRegistrationCreateRequest: {
-            /**
-             * Credential Id
-             * @description External ID of SMS credential
-             */
-            credential_id: string;
-            /**
-             * Entity Id
-             * @description DLT Entity ID from provider
-             */
-            entity_id: string;
-            /**
-             * Sender Id
-             * @description 6-char alphanumeric sender ID
-             */
-            sender_id: string;
-            /**
-             * Template Id
-             * @description Pre-registered template ID
-             */
-            template_id?: string | null;
-            /**
-             * Template Name
-             * @description Human-friendly template name
-             */
-            template_name?: string | null;
-            /**
-             * Template Content
-             * @description Template with {#var#} placeholders
-             */
-            template_content?: string | null;
-            /**
-             * Template Type
-             * @description transactional, promotional, service
-             * @default transactional
-             */
-            template_type: string;
-        };
-        /**
-         * CapabilityCheckRequest
-         * @description Check channel capability for a recipient.
-         */
-        CapabilityCheckRequest: {
-            /**
-             * Channel
-             * @description Channel to check: sms, email, whatsapp
-             */
-            channel: string;
-            /**
-             * Recipient
-             * @description Phone (E.164) or email address
-             */
-            recipient: string;
-            /**
-             * Purpose
-             * @description Purpose: otp, marketing, transactional
-             * @default otp
-             */
-            purpose: string;
-        };
-        /**
-         * ChannelType
-         * @description Channel types for quota.
-         * @enum {string}
-         */
-        ChannelType: "sms" | "whatsapp";
-        /**
-         * RoutingRuleUpdateRequest
-         * @description Update an existing routing rule.
-         */
-        RoutingRuleUpdateRequest: {
-            /** Primary Channel */
-            primary_channel?: string | null;
-            /** Fallback Channel */
-            fallback_channel?: string | null;
-            /** Sms Credential Id */
-            sms_credential_id?: string | null;
-            /** Whatsapp Credential Id */
-            whatsapp_credential_id?: string | null;
-            /** Email Credential Id */
-            email_credential_id?: string | null;
-            /** Sms Enabled */
-            sms_enabled?: boolean | null;
-            /** Sms Requires Dlt */
-            sms_requires_dlt?: boolean | null;
-            /** Sms Requires Sender Id */
-            sms_requires_sender_id?: boolean | null;
-            /** Whatsapp Enabled */
-            whatsapp_enabled?: boolean | null;
-            /** Email Enabled */
-            email_enabled?: boolean | null;
-            /** Sms Daily Limit */
-            sms_daily_limit?: number | null;
-            /** Sms Hourly Limit */
-            sms_hourly_limit?: number | null;
-            /** Is Active */
-            is_active?: boolean | null;
-        };
-        InvalidParam: {
-            /** @example items[0].quantity */
-            field?: string;
-            /** @example Input should be greater than or equal to 1 */
-            error?: string;
-        };
-        /**
-         * QuotaRefundRequest
-         * @description Request schema for refunding quota.
+         * QuotaUpdateRequest
+         * @description Request schema for admin quota adjustments (add/subtract quota manually).
          *
          *     Example:
          *         {
          *             "channel_type": "sms",
-         *             "amount": 1000,
-         *             "refund_reference_id": "refund_abc123",
-         *             "notes": "Refund for unused quota"
+         *             "amount": 5000,
+         *             "notes": "Bonus quota for premium customer"
          *         }
          */
-        QuotaRefundRequest: {
+        QuotaUpdateRequest: {
             /** @description Channel type (sms or whatsapp) */
             channel_type: components["schemas"]["ChannelType"];
             /**
              * Amount
-             * @description Quota amount to refund
+             * @description Quota amount (positive to add, negative to subtract)
              */
             amount: number;
-            /**
-             * Refund Reference Id
-             * @description Refund reference ID
-             */
-            refund_reference_id?: string | null;
             /**
              * Notes
-             * @description Refund reason
+             * @description Reason for adjustment
              */
             notes?: 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;
-        };
-        ErrorResponse: {
-            /** @example about:blank */
-            type?: string;
-            /** @example GENERIC_ERROR */
-            code?: string;
-            /** @example Client Error */
-            title?: string;
-            /** @example 400 */
-            status?: number;
-            /** @example An error occurred */
-            detail?: string;
-            /** @example /v1/cart/items */
-            instance?: string;
-            extensions?: components["schemas"]["Extensions"];
+        /**
+         * CredentialCreateRequest
+         * @description Request schema for creating a new channel credential.
+         *
+         *     Example (SMTP):
+         *         {
+         *             "provider_code": "smtp",
+         *             "display_name": "Marketing SMTP",
+         *             "credentials": {
+         *                 "host": "smtp.gmail.com",
+         *                 "port": 587,
+         *                 "user": "marketing@example.com",
+         *                 "password": "app_password_here",
+         *                 "from_email": "marketing@example.com",
+         *                 "from_name": "Marketing Team",
+         *                 "use_tls": true
+         *             },
+         *             "is_default": true
+         *         }
+         *
+         *     Example (Twilio SMS):
+         *         {
+         *             "provider_code": "twilio_sms",
+         *             "display_name": "Main Twilio Account",
+         *             "credentials": {
+         *                 "account_sid": "AC1234567890abcdef1234567890abcdef",
+         *                 "auth_token": "your_auth_token_here",
+         *                 "from_number": "+15551234567"
+         *             },
+         *             "is_default": false
+         *         }
+         */
+        CredentialCreateRequest: {
+            /**
+             * Provider Code
+             * @description Provider code (smtp, ses_email_identity, twilio_sms, etc.)
+             */
+            provider_code: string;
+            /**
+             * Display Name
+             * @description User-friendly name (e.g., 'Marketing SMTP')
+             */
+            display_name?: string | null;
+            /**
+             * Credentials
+             * @description Provider-specific credentials (will be encrypted)
+             */
+            credentials: {
+                [key: string]: unknown;
+            };
+            /**
+             * Is Default
+             * @description Set as default credential for this channel type
+             * @default false
+             */
+            is_default: boolean;
         };
         /**
          * QuotaPurchaseRequest
@@ -1821,6 +1806,21 @@ export interface components {
              */
             idempotency_key: string;
         };
+        ErrorResponse: {
+            /** @example about:blank */
+            type?: string;
+            /** @example GENERIC_ERROR */
+            code?: string;
+            /** @example Client Error */
+            title?: string;
+            /** @example 400 */
+            status?: number;
+            /** @example An error occurred */
+            detail?: string;
+            /** @example /v1/cart/items */
+            instance?: string;
+            extensions?: components["schemas"]["Extensions"];
+        };
     };
     responses: never;
     parameters: never;