zavudev 0.0.2

data/lib/zavudev/models/broadcast_contact.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class BroadcastContact < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute recipient
+      #
+      #   @return [String]
+      required :recipient, String
+
+      # @!attribute recipient_type
+      #
+      #   @return [Symbol, Zavudev::Models::BroadcastContact::RecipientType]
+      required :recipient_type,
+               enum: -> {
+                 Zavudev::BroadcastContact::RecipientType
+               },
+               api_name: :recipientType
+
+      # @!attribute status
+      #   Status of a contact within a broadcast.
+      #
+      #   @return [Symbol, Zavudev::Models::BroadcastContactStatus]
+      required :status, enum: -> { Zavudev::BroadcastContactStatus }
+
+      # @!attribute cost
+      #
+      #   @return [Float, nil]
+      optional :cost, Float, nil?: true
+
+      # @!attribute error_code
+      #
+      #   @return [String, nil]
+      optional :error_code, String, api_name: :errorCode
+
+      # @!attribute error_message
+      #
+      #   @return [String, nil]
+      optional :error_message, String, api_name: :errorMessage
+
+      # @!attribute message_id
+      #   Associated message ID after processing.
+      #
+      #   @return [String, nil]
+      optional :message_id, String, api_name: :messageId
+
+      # @!attribute processed_at
+      #
+      #   @return [Time, nil]
+      optional :processed_at, Time, api_name: :processedAt
+
+      # @!attribute template_variables
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :template_variables, Zavudev::Internal::Type::HashOf[String], api_name: :templateVariables
+
+      # @!method initialize(id:, created_at:, recipient:, recipient_type:, status:, cost: nil, error_code: nil, error_message: nil, message_id: nil, processed_at: nil, template_variables: nil)
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param recipient [String]
+      #
+      #   @param recipient_type [Symbol, Zavudev::Models::BroadcastContact::RecipientType]
+      #
+      #   @param status [Symbol, Zavudev::Models::BroadcastContactStatus] Status of a contact within a broadcast.
+      #
+      #   @param cost [Float, nil]
+      #
+      #   @param error_code [String]
+      #
+      #   @param error_message [String]
+      #
+      #   @param message_id [String] Associated message ID after processing.
+      #
+      #   @param processed_at [Time]
+      #
+      #   @param template_variables [Hash{Symbol=>String}]
+
+      # @see Zavudev::Models::BroadcastContact#recipient_type
+      module RecipientType
+        extend Zavudev::Internal::Type::Enum
+
+        PHONE = :phone
+        EMAIL = :email
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/broadcast_contact_status.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # Status of a contact within a broadcast.
+    module BroadcastContactStatus
+      extend Zavudev::Internal::Type::Enum
+
+      PENDING = :pending
+      QUEUED = :queued
+      SENDING = :sending
+      DELIVERED = :delivered
+      FAILED = :failed
+      SKIPPED = :skipped
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_content.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class BroadcastContent < Zavudev::Internal::Type::BaseModel
+      # @!attribute filename
+      #   Filename for documents.
+      #
+      #   @return [String, nil]
+      optional :filename, String
+
+      # @!attribute media_id
+      #   Media ID if already uploaded.
+      #
+      #   @return [String, nil]
+      optional :media_id, String, api_name: :mediaId
+
+      # @!attribute media_url
+      #   URL of the media file.
+      #
+      #   @return [String, nil]
+      optional :media_url, String, api_name: :mediaUrl
+
+      # @!attribute mime_type
+      #   MIME type of the media.
+      #
+      #   @return [String, nil]
+      optional :mime_type, String, api_name: :mimeType
+
+      # @!attribute template_id
+      #   Template ID for template messages.
+      #
+      #   @return [String, nil]
+      optional :template_id, String, api_name: :templateId
+
+      # @!attribute template_variables
+      #   Default template variables (can be overridden per contact).
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :template_variables, Zavudev::Internal::Type::HashOf[String], api_name: :templateVariables
+
+      # @!method initialize(filename: nil, media_id: nil, media_url: nil, mime_type: nil, template_id: nil, template_variables: nil)
+      #   Content for non-text broadcast message types.
+      #
+      #   @param filename [String] Filename for documents.
+      #
+      #   @param media_id [String] Media ID if already uploaded.
+      #
+      #   @param media_url [String] URL of the media file.
+      #
+      #   @param mime_type [String] MIME type of the media.
+      #
+      #   @param template_id [String] Template ID for template messages.
+      #
+      #   @param template_variables [Hash{Symbol=>String}] Default template variables (can be overridden per contact).
+    end
+  end
+end

