zavudev 0.0.2

data/rbi/zavudev/models/broadcast.rbi

@@ -0,0 +1,318 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class Broadcast < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Zavudev::Broadcast, Zavudev::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.
+      sig { returns(Zavudev::BroadcastChannel::TaggedSymbol) }
+      attr_accessor :channel
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Type of message for broadcast.
+      sig { returns(Zavudev::BroadcastMessageType::TaggedSymbol) }
+      attr_accessor :message_type
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Current status of the broadcast.
+      sig { returns(Zavudev::BroadcastStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # Total number of contacts in the broadcast.
+      sig { returns(Integer) }
+      attr_accessor :total_contacts
+
+      # Actual cost so far in USD.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :actual_cost
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :completed_at
+
+      sig { params(completed_at: Time).void }
+      attr_writer :completed_at
+
+      # Content for non-text broadcast message types.
+      sig { returns(T.nilable(Zavudev::BroadcastContent)) }
+      attr_reader :content
+
+      sig { params(content: Zavudev::BroadcastContent::OrHash).void }
+      attr_writer :content
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :delivered_count
+
+      sig { params(delivered_count: Integer).void }
+      attr_writer :delivered_count
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :email_subject
+
+      sig { params(email_subject: String).void }
+      attr_writer :email_subject
+
+      # Estimated total cost in USD.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :estimated_cost
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :failed_count
+
+      sig { params(failed_count: Integer).void }
+      attr_writer :failed_count
+
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :pending_count
+
+      sig { params(pending_count: Integer).void }
+      attr_writer :pending_count
+
+      # Amount reserved from balance in USD.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :reserved_amount
+
+      # Number of review attempts (max 3).
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :review_attempts
+
+      # AI content review result.
+      sig { returns(T.nilable(Zavudev::Broadcast::ReviewResult)) }
+      attr_reader :review_result
+
+      sig do
+        params(
+          review_result: T.nilable(Zavudev::Broadcast::ReviewResult::OrHash)
+        ).void
+      end
+      attr_writer :review_result
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :scheduled_at
+
+      sig { params(scheduled_at: Time).void }
+      attr_writer :scheduled_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :sender_id
+
+      sig { params(sender_id: String).void }
+      attr_writer :sender_id
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :sending_count
+
+      sig { params(sending_count: Integer).void }
+      attr_writer :sending_count
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :started_at
+
+      sig { params(started_at: Time).void }
+      attr_writer :started_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :text
+
+      sig { params(text: String).void }
+      attr_writer :text
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      sig do
+        params(
+          id: String,
+          channel: Zavudev::BroadcastChannel::OrSymbol,
+          created_at: Time,
+          message_type: Zavudev::BroadcastMessageType::OrSymbol,
+          name: String,
+          status: Zavudev::BroadcastStatus::OrSymbol,
+          total_contacts: Integer,
+          actual_cost: T.nilable(Float),
+          completed_at: Time,
+          content: Zavudev::BroadcastContent::OrHash,
+          delivered_count: Integer,
+          email_subject: String,
+          estimated_cost: T.nilable(Float),
+          failed_count: Integer,
+          metadata: T::Hash[Symbol, String],
+          pending_count: Integer,
+          reserved_amount: T.nilable(Float),
+          review_attempts: T.nilable(Integer),
+          review_result: T.nilable(Zavudev::Broadcast::ReviewResult::OrHash),
+          scheduled_at: Time,
+          sender_id: String,
+          sending_count: Integer,
+          started_at: Time,
+          text: String,
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.
+        channel:,
+        created_at:,
+        # Type of message for broadcast.
+        message_type:,
+        name:,
+        # Current status of the broadcast.
+        status:,
+        # Total number of contacts in the broadcast.
+        total_contacts:,
+        # Actual cost so far in USD.
+        actual_cost: nil,
+        completed_at: nil,
+        # Content for non-text broadcast message types.
+        content: nil,
+        delivered_count: nil,
+        email_subject: nil,
+        # Estimated total cost in USD.
+        estimated_cost: nil,
+        failed_count: nil,
+        metadata: nil,
+        pending_count: nil,
+        # Amount reserved from balance in USD.
+        reserved_amount: nil,
+        # Number of review attempts (max 3).
+        review_attempts: nil,
+        # AI content review result.
+        review_result: nil,
+        scheduled_at: nil,
+        sender_id: nil,
+        sending_count: nil,
+        started_at: nil,
+        text: nil,
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            channel: Zavudev::BroadcastChannel::TaggedSymbol,
+            created_at: Time,
+            message_type: Zavudev::BroadcastMessageType::TaggedSymbol,
+            name: String,
+            status: Zavudev::BroadcastStatus::TaggedSymbol,
+            total_contacts: Integer,
+            actual_cost: T.nilable(Float),
+            completed_at: Time,
+            content: Zavudev::BroadcastContent,
+            delivered_count: Integer,
+            email_subject: String,
+            estimated_cost: T.nilable(Float),
+            failed_count: Integer,
+            metadata: T::Hash[Symbol, String],
+            pending_count: Integer,
+            reserved_amount: T.nilable(Float),
+            review_attempts: T.nilable(Integer),
+            review_result: T.nilable(Zavudev::Broadcast::ReviewResult),
+            scheduled_at: Time,
+            sender_id: String,
+            sending_count: Integer,
+            started_at: Time,
+            text: String,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class ReviewResult < Zavudev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Zavudev::Broadcast::ReviewResult, Zavudev::Internal::AnyHash)
+          end
+
+        # Policy categories violated, if any.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :categories
+
+        sig { params(categories: T::Array[String]).void }
+        attr_writer :categories
+
+        # Problematic text fragments, if any.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :flagged_content
+
+        # Explanation of the review decision.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reasoning
+
+        sig { params(reasoning: String).void }
+        attr_writer :reasoning
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :reviewed_at
+
+        sig { params(reviewed_at: Time).void }
+        attr_writer :reviewed_at
+
+        # Content safety score from 0.0 to 1.0, where 1.0 is completely safe.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :score
+
+        sig { params(score: Float).void }
+        attr_writer :score
+
+        # AI content review result.
+        sig do
+          params(
+            categories: T::Array[String],
+            flagged_content: T.nilable(T::Array[String]),
+            reasoning: String,
+            reviewed_at: Time,
+            score: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Policy categories violated, if any.
+          categories: nil,
+          # Problematic text fragments, if any.
+          flagged_content: nil,
+          # Explanation of the review decision.
+          reasoning: nil,
+          reviewed_at: nil,
+          # Content safety score from 0.0 to 1.0, where 1.0 is completely safe.
+          score: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              categories: T::Array[String],
+              flagged_content: T.nilable(T::Array[String]),
+              reasoning: String,
+              reviewed_at: Time,
+              score: Float
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/models/broadcast_cancel_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class BroadcastCancelParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::BroadcastCancelParams, Zavudev::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :broadcast_id
+
+      sig do
+        params(
+          broadcast_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(broadcast_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { broadcast_id: String, request_options: Zavudev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/broadcast_cancel_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class BroadcastCancelResponse < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Zavudev::Models::BroadcastCancelResponse,
+            Zavudev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Zavudev::Broadcast) }
+      attr_reader :broadcast
+
+      sig { params(broadcast: Zavudev::Broadcast::OrHash).void }
+      attr_writer :broadcast
+
+      sig do
+        params(broadcast: Zavudev::Broadcast::OrHash).returns(T.attached_class)
+      end
+      def self.new(broadcast:)
+      end
+
+      sig { override.returns({ broadcast: Zavudev::Broadcast }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/broadcast_channel.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    # Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.
+    module BroadcastChannel
+      extend Zavudev::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Zavudev::BroadcastChannel) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      SMART = T.let(:smart, Zavudev::BroadcastChannel::TaggedSymbol)
+      SMS = T.let(:sms, Zavudev::BroadcastChannel::TaggedSymbol)
+      SMS_ONEWAY = T.let(:sms_oneway, Zavudev::BroadcastChannel::TaggedSymbol)
+      WHATSAPP = T.let(:whatsapp, Zavudev::BroadcastChannel::TaggedSymbol)
+      TELEGRAM = T.let(:telegram, Zavudev::BroadcastChannel::TaggedSymbol)
+      EMAIL = T.let(:email, Zavudev::BroadcastChannel::TaggedSymbol)
+      INSTAGRAM = T.let(:instagram, Zavudev::BroadcastChannel::TaggedSymbol)
+      VOICE = T.let(:voice, Zavudev::BroadcastChannel::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Zavudev::BroadcastChannel::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/zavudev/models/broadcast_contact.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class BroadcastContact < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::BroadcastContact, Zavudev::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :recipient
+
+      sig { returns(Zavudev::BroadcastContact::RecipientType::TaggedSymbol) }
+      attr_accessor :recipient_type
+
+      # Status of a contact within a broadcast.
+      sig { returns(Zavudev::BroadcastContactStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :cost
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :error_code
+
+      sig { params(error_code: String).void }
+      attr_writer :error_code
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :error_message
+
+      sig { params(error_message: String).void }
+      attr_writer :error_message
+
+      # Associated message ID after processing.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_id
+
+      sig { params(message_id: String).void }
+      attr_writer :message_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :processed_at
+
+      sig { params(processed_at: Time).void }
+      attr_writer :processed_at
+
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :template_variables
+
+      sig { params(template_variables: T::Hash[Symbol, String]).void }
+      attr_writer :template_variables
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          recipient: String,
+          recipient_type: Zavudev::BroadcastContact::RecipientType::OrSymbol,
+          status: Zavudev::BroadcastContactStatus::OrSymbol,
+          cost: T.nilable(Float),
+          error_code: String,
+          error_message: String,
+          message_id: String,
+          processed_at: Time,
+          template_variables: T::Hash[Symbol, String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        recipient:,
+        recipient_type:,
+        # Status of a contact within a broadcast.
+        status:,
+        cost: nil,
+        error_code: nil,
+        error_message: nil,
+        # Associated message ID after processing.
+        message_id: nil,
+        processed_at: nil,
+        template_variables: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            recipient: String,
+            recipient_type:
+              Zavudev::BroadcastContact::RecipientType::TaggedSymbol,
+            status: Zavudev::BroadcastContactStatus::TaggedSymbol,
+            cost: T.nilable(Float),
+            error_code: String,
+            error_message: String,
+            message_id: String,
+            processed_at: Time,
+            template_variables: T::Hash[Symbol, String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module RecipientType
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Zavudev::BroadcastContact::RecipientType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PHONE =
+          T.let(:phone, Zavudev::BroadcastContact::RecipientType::TaggedSymbol)
+        EMAIL =
+          T.let(:email, Zavudev::BroadcastContact::RecipientType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::BroadcastContact::RecipientType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/models/broadcast_contact_status.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    # Status of a contact within a broadcast.
+    module BroadcastContactStatus
+      extend Zavudev::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Zavudev::BroadcastContactStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      PENDING = T.let(:pending, Zavudev::BroadcastContactStatus::TaggedSymbol)
+      QUEUED = T.let(:queued, Zavudev::BroadcastContactStatus::TaggedSymbol)
+      SENDING = T.let(:sending, Zavudev::BroadcastContactStatus::TaggedSymbol)
+      DELIVERED =
+        T.let(:delivered, Zavudev::BroadcastContactStatus::TaggedSymbol)
+      FAILED = T.let(:failed, Zavudev::BroadcastContactStatus::TaggedSymbol)
+      SKIPPED = T.let(:skipped, Zavudev::BroadcastContactStatus::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Zavudev::BroadcastContactStatus::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/zavudev/models/broadcast_content.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class BroadcastContent < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::BroadcastContent, Zavudev::Internal::AnyHash)
+        end
+
+      # Filename for documents.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filename
+
+      sig { params(filename: String).void }
+      attr_writer :filename
+
+      # Media ID if already uploaded.
+      sig { returns(T.nilable(String)) }
+      attr_reader :media_id
+
+      sig { params(media_id: String).void }
+      attr_writer :media_id
+
+      # URL of the media file.
+      sig { returns(T.nilable(String)) }
+      attr_reader :media_url
+
+      sig { params(media_url: String).void }
+      attr_writer :media_url
+
+      # MIME type of the media.
+      sig { returns(T.nilable(String)) }
+      attr_reader :mime_type
+
+      sig { params(mime_type: String).void }
+      attr_writer :mime_type
+
+      # Template ID for template messages.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_id
+
+      sig { params(template_id: String).void }
+      attr_writer :template_id
+
+      # Default template variables (can be overridden per contact).
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :template_variables
+
+      sig { params(template_variables: T::Hash[Symbol, String]).void }
+      attr_writer :template_variables
+
+      # Content for non-text broadcast message types.
+      sig do
+        params(
+          filename: String,
+          media_id: String,
+          media_url: String,
+          mime_type: String,
+          template_id: String,
+          template_variables: T::Hash[Symbol, String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filename for documents.
+        filename: nil,
+        # Media ID if already uploaded.
+        media_id: nil,
+        # URL of the media file.
+        media_url: nil,
+        # MIME type of the media.
+        mime_type: nil,
+        # Template ID for template messages.
+        template_id: nil,
+        # Default template variables (can be overridden per contact).
+        template_variables: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            filename: String,
+            media_id: String,
+            media_url: String,
+            mime_type: String,
+            template_id: String,
+            template_variables: T::Hash[Symbol, String]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end