zavudev 0.0.2

data/lib/zavudev/models/phone_number_update_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#update
+    class PhoneNumberUpdateParams < 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
+
+      # @!attribute name
+      #   Custom name for the phone number. Set to null to clear.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute sender_id
+      #   Sender ID to assign the phone number to. Set to null to unassign.
+      #
+      #   @return [String, nil]
+      optional :sender_id, String, api_name: :senderId, nil?: true
+
+      # @!method initialize(phone_number_id:, name: nil, sender_id: nil, request_options: {})
+      #   @param phone_number_id [String]
+      #
+      #   @param name [String, nil] Custom name for the phone number. Set to null to clear.
+      #
+      #   @param sender_id [String, nil] Sender ID to assign the phone number to. Set to null to unassign.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/phone_number_update_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::PhoneNumbers#update
+    class PhoneNumberUpdateResponse < 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/regulatory_document.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::RegulatoryDocuments#list
+    class RegulatoryDocument < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute document_type
+      #
+      #   @return [Symbol, Zavudev::Models::RegulatoryDocument::DocumentType]
+      required :document_type, enum: -> { Zavudev::RegulatoryDocument::DocumentType }, api_name: :documentType
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Zavudev::Models::RegulatoryDocument::Status]
+      required :status, enum: -> { Zavudev::RegulatoryDocument::Status }
+
+      # @!attribute file_size
+      #
+      #   @return [Integer, nil]
+      optional :file_size, Integer, api_name: :fileSize
+
+      # @!attribute mime_type
+      #
+      #   @return [String, nil]
+      optional :mime_type, String, api_name: :mimeType
+
+      # @!attribute rejection_reason
+      #
+      #   @return [String, nil]
+      optional :rejection_reason, String, api_name: :rejectionReason, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(id:, created_at:, document_type:, name:, status:, file_size: nil, mime_type: nil, rejection_reason: nil, updated_at: nil)
+      #   A regulatory document for phone number requirements.
+      #
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param document_type [Symbol, Zavudev::Models::RegulatoryDocument::DocumentType]
+      #   @param name [String]
+      #   @param status [Symbol, Zavudev::Models::RegulatoryDocument::Status]
+      #   @param file_size [Integer]
+      #   @param mime_type [String]
+      #   @param rejection_reason [String, nil]
+      #   @param updated_at [Time]
+
+      # @see Zavudev::Models::RegulatoryDocument#document_type
+      module DocumentType
+        extend Zavudev::Internal::Type::Enum
+
+        PASSPORT = :passport
+        NATIONAL_ID = :national_id
+        DRIVERS_LICENSE = :drivers_license
+        UTILITY_BILL = :utility_bill
+        TAX_ID = :tax_id
+        BUSINESS_REGISTRATION = :business_registration
+        PROOF_OF_ADDRESS = :proof_of_address
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Zavudev::Models::RegulatoryDocument#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        UPLOADED = :uploaded
+        VERIFIED = :verified
+        REJECTED = :rejected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/regulatory_document_create_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::RegulatoryDocuments#create
+    class RegulatoryDocumentCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute document_type
+      #
+      #   @return [Symbol, Zavudev::Models::RegulatoryDocumentCreateParams::DocumentType]
+      required :document_type,
+               enum: -> { Zavudev::RegulatoryDocumentCreateParams::DocumentType },
+               api_name: :documentType
+
+      # @!attribute file_size
+      #
+      #   @return [Integer]
+      required :file_size, Integer, api_name: :fileSize
+
+      # @!attribute mime_type
+      #
+      #   @return [String]
+      required :mime_type, String, api_name: :mimeType
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute storage_id
+      #   Storage ID from the upload-url endpoint.
+      #
+      #   @return [String]
+      required :storage_id, String, api_name: :storageId
+
+      # @!method initialize(document_type:, file_size:, mime_type:, name:, storage_id:, request_options: {})
+      #   @param document_type [Symbol, Zavudev::Models::RegulatoryDocumentCreateParams::DocumentType]
+      #
+      #   @param file_size [Integer]
+      #
+      #   @param mime_type [String]
+      #
+      #   @param name [String]
+      #
+      #   @param storage_id [String] Storage ID from the upload-url endpoint.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      module DocumentType
+        extend Zavudev::Internal::Type::Enum
+
+        PASSPORT = :passport
+        NATIONAL_ID = :national_id
+        DRIVERS_LICENSE = :drivers_license
+        UTILITY_BILL = :utility_bill
+        TAX_ID = :tax_id
+        BUSINESS_REGISTRATION = :business_registration
+        PROOF_OF_ADDRESS = :proof_of_address
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/regulatory_document_create_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::RegulatoryDocuments#create
+    class RegulatoryDocumentCreateResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute document
+      #   A regulatory document for phone number requirements.
+      #
+      #   @return [Zavudev::Models::RegulatoryDocument]
+      required :document, -> { Zavudev::RegulatoryDocument }
+
+      # @!method initialize(document:)
+      #   @param document [Zavudev::Models::RegulatoryDocument] A regulatory document for phone number requirements.
+    end
+  end
+end

data/lib/zavudev/models/regulatory_document_delete_params.rb

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

data/lib/zavudev/models/regulatory_document_list_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::RegulatoryDocuments#list
+    class RegulatoryDocumentListParams < 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
+
+      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      #   @param cursor [String]
+      #   @param limit [Integer]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/regulatory_document_retrieve_params.rb

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

data/lib/zavudev/models/regulatory_document_retrieve_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::RegulatoryDocuments#retrieve
+    class RegulatoryDocumentRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute document
+      #   A regulatory document for phone number requirements.
+      #
+      #   @return [Zavudev::Models::RegulatoryDocument]
+      required :document, -> { Zavudev::RegulatoryDocument }
+
+      # @!method initialize(document:)
+      #   @param document [Zavudev::Models::RegulatoryDocument] A regulatory document for phone number requirements.
+    end
+  end
+end

data/lib/zavudev/models/regulatory_document_upload_url_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::RegulatoryDocuments#upload_url
+    class RegulatoryDocumentUploadURLParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/regulatory_document_upload_url_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::RegulatoryDocuments#upload_url
+    class RegulatoryDocumentUploadURLResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute upload_url
+      #   Pre-signed URL for uploading the file.
+      #
+      #   @return [String]
+      required :upload_url, String, api_name: :uploadUrl
+
+      # @!method initialize(upload_url:)
+      #   @param upload_url [String] Pre-signed URL for uploading the file.
+    end
+  end
+end

data/lib/zavudev/models/requirement.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class Requirement < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute action
+      #
+      #   @return [String]
+      required :action, String
+
+      # @!attribute country_code
+      #
+      #   @return [String]
+      required :country_code, String, api_name: :countryCode
+
+      # @!attribute phone_number_type
+      #
+      #   @return [String]
+      required :phone_number_type, String, api_name: :phoneNumberType
+
+      # @!attribute requirement_types
+      #
+      #   @return [Array<Zavudev::Models::RequirementType>]
+      required :requirement_types,
+               -> { Zavudev::Internal::Type::ArrayOf[Zavudev::RequirementType] },
+               api_name: :requirementTypes
+
+      # @!method initialize(id:, action:, country_code:, phone_number_type:, requirement_types:)
+      #   A group of requirements for a specific country/phone type combination.
+      #
+      #   @param id [String]
+      #   @param action [String]
+      #   @param country_code [String]
+      #   @param phone_number_type [String]
+      #   @param requirement_types [Array<Zavudev::Models::RequirementType>]
+    end
+  end
+end

data/lib/zavudev/models/requirement_acceptance_criteria.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class RequirementAcceptanceCriteria < Zavudev::Internal::Type::BaseModel
+      # @!attribute allowed_values
+      #
+      #   @return [Array<String>, nil]
+      optional :allowed_values, Zavudev::Internal::Type::ArrayOf[String], api_name: :allowedValues, nil?: true
+
+      # @!attribute max_length
+      #
+      #   @return [Integer, nil]
+      optional :max_length, Integer, api_name: :maxLength, nil?: true
+
+      # @!attribute min_length
+      #
+      #   @return [Integer, nil]
+      optional :min_length, Integer, api_name: :minLength, nil?: true
+
+      # @!attribute regex_pattern
+      #
+      #   @return [String, nil]
+      optional :regex_pattern, String, api_name: :regexPattern, nil?: true
+
+      # @!method initialize(allowed_values: nil, max_length: nil, min_length: nil, regex_pattern: nil)
+      #   Acceptance criteria for a requirement.
+      #
+      #   @param allowed_values [Array<String>, nil]
+      #   @param max_length [Integer, nil]
+      #   @param min_length [Integer, nil]
+      #   @param regex_pattern [String, nil]
+    end
+  end
+end

data/lib/zavudev/models/requirement_field_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # Type of requirement field.
+    module RequirementFieldType
+      extend Zavudev::Internal::Type::Enum
+
+      TEXTUAL = :textual
+      ADDRESS = :address
+      DOCUMENT = :document
+      ACTION = :action
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/zavudev/models/requirement_type.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class RequirementType < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute description
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #   Type of requirement field.
+      #
+      #   @return [Symbol, Zavudev::Models::RequirementFieldType]
+      required :type, enum: -> { Zavudev::RequirementFieldType }
+
+      # @!attribute acceptance_criteria
+      #   Acceptance criteria for a requirement.
+      #
+      #   @return [Zavudev::Models::RequirementAcceptanceCriteria, nil]
+      optional :acceptance_criteria,
+               -> { Zavudev::RequirementAcceptanceCriteria },
+               api_name: :acceptanceCriteria
+
+      # @!attribute example
+      #
+      #   @return [String, nil]
+      optional :example, String, nil?: true
+
+      # @!method initialize(id:, description:, name:, type:, acceptance_criteria: nil, example: nil)
+      #   A specific requirement type within a requirement group.
+      #
+      #   @param id [String]
+      #
+      #   @param description [String]
+      #
+      #   @param name [String]
+      #
+      #   @param type [Symbol, Zavudev::Models::RequirementFieldType] Type of requirement field.
+      #
+      #   @param acceptance_criteria [Zavudev::Models::RequirementAcceptanceCriteria] Acceptance criteria for a requirement.
+      #
+      #   @param example [String, nil]
+    end
+  end
+end

data/lib/zavudev/models/sender.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Senders#create
+    class Sender < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute phone_number
+      #   Phone number in E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String, api_name: :phoneNumber
+
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute email_receiving_enabled
+      #   Whether inbound email receiving is enabled for this sender.
+      #
+      #   @return [Boolean, nil]
+      optional :email_receiving_enabled, Zavudev::Internal::Type::Boolean, api_name: :emailReceivingEnabled
+
+      # @!attribute is_default
+      #   Whether this sender is the project's default.
+      #
+      #   @return [Boolean, nil]
+      optional :is_default, Zavudev::Internal::Type::Boolean, api_name: :isDefault
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute webhook
+      #   Webhook configuration for the sender.
+      #
+      #   @return [Zavudev::Models::SenderWebhook, nil]
+      optional :webhook, -> { Zavudev::SenderWebhook }
+
+      # @!attribute whatsapp
+      #   WhatsApp Business Account information. Only present if a WABA is connected.
+      #
+      #   @return [Zavudev::Models::Sender::Whatsapp, nil]
+      optional :whatsapp, -> { Zavudev::Sender::Whatsapp }
+
+      # @!method initialize(id:, name:, phone_number:, created_at: nil, email_receiving_enabled: nil, is_default: nil, updated_at: nil, webhook: nil, whatsapp: nil)
+      #   @param id [String]
+      #
+      #   @param name [String]
+      #
+      #   @param phone_number [String] Phone number in E.164 format.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param email_receiving_enabled [Boolean] Whether inbound email receiving is enabled for this sender.
+      #
+      #   @param is_default [Boolean] Whether this sender is the project's default.
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param webhook [Zavudev::Models::SenderWebhook] Webhook configuration for the sender.
+      #
+      #   @param whatsapp [Zavudev::Models::Sender::Whatsapp] WhatsApp Business Account information. Only present if a WABA is connected.
+
+      # @see Zavudev::Models::Sender#whatsapp
+      class Whatsapp < Zavudev::Internal::Type::BaseModel
+        # @!attribute display_phone_number
+        #   Display phone number.
+        #
+        #   @return [String, nil]
+        optional :display_phone_number, String, api_name: :displayPhoneNumber
+
+        # @!attribute payment_status
+        #   Payment configuration status from Meta.
+        #
+        #   @return [Zavudev::Models::Sender::Whatsapp::PaymentStatus, nil]
+        optional :payment_status, -> { Zavudev::Sender::Whatsapp::PaymentStatus }, api_name: :paymentStatus
+
+        # @!attribute phone_number_id
+        #   WhatsApp phone number ID from Meta.
+        #
+        #   @return [String, nil]
+        optional :phone_number_id, String, api_name: :phoneNumberId
+
+        # @!method initialize(display_phone_number: nil, payment_status: nil, phone_number_id: nil)
+        #   WhatsApp Business Account information. Only present if a WABA is connected.
+        #
+        #   @param display_phone_number [String] Display phone number.
+        #
+        #   @param payment_status [Zavudev::Models::Sender::Whatsapp::PaymentStatus] Payment configuration status from Meta.
+        #
+        #   @param phone_number_id [String] WhatsApp phone number ID from Meta.
+
+        # @see Zavudev::Models::Sender::Whatsapp#payment_status
+        class PaymentStatus < Zavudev::Internal::Type::BaseModel
+          # @!attribute can_send_templates
+          #   Whether template messages can be sent. Requires setupStatus=COMPLETE and
+          #   methodStatus=VALID.
+          #
+          #   @return [Boolean, nil]
+          optional :can_send_templates, Zavudev::Internal::Type::Boolean, api_name: :canSendTemplates
+
+          # @!attribute method_status
+          #   Payment method status (VALID, NONE, etc.).
+          #
+          #   @return [String, nil]
+          optional :method_status, String, api_name: :methodStatus
+
+          # @!attribute setup_status
+          #   Payment setup status (COMPLETE, NOT_STARTED, etc.).
+          #
+          #   @return [String, nil]
+          optional :setup_status, String, api_name: :setupStatus
+
+          # @!method initialize(can_send_templates: nil, method_status: nil, setup_status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Zavudev::Models::Sender::Whatsapp::PaymentStatus} for more details.
+          #
+          #   Payment configuration status from Meta.
+          #
+          #   @param can_send_templates [Boolean] Whether template messages can be sent. Requires setupStatus=COMPLETE and methodS
+          #
+          #   @param method_status [String] Payment method status (VALID, NONE, etc.).
+          #
+          #   @param setup_status [String] Payment setup status (COMPLETE, NOT_STARTED, etc.).
+        end
+      end
+    end
+  end
+end