zavudev 0.0.2

data/lib/zavudev/models/message_send_params.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Messages#send_
+    class MessageSendParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute to
+      #   Recipient phone number in E.164 format or email address.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute channel
+      #   Delivery channel. Use 'auto' for intelligent routing. If omitted with non-text
+      #   messageType, WhatsApp is used. For email recipients, defaults to 'email'.
+      #
+      #   @return [Symbol, Zavudev::Models::Channel, nil]
+      optional :channel, enum: -> { Zavudev::Channel }
+
+      # @!attribute content
+      #   Additional content for non-text message types.
+      #
+      #   @return [Zavudev::Models::MessageContent, nil]
+      optional :content, -> { Zavudev::MessageContent }
+
+      # @!attribute fallback_enabled
+      #   Whether to enable automatic fallback to SMS if WhatsApp fails. Defaults to true.
+      #
+      #   @return [Boolean, nil]
+      optional :fallback_enabled, Zavudev::Internal::Type::Boolean, api_name: :fallbackEnabled
+
+      # @!attribute html_body
+      #   HTML body for email messages. If provided, email will be sent as multipart with
+      #   both text and HTML.
+      #
+      #   @return [String, nil]
+      optional :html_body, String, api_name: :htmlBody
+
+      # @!attribute idempotency_key
+      #   Optional idempotency key to avoid duplicate sends.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String, api_name: :idempotencyKey
+
+      # @!attribute message_type
+      #   Type of message. Defaults to 'text'.
+      #
+      #   @return [Symbol, Zavudev::Models::MessageType, nil]
+      optional :message_type, enum: -> { Zavudev::MessageType }, api_name: :messageType
+
+      # @!attribute metadata
+      #   Arbitrary metadata to associate with the message.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Zavudev::Internal::Type::HashOf[String]
+
+      # @!attribute reply_to
+      #   Reply-To email address for email messages.
+      #
+      #   @return [String, nil]
+      optional :reply_to, String, api_name: :replyTo
+
+      # @!attribute subject
+      #   Email subject line. Required when channel is 'email' or recipient is an email
+      #   address.
+      #
+      #   @return [String, nil]
+      optional :subject, String
+
+      # @!attribute text
+      #   Text body for text messages or caption for media messages.
+      #
+      #   @return [String, nil]
+      optional :text, String
+
+      # @!attribute voice_language
+      #   Language code for voice text-to-speech (e.g., 'en-US', 'es-ES', 'pt-BR'). If
+      #   omitted, language is auto-detected from recipient's country code.
+      #
+      #   @return [String, nil]
+      optional :voice_language, String, api_name: :voiceLanguage
+
+      # @!attribute zavu_sender
+      #
+      #   @return [String, nil]
+      optional :zavu_sender, String
+
+      # @!method initialize(to:, channel: nil, content: nil, fallback_enabled: nil, html_body: nil, idempotency_key: nil, message_type: nil, metadata: nil, reply_to: nil, subject: nil, text: nil, voice_language: nil, zavu_sender: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::MessageSendParams} for more details.
+      #
+      #   @param to [String] Recipient phone number in E.164 format or email address.
+      #
+      #   @param channel [Symbol, Zavudev::Models::Channel] Delivery channel. Use 'auto' for intelligent routing. If omitted with non-text m
+      #
+      #   @param content [Zavudev::Models::MessageContent] Additional content for non-text message types.
+      #
+      #   @param fallback_enabled [Boolean] Whether to enable automatic fallback to SMS if WhatsApp fails. Defaults to true.
+      #
+      #   @param html_body [String] HTML body for email messages. If provided, email will be sent as multipart with
+      #
+      #   @param idempotency_key [String] Optional idempotency key to avoid duplicate sends.
+      #
+      #   @param message_type [Symbol, Zavudev::Models::MessageType] Type of message. Defaults to 'text'.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Arbitrary metadata to associate with the message.
+      #
+      #   @param reply_to [String] Reply-To email address for email messages.
+      #
+      #   @param subject [String] Email subject line. Required when channel is 'email' or recipient is an email ad
+      #
+      #   @param text [String] Text body for text messages or caption for media messages.
+      #
+      #   @param voice_language [String] Language code for voice text-to-speech (e.g., 'en-US', 'es-ES', 'pt-BR'). If omi
+      #
+      #   @param zavu_sender [String]
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/message_status.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module MessageStatus
+      extend Zavudev::Internal::Type::Enum
+
+      QUEUED = :queued
+      SENDING = :sending
+      SENT = :sent
+      DELIVERED = :delivered
+      FAILED = :failed
+      RECEIVED = :received
+      PENDING_URL_VERIFICATION = :pending_url_verification
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/zavudev/models/message_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # Type of message. Non-text types are supported by WhatsApp and Telegram (varies
+    # by type).
+    module MessageType
+      extend Zavudev::Internal::Type::Enum
+
+      TEXT = :text
+      IMAGE = :image
+      VIDEO = :video
+      AUDIO = :audio
+      DOCUMENT = :document
+      STICKER = :sticker
+      LOCATION = :location
+      CONTACT = :contact
+      BUTTONS = :buttons
+      LIST = :list
+      REACTION = :reaction
+      TEMPLATE = :template
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/zavudev/models/owned_phone_number.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#list
+    class OwnedPhoneNumber < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute capabilities
+      #
+      #   @return [Array<String>]
+      required :capabilities, Zavudev::Internal::Type::ArrayOf[String]
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute phone_number
+      #
+      #   @return [String]
+      required :phone_number, String, api_name: :phoneNumber
+
+      # @!attribute pricing
+      #
+      #   @return [Zavudev::Models::OwnedPhoneNumberPricing]
+      required :pricing, -> { Zavudev::OwnedPhoneNumberPricing }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Zavudev::Models::PhoneNumberStatus]
+      required :status, enum: -> { Zavudev::PhoneNumberStatus }
+
+      # @!attribute name
+      #   Optional custom name for the phone number.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute next_renewal_date
+      #
+      #   @return [Time, nil]
+      optional :next_renewal_date, Time, api_name: :nextRenewalDate
+
+      # @!attribute sender_id
+      #   Sender ID if the phone number is assigned to a sender.
+      #
+      #   @return [String, nil]
+      optional :sender_id, String, api_name: :senderId
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(id:, capabilities:, created_at:, phone_number:, pricing:, status:, name: nil, next_renewal_date: nil, sender_id: nil, updated_at: nil)
+      #   @param id [String]
+      #
+      #   @param capabilities [Array<String>]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param phone_number [String]
+      #
+      #   @param pricing [Zavudev::Models::OwnedPhoneNumberPricing]
+      #
+      #   @param status [Symbol, Zavudev::Models::PhoneNumberStatus]
+      #
+      #   @param name [String] Optional custom name for the phone number.
+      #
+      #   @param next_renewal_date [Time]
+      #
+      #   @param sender_id [String] Sender ID if the phone number is assigned to a sender.
+      #
+      #   @param updated_at [Time]
+    end
+  end
+end