data/lib/zavudev/models/broadcast_create_params.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#create
+    class BroadcastCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute channel
+      #   Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.
+      #
+      #   @return [Symbol, Zavudev::Models::BroadcastChannel]
+      required :channel, enum: -> { Zavudev::BroadcastChannel }
+
+      # @!attribute name
+      #   Name of the broadcast campaign.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute content
+      #   Content for non-text broadcast message types.
+      #
+      #   @return [Zavudev::Models::BroadcastContent, nil]
+      optional :content, -> { Zavudev::BroadcastContent }
+
+      # @!attribute email_html_body
+      #   HTML body for email broadcasts.
+      #
+      #   @return [String, nil]
+      optional :email_html_body, String, api_name: :emailHtmlBody
+
+      # @!attribute email_subject
+      #   Email subject line. Required for email broadcasts.
+      #
+      #   @return [String, nil]
+      optional :email_subject, String, api_name: :emailSubject
+
+      # @!attribute idempotency_key
+      #   Idempotency key to prevent duplicate broadcasts.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String, api_name: :idempotencyKey
+
+      # @!attribute message_type
+      #   Type of message for broadcast.
+      #
+      #   @return [Symbol, Zavudev::Models::BroadcastMessageType, nil]
+      optional :message_type, enum: -> { Zavudev::BroadcastMessageType }, api_name: :messageType
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Zavudev::Internal::Type::HashOf[String]
+
+      # @!attribute scheduled_at
+      #   Schedule the broadcast for future delivery.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time, api_name: :scheduledAt
+
+      # @!attribute sender_id
+      #   Sender profile ID. Uses default sender if omitted.
+      #
+      #   @return [String, nil]
+      optional :sender_id, String, api_name: :senderId
+
+      # @!attribute text
+      #   Text content or caption. Supports template variables: {{name}}, {{1}}, etc.
+      #
+      #   @return [String, nil]
+      optional :text, String
+
+      # @!method initialize(channel:, name:, content: nil, email_html_body: nil, email_subject: nil, idempotency_key: nil, message_type: nil, metadata: nil, scheduled_at: nil, sender_id: nil, text: nil, request_options: {})
+      #   @param channel [Symbol, Zavudev::Models::BroadcastChannel] Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.
+      #
+      #   @param name [String] Name of the broadcast campaign.
+      #
+      #   @param content [Zavudev::Models::BroadcastContent] Content for non-text broadcast message types.
+      #
+      #   @param email_html_body [String] HTML body for email broadcasts.
+      #
+      #   @param email_subject [String] Email subject line. Required for email broadcasts.
+      #
+      #   @param idempotency_key [String] Idempotency key to prevent duplicate broadcasts.
+      #
+      #   @param message_type [Symbol, Zavudev::Models::BroadcastMessageType] Type of message for broadcast.
+      #
+      #   @param metadata [Hash{Symbol=>String}]
+      #
+      #   @param scheduled_at [Time] Schedule the broadcast for future delivery.
+      #
+      #   @param sender_id [String] Sender profile ID. Uses default sender if omitted.
+      #
+      #   @param text [String] Text content or caption. Supports template variables: {{name}}, {{1}}, etc.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#create
+    class BroadcastCreateResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute broadcast
+      #
+      #   @return [Zavudev::Models::Broadcast]
+      required :broadcast, -> { Zavudev::Broadcast }
+
+      # @!method initialize(broadcast:)
+      #   @param broadcast [Zavudev::Models::Broadcast]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#delete
+    class BroadcastDeleteParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_list_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#list
+    class BroadcastListParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #   Current status of the broadcast.
+      #
+      #   @return [Symbol, Zavudev::Models::BroadcastStatus, nil]
+      optional :status, enum: -> { Zavudev::BroadcastStatus }
+
+      # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
+      #   @param cursor [String]
+      #
+      #   @param limit [Integer]
+      #
+      #   @param status [Symbol, Zavudev::Models::BroadcastStatus] Current status of the broadcast.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_message_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # Type of message for broadcast.
+    module BroadcastMessageType
+      extend Zavudev::Internal::Type::Enum
+
+      TEXT = :text
+      IMAGE = :image
+      VIDEO = :video
+      AUDIO = :audio
+      DOCUMENT = :document
+      TEMPLATE = :template
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_progress.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#progress
+    class BroadcastProgress < Zavudev::Internal::Type::BaseModel
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String, api_name: :broadcastId
+
+      # @!attribute delivered
+      #   Successfully delivered.
+      #
+      #   @return [Integer]
+      required :delivered, Integer
+
+      # @!attribute failed
+      #   Failed to deliver.
+      #
+      #   @return [Integer]
+      required :failed, Integer
+
+      # @!attribute pending
+      #   Not yet queued for sending.
+      #
+      #   @return [Integer]
+      required :pending, Integer
+
+      # @!attribute percent_complete
+      #   Percentage complete (0-100).
+      #
+      #   @return [Float]
+      required :percent_complete, Float, api_name: :percentComplete
+
+      # @!attribute sending
+      #   Currently being sent.
+      #
+      #   @return [Integer]
+      required :sending, Integer
+
+      # @!attribute skipped
+      #   Skipped (broadcast cancelled).
+      #
+      #   @return [Integer]
+      required :skipped, Integer
+
+      # @!attribute status
+      #   Current status of the broadcast.
+      #
+      #   @return [Symbol, Zavudev::Models::BroadcastStatus]
+      required :status, enum: -> { Zavudev::BroadcastStatus }
+
+      # @!attribute total
+      #   Total contacts in broadcast.
+      #
+      #   @return [Integer]
+      required :total, Integer
+
+      # @!attribute actual_cost
+      #   Actual cost so far in USD.
+      #
+      #   @return [Float, nil]
+      optional :actual_cost, Float, api_name: :actualCost, nil?: true
+
+      # @!attribute estimated_completion_at
+      #
+      #   @return [Time, nil]
+      optional :estimated_completion_at, Time, api_name: :estimatedCompletionAt
+
+      # @!attribute estimated_cost
+      #   Estimated total cost in USD.
+      #
+      #   @return [Float, nil]
+      optional :estimated_cost, Float, api_name: :estimatedCost, nil?: true
+
+      # @!attribute reserved_amount
+      #   Amount reserved from balance in USD.
+      #
+      #   @return [Float, nil]
+      optional :reserved_amount, Float, api_name: :reservedAmount, nil?: true
+
+      # @!attribute started_at
+      #
+      #   @return [Time, nil]
+      optional :started_at, Time, api_name: :startedAt
+
+      # @!method initialize(broadcast_id:, delivered:, failed:, pending:, percent_complete:, sending:, skipped:, status:, total:, actual_cost: nil, estimated_completion_at: nil, estimated_cost: nil, reserved_amount: nil, started_at: nil)
+      #   @param broadcast_id [String]
+      #
+      #   @param delivered [Integer] Successfully delivered.
+      #
+      #   @param failed [Integer] Failed to deliver.
+      #
+      #   @param pending [Integer] Not yet queued for sending.
+      #
+      #   @param percent_complete [Float] Percentage complete (0-100).
+      #
+      #   @param sending [Integer] Currently being sent.
+      #
+      #   @param skipped [Integer] Skipped (broadcast cancelled).
+      #
+      #   @param status [Symbol, Zavudev::Models::BroadcastStatus] Current status of the broadcast.
+      #
+      #   @param total [Integer] Total contacts in broadcast.
+      #
+      #   @param actual_cost [Float, nil] Actual cost so far in USD.
+      #
+      #   @param estimated_completion_at [Time]
+      #
+      #   @param estimated_cost [Float, nil] Estimated total cost in USD.
+      #
+      #   @param reserved_amount [Float, nil] Amount reserved from balance in USD.
+      #
+      #   @param started_at [Time]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_progress_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#progress
+    class BroadcastProgressParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_reschedule_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#reschedule
+    class BroadcastRescheduleParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!attribute scheduled_at
+      #   New scheduled time for the broadcast.
+      #
+      #   @return [Time]
+      required :scheduled_at, Time, api_name: :scheduledAt
+
+      # @!method initialize(broadcast_id:, scheduled_at:, request_options: {})
+      #   @param broadcast_id [String]
+      #
+      #   @param scheduled_at [Time] New scheduled time for the broadcast.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_reschedule_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#reschedule
+    class BroadcastRescheduleResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute broadcast
+      #
+      #   @return [Zavudev::Models::Broadcast]
+      required :broadcast, -> { Zavudev::Broadcast }
+
+      # @!method initialize(broadcast:)
+      #   @param broadcast [Zavudev::Models::Broadcast]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#retrieve
+    class BroadcastRetrieveParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_retrieve_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#retrieve
+    class BroadcastRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute broadcast
+      #
+      #   @return [Zavudev::Models::Broadcast]
+      required :broadcast, -> { Zavudev::Broadcast }
+
+      # @!method initialize(broadcast:)
+      #   @param broadcast [Zavudev::Models::Broadcast]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_send_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#send_
+    class BroadcastSendParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!attribute scheduled_at
+      #   Schedule for future delivery. Omit to send immediately.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time, api_name: :scheduledAt
+
+      # @!method initialize(broadcast_id:, scheduled_at: nil, request_options: {})
+      #   @param broadcast_id [String]
+      #
+      #   @param scheduled_at [Time] Schedule for future delivery. Omit to send immediately.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_send_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Broadcasts#send_
+    class BroadcastSendResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute broadcast
+      #
+      #   @return [Zavudev::Models::Broadcast]
+      required :broadcast, -> { Zavudev::Broadcast }
+
+      # @!method initialize(broadcast:)
+      #   @param broadcast [Zavudev::Models::Broadcast]
+    end
+  end
+end

data/lib/zavudev/models/broadcast_status.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # Current status of the broadcast.
+    module BroadcastStatus
+      extend Zavudev::Internal::Type::Enum
+
+      DRAFT = :draft
+      PENDING_REVIEW = :pending_review
+      APPROVED = :approved
+      REJECTED = :rejected
+      ESCALATED = :escalated
+      REJECTED_FINAL = :rejected_final
+      SCHEDULED = :scheduled
+      SENDING = :sending
+      PAUSED = :paused
+      COMPLETED = :completed
+      CANCELLED = :cancelled
+      FAILED = :failed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end