zavudev 0.6.0 → 0.8.0

data/lib/zavudev/models/contact_channel.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    class ContactChannel < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute channel
+      #   Channel type.
+      #
+      #   @return [Symbol, Zavudev::Models::ContactChannel::Channel]
+      required :channel, enum: -> { Zavudev::ContactChannel::Channel }
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute identifier
+      #   Channel identifier (phone number or email address).
+      #
+      #   @return [String]
+      required :identifier, String
+
+      # @!attribute is_primary
+      #   Whether this is the primary channel for its type.
+      #
+      #   @return [Boolean]
+      required :is_primary, Zavudev::Internal::Type::Boolean, api_name: :isPrimary
+
+      # @!attribute verified
+      #   Whether this channel has been verified.
+      #
+      #   @return [Boolean]
+      required :verified, Zavudev::Internal::Type::Boolean
+
+      # @!attribute country_code
+      #   ISO country code for phone numbers.
+      #
+      #   @return [String, nil]
+      optional :country_code, String, api_name: :countryCode
+
+      # @!attribute label
+      #   Optional label for the channel.
+      #
+      #   @return [String, nil]
+      optional :label, String
+
+      # @!attribute last_inbound_at
+      #   Last time a message was received on this channel.
+      #
+      #   @return [Time, nil]
+      optional :last_inbound_at, Time, api_name: :lastInboundAt
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Zavudev::Internal::Type::HashOf[String]
+
+      # @!attribute metrics
+      #   Delivery metrics for this channel.
+      #
+      #   @return [Zavudev::Models::ContactChannel::Metrics, nil]
+      optional :metrics, -> { Zavudev::ContactChannel::Metrics }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(id:, channel:, created_at:, identifier:, is_primary:, verified:, country_code: nil, label: nil, last_inbound_at: nil, metadata: nil, metrics: nil, updated_at: nil)
+      #   A communication channel for a contact.
+      #
+      #   @param id [String]
+      #
+      #   @param channel [Symbol, Zavudev::Models::ContactChannel::Channel] Channel type.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param identifier [String] Channel identifier (phone number or email address).
+      #
+      #   @param is_primary [Boolean] Whether this is the primary channel for its type.
+      #
+      #   @param verified [Boolean] Whether this channel has been verified.
+      #
+      #   @param country_code [String] ISO country code for phone numbers.
+      #
+      #   @param label [String] Optional label for the channel.
+      #
+      #   @param last_inbound_at [Time] Last time a message was received on this channel.
+      #
+      #   @param metadata [Hash{Symbol=>String}]
+      #
+      #   @param metrics [Zavudev::Models::ContactChannel::Metrics] Delivery metrics for this channel.
+      #
+      #   @param updated_at [Time]
+
+      # Channel type.
+      #
+      # @see Zavudev::Models::ContactChannel#channel
+      module Channel
+        extend Zavudev::Internal::Type::Enum
+
+        SMS = :sms
+        WHATSAPP = :whatsapp
+        EMAIL = :email
+        TELEGRAM = :telegram
+        VOICE = :voice
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Zavudev::Models::ContactChannel#metrics
+      class Metrics < Zavudev::Internal::Type::BaseModel
+        # @!attribute avg_delivery_time_ms
+        #
+        #   @return [Float, nil]
+        optional :avg_delivery_time_ms, Float, api_name: :avgDeliveryTimeMs
+
+        # @!attribute failure_count
+        #
+        #   @return [Integer, nil]
+        optional :failure_count, Integer, api_name: :failureCount
+
+        # @!attribute last_success_at
+        #
+        #   @return [Time, nil]
+        optional :last_success_at, Time, api_name: :lastSuccessAt
+
+        # @!attribute success_count
+        #
+        #   @return [Integer, nil]
+        optional :success_count, Integer, api_name: :successCount
+
+        # @!attribute total_attempts
+        #
+        #   @return [Integer, nil]
+        optional :total_attempts, Integer, api_name: :totalAttempts
+
+        # @!method initialize(avg_delivery_time_ms: nil, failure_count: nil, last_success_at: nil, success_count: nil, total_attempts: nil)
+        #   Delivery metrics for this channel.
+        #
+        #   @param avg_delivery_time_ms [Float]
+        #   @param failure_count [Integer]
+        #   @param last_success_at [Time]
+        #   @param success_count [Integer]
+        #   @param total_attempts [Integer]
+      end
+    end
+  end
+end

data/lib/zavudev/models/contact_create_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Contacts#create
+    class ContactCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute channels
+      #   Communication channels for the contact.
+      #
+      #   @return [Array<Zavudev::Models::ContactCreateParams::Channel>]
+      required :channels, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::ContactCreateParams::Channel] }
+
+      # @!attribute display_name
+      #   Display name for the contact.
+      #
+      #   @return [String, nil]
+      optional :display_name, String, api_name: :displayName
+
+      # @!attribute metadata
+      #   Arbitrary metadata to associate with the contact.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Zavudev::Internal::Type::HashOf[String]
+
+      # @!method initialize(channels:, display_name: nil, metadata: nil, request_options: {})
+      #   @param channels [Array<Zavudev::Models::ContactCreateParams::Channel>] Communication channels for the contact.
+      #
+      #   @param display_name [String] Display name for the contact.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Arbitrary metadata to associate with the contact.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      class Channel < Zavudev::Internal::Type::BaseModel
+        # @!attribute channel
+        #   Channel type.
+        #
+        #   @return [Symbol, Zavudev::Models::ContactCreateParams::Channel::Channel]
+        required :channel, enum: -> { Zavudev::ContactCreateParams::Channel::Channel }
+
+        # @!attribute identifier
+        #   Channel identifier (phone number in E.164 format or email address).
+        #
+        #   @return [String]
+        required :identifier, String
+
+        # @!attribute country_code
+        #   ISO country code for phone numbers.
+        #
+        #   @return [String, nil]
+        optional :country_code, String, api_name: :countryCode
+
+        # @!attribute is_primary
+        #   Whether this should be the primary channel for its type.
+        #
+        #   @return [Boolean, nil]
+        optional :is_primary, Zavudev::Internal::Type::Boolean, api_name: :isPrimary
+
+        # @!attribute label
+        #   Optional label for the channel.
+        #
+        #   @return [String, nil]
+        optional :label, String
+
+        # @!method initialize(channel:, identifier:, country_code: nil, is_primary: nil, label: nil)
+        #   Input for creating a contact channel.
+        #
+        #   @param channel [Symbol, Zavudev::Models::ContactCreateParams::Channel::Channel] Channel type.
+        #
+        #   @param identifier [String] Channel identifier (phone number in E.164 format or email address).
+        #
+        #   @param country_code [String] ISO country code for phone numbers.
+        #
+        #   @param is_primary [Boolean] Whether this should be the primary channel for its type.
+        #
+        #   @param label [String] Optional label for the channel.
+
+        # Channel type.
+        #
+        # @see Zavudev::Models::ContactCreateParams::Channel#channel
+        module Channel
+          extend Zavudev::Internal::Type::Enum
+
+          SMS = :sms
+          WHATSAPP = :whatsapp
+          EMAIL = :email
+          TELEGRAM = :telegram
+          VOICE = :voice
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/contact_dismiss_merge_suggestion_params.rb

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

data/lib/zavudev/models/contact_merge_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Contacts#merge
+    class ContactMergeParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute contact_id
+      #
+      #   @return [String]
+      required :contact_id, String
+
+      # @!attribute source_contact_id
+      #   ID of the contact to merge into the target contact. The source contact will be
+      #   marked as merged.
+      #
+      #   @return [String]
+      required :source_contact_id, String, api_name: :sourceContactId
+
+      # @!method initialize(contact_id:, source_contact_id:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::ContactMergeParams} for more details.
+      #
+      #   @param contact_id [String]
+      #
+      #   @param source_contact_id [String] ID of the contact to merge into the target contact. The source contact will be m
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/contacts/channel_add_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Contacts
+      # @see Zavudev::Resources::Contacts::Channels#add
+      class ChannelAddParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute contact_id
+        #
+        #   @return [String]
+        required :contact_id, String
+
+        # @!attribute channel
+        #   Channel type.
+        #
+        #   @return [Symbol, Zavudev::Models::Contacts::ChannelAddParams::Channel]
+        required :channel, enum: -> { Zavudev::Contacts::ChannelAddParams::Channel }
+
+        # @!attribute identifier
+        #   Channel identifier (phone number in E.164 format or email address).
+        #
+        #   @return [String]
+        required :identifier, String
+
+        # @!attribute country_code
+        #   ISO country code for phone numbers.
+        #
+        #   @return [String, nil]
+        optional :country_code, String, api_name: :countryCode
+
+        # @!attribute is_primary
+        #   Whether this should be the primary channel for its type.
+        #
+        #   @return [Boolean, nil]
+        optional :is_primary, Zavudev::Internal::Type::Boolean, api_name: :isPrimary
+
+        # @!attribute label
+        #   Optional label for the channel.
+        #
+        #   @return [String, nil]
+        optional :label, String
+
+        # @!method initialize(contact_id:, channel:, identifier:, country_code: nil, is_primary: nil, label: nil, request_options: {})
+        #   @param contact_id [String]
+        #
+        #   @param channel [Symbol, Zavudev::Models::Contacts::ChannelAddParams::Channel] Channel type.
+        #
+        #   @param identifier [String] Channel identifier (phone number in E.164 format or email address).
+        #
+        #   @param country_code [String] ISO country code for phone numbers.
+        #
+        #   @param is_primary [Boolean] Whether this should be the primary channel for its type.
+        #
+        #   @param label [String] Optional label for the channel.
+        #
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+        # Channel type.
+        module Channel
+          extend Zavudev::Internal::Type::Enum
+
+          SMS = :sms
+          WHATSAPP = :whatsapp
+          EMAIL = :email
+          TELEGRAM = :telegram
+          VOICE = :voice
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/contacts/channel_add_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Contacts
+      # @see Zavudev::Resources::Contacts::Channels#add
+      class ChannelAddResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute channel
+        #   A communication channel for a contact.
+        #
+        #   @return [Zavudev::Models::ContactChannel]
+        required :channel, -> { Zavudev::ContactChannel }
+
+        # @!method initialize(channel:)
+        #   @param channel [Zavudev::Models::ContactChannel] A communication channel for a contact.
+      end
+    end
+  end
+end

data/lib/zavudev/models/contacts/channel_remove_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Contacts
+      # @see Zavudev::Resources::Contacts::Channels#remove
+      class ChannelRemoveParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute contact_id
+        #
+        #   @return [String]
+        required :contact_id, String
+
+        # @!attribute channel_id
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!method initialize(contact_id:, channel_id:, request_options: {})
+        #   @param contact_id [String]
+        #   @param channel_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/contacts/channel_set_primary_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Contacts
+      # @see Zavudev::Resources::Contacts::Channels#set_primary
+      class ChannelSetPrimaryParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute contact_id
+        #
+        #   @return [String]
+        required :contact_id, String
+
+        # @!attribute channel_id
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!method initialize(contact_id:, channel_id:, request_options: {})
+        #   @param contact_id [String]
+        #   @param channel_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/contacts/channel_set_primary_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Contacts
+      # @see Zavudev::Resources::Contacts::Channels#set_primary
+      class ChannelSetPrimaryResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute channel
+        #   A communication channel for a contact.
+        #
+        #   @return [Zavudev::Models::ContactChannel]
+        required :channel, -> { Zavudev::ContactChannel }
+
+        # @!method initialize(channel:)
+        #   @param channel [Zavudev::Models::ContactChannel] A communication channel for a contact.
+      end
+    end
+  end
+end

data/lib/zavudev/models/contacts/channel_update_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Contacts
+      # @see Zavudev::Resources::Contacts::Channels#update
+      class ChannelUpdateParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute contact_id
+        #
+        #   @return [String]
+        required :contact_id, String
+
+        # @!attribute channel_id
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!attribute label
+        #   Optional label for the channel. Set to null to clear.
+        #
+        #   @return [String, nil]
+        optional :label, String, nil?: true
+
+        # @!attribute metadata
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Zavudev::Internal::Type::HashOf[String]
+
+        # @!attribute verified
+        #   Whether the channel is verified.
+        #
+        #   @return [Boolean, nil]
+        optional :verified, Zavudev::Internal::Type::Boolean
+
+        # @!method initialize(contact_id:, channel_id:, label: nil, metadata: nil, verified: nil, request_options: {})
+        #   @param contact_id [String]
+        #
+        #   @param channel_id [String]
+        #
+        #   @param label [String, nil] Optional label for the channel. Set to null to clear.
+        #
+        #   @param metadata [Hash{Symbol=>String}]
+        #
+        #   @param verified [Boolean] Whether the channel is verified.
+        #
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/contacts/channel_update_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Contacts
+      # @see Zavudev::Resources::Contacts::Channels#update
+      class ChannelUpdateResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute channel
+        #   A communication channel for a contact.
+        #
+        #   @return [Zavudev::Models::ContactChannel]
+        required :channel, -> { Zavudev::ContactChannel }
+
+        # @!method initialize(channel:)
+        #   @param channel [Zavudev::Models::ContactChannel] A communication channel for a contact.
+      end
+    end
+  end
+end

data/lib/zavudev/models/data_export.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Exports#list
+    class DataExport < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute data_types
+      #
+      #   @return [Array<Symbol, Zavudev::Models::DataExport::DataType>]
+      required :data_types,
+               -> { Zavudev::Internal::Type::ArrayOf[enum: Zavudev::DataExport::DataType] },
+               api_name: :dataTypes
+
+      # @!attribute expires_at
+      #   When the export download link expires (24 hours after creation).
+      #
+      #   @return [Time]
+      required :expires_at, Time, api_name: :expiresAt
+
+      # @!attribute status
+      #   Status of a data export job.
+      #
+      #   @return [Symbol, Zavudev::Models::DataExport::Status]
+      required :status, enum: -> { Zavudev::DataExport::Status }
+
+      # @!attribute completed_at
+      #
+      #   @return [Time, nil]
+      optional :completed_at, Time, api_name: :completedAt, nil?: true
+
+      # @!attribute date_from
+      #
+      #   @return [Time, nil]
+      optional :date_from, Time, api_name: :dateFrom, nil?: true
+
+      # @!attribute date_to
+      #
+      #   @return [Time, nil]
+      optional :date_to, Time, api_name: :dateTo, nil?: true
+
+      # @!attribute download_url
+      #   URL to download the export file. Only available when status is 'completed'.
+      #
+      #   @return [String, nil]
+      optional :download_url, String, api_name: :downloadUrl, nil?: true
+
+      # @!attribute error_message
+      #   Error message if the export failed.
+      #
+      #   @return [String, nil]
+      optional :error_message, String, api_name: :errorMessage, nil?: true
+
+      # @!attribute file_size
+      #   Size of the export file in bytes.
+      #
+      #   @return [Integer, nil]
+      optional :file_size, Integer, api_name: :fileSize, nil?: true
+
+      # @!method initialize(id:, created_at:, data_types:, expires_at:, status:, completed_at: nil, date_from: nil, date_to: nil, download_url: nil, error_message: nil, file_size: nil)
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param data_types [Array<Symbol, Zavudev::Models::DataExport::DataType>]
+      #
+      #   @param expires_at [Time] When the export download link expires (24 hours after creation).
+      #
+      #   @param status [Symbol, Zavudev::Models::DataExport::Status] Status of a data export job.
+      #
+      #   @param completed_at [Time, nil]
+      #
+      #   @param date_from [Time, nil]
+      #
+      #   @param date_to [Time, nil]
+      #
+      #   @param download_url [String, nil] URL to download the export file. Only available when status is 'completed'.
+      #
+      #   @param error_message [String, nil] Error message if the export failed.
+      #
+      #   @param file_size [Integer, nil] Size of the export file in bytes.
+
+      # Types of data that can be exported.
+      module DataType
+        extend Zavudev::Internal::Type::Enum
+
+        MESSAGES = :messages
+        CONVERSATIONS = :conversations
+        WEBHOOK_DELIVERIES = :webhookDeliveries
+        AGENT_EXECUTIONS = :agentExecutions
+        ACTIVITIES = :activities
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of a data export job.
+      #
+      # @see Zavudev::Models::DataExport#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        PROCESSING = :processing
+        COMPLETED = :completed
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end