data/lib/zavudev/models/owned_phone_number_pricing.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class OwnedPhoneNumberPricing < Zavudev::Internal::Type::BaseModel
+      # @!attribute is_free_number
+      #   Whether this is a free number.
+      #
+      #   @return [Boolean, nil]
+      optional :is_free_number, Zavudev::Internal::Type::Boolean, api_name: :isFreeNumber
+
+      # @!attribute monthly_cost
+      #   Monthly cost in cents.
+      #
+      #   @return [Float, nil]
+      optional :monthly_cost, Float, api_name: :monthlyCost
+
+      # @!attribute monthly_price
+      #   Monthly price in USD.
+      #
+      #   @return [Float, nil]
+      optional :monthly_price, Float, api_name: :monthlyPrice
+
+      # @!attribute upfront_cost
+      #   One-time purchase cost in cents.
+      #
+      #   @return [Float, nil]
+      optional :upfront_cost, Float, api_name: :upfrontCost
+
+      # @!method initialize(is_free_number: nil, monthly_cost: nil, monthly_price: nil, upfront_cost: nil)
+      #   @param is_free_number [Boolean] Whether this is a free number.
+      #
+      #   @param monthly_cost [Float] Monthly cost in cents.
+      #
+      #   @param monthly_price [Float] Monthly price in USD.
+      #
+      #   @param upfront_cost [Float] One-time purchase cost in cents.
+    end
+  end
+end

data/lib/zavudev/models/phone_number_capabilities.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class PhoneNumberCapabilities < Zavudev::Internal::Type::BaseModel
+      # @!attribute mms
+      #
+      #   @return [Boolean, nil]
+      optional :mms, Zavudev::Internal::Type::Boolean
+
+      # @!attribute sms
+      #
+      #   @return [Boolean, nil]
+      optional :sms, Zavudev::Internal::Type::Boolean
+
+      # @!attribute voice
+      #
+      #   @return [Boolean, nil]
+      optional :voice, Zavudev::Internal::Type::Boolean
+
+      # @!method initialize(mms: nil, sms: nil, voice: nil)
+      #   @param mms [Boolean]
+      #   @param sms [Boolean]
+      #   @param voice [Boolean]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_list_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#list
+    class PhoneNumberListParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Pagination cursor.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #   Filter by phone number status.
+      #
+      #   @return [Symbol, Zavudev::Models::PhoneNumberStatus, nil]
+      optional :status, enum: -> { Zavudev::PhoneNumberStatus }
+
+      # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
+      #   @param cursor [String] Pagination cursor.
+      #
+      #   @param limit [Integer]
+      #
+      #   @param status [Symbol, Zavudev::Models::PhoneNumberStatus] Filter by phone number status.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_pricing.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class PhoneNumberPricing < Zavudev::Internal::Type::BaseModel
+      # @!attribute is_free_eligible
+      #   Whether this number qualifies for the free first US number offer.
+      #
+      #   @return [Boolean, nil]
+      optional :is_free_eligible, Zavudev::Internal::Type::Boolean, api_name: :isFreeEligible
+
+      # @!attribute monthly_price
+      #   Monthly price in USD.
+      #
+      #   @return [Float, nil]
+      optional :monthly_price, Float, api_name: :monthlyPrice
+
+      # @!attribute upfront_price
+      #   One-time purchase price in USD.
+      #
+      #   @return [Float, nil]
+      optional :upfront_price, Float, api_name: :upfrontPrice
+
+      # @!method initialize(is_free_eligible: nil, monthly_price: nil, upfront_price: nil)
+      #   @param is_free_eligible [Boolean] Whether this number qualifies for the free first US number offer.
+      #
+      #   @param monthly_price [Float] Monthly price in USD.
+      #
+      #   @param upfront_price [Float] One-time purchase price in USD.
+    end
+  end
+end

data/lib/zavudev/models/phone_number_purchase_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#purchase
+    class PhoneNumberPurchaseParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #   Phone number in E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String, api_name: :phoneNumber
+
+      # @!attribute name
+      #   Optional custom name for the phone number.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(phone_number:, name: nil, request_options: {})
+      #   @param phone_number [String] Phone number in E.164 format.
+      #
+      #   @param name [String] Optional custom name for the phone number.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_purchase_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#purchase
+    class PhoneNumberPurchaseResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute phone_number
+      #
+      #   @return [Zavudev::Models::OwnedPhoneNumber]
+      required :phone_number, -> { Zavudev::OwnedPhoneNumber }, api_name: :phoneNumber
+
+      # @!method initialize(phone_number:)
+      #   @param phone_number [Zavudev::Models::OwnedPhoneNumber]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_release_params.rb

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

data/lib/zavudev/models/phone_number_requirements_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#requirements
+    class PhoneNumberRequirementsParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute country_code
+      #   Two-letter ISO country code.
+      #
+      #   @return [String]
+      required :country_code, String
+
+      # @!attribute type
+      #   Type of phone number (local, mobile, tollFree).
+      #
+      #   @return [Symbol, Zavudev::Models::PhoneNumberType, nil]
+      optional :type, enum: -> { Zavudev::PhoneNumberType }
+
+      # @!method initialize(country_code:, type: nil, request_options: {})
+      #   @param country_code [String] Two-letter ISO country code.
+      #
+      #   @param type [Symbol, Zavudev::Models::PhoneNumberType] Type of phone number (local, mobile, tollFree).
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_requirements_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#requirements
+    class PhoneNumberRequirementsResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute items
+      #
+      #   @return [Array<Zavudev::Models::Requirement>]
+      required :items, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::Requirement] }
+
+      # @!method initialize(items:)
+      #   @param items [Array<Zavudev::Models::Requirement>]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_retrieve_params.rb

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

data/lib/zavudev/models/phone_number_retrieve_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#retrieve
+    class PhoneNumberRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute phone_number
+      #
+      #   @return [Zavudev::Models::OwnedPhoneNumber]
+      required :phone_number, -> { Zavudev::OwnedPhoneNumber }, api_name: :phoneNumber
+
+      # @!method initialize(phone_number:)
+      #   @param phone_number [Zavudev::Models::OwnedPhoneNumber]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_search_available_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#search_available
+    class PhoneNumberSearchAvailableParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute country_code
+      #   Two-letter ISO country code.
+      #
+      #   @return [String]
+      required :country_code, String
+
+      # @!attribute contains
+      #   Search for numbers containing this string.
+      #
+      #   @return [String, nil]
+      optional :contains, String
+
+      # @!attribute limit
+      #   Maximum number of results to return.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute type
+      #   Type of phone number to search for.
+      #
+      #   @return [Symbol, Zavudev::Models::PhoneNumberType, nil]
+      optional :type, enum: -> { Zavudev::PhoneNumberType }
+
+      # @!method initialize(country_code:, contains: nil, limit: nil, type: nil, request_options: {})
+      #   @param country_code [String] Two-letter ISO country code.
+      #
+      #   @param contains [String] Search for numbers containing this string.
+      #
+      #   @param limit [Integer] Maximum number of results to return.
+      #
+      #   @param type [Symbol, Zavudev::Models::PhoneNumberType] Type of phone number to search for.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_search_available_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#search_available
+    class PhoneNumberSearchAvailableResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute items
+      #
+      #   @return [Array<Zavudev::Models::AvailablePhoneNumber>]
+      required :items, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::AvailablePhoneNumber] }
+
+      # @!method initialize(items:)
+      #   @param items [Array<Zavudev::Models::AvailablePhoneNumber>]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module PhoneNumberStatus
+      extend Zavudev::Internal::Type::Enum
+
+      ACTIVE = :active
+      SUSPENDED = :suspended
+      PENDING = :pending
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module PhoneNumberType
+      extend Zavudev::Internal::Type::Enum
+
+      LOCAL = :local
+      MOBILE = :mobile
+      TOLL_FREE = :tollFree
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end