zavudev 0.7.0 → 0.8.0

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

data/lib/zavudev/models/export_create_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Exports#create
+    class ExportCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute data_types
+      #   List of data types to include in the export.
+      #
+      #   @return [Array<Symbol, Zavudev::Models::ExportCreateParams::DataType>]
+      required :data_types,
+               -> { Zavudev::Internal::Type::ArrayOf[enum: Zavudev::ExportCreateParams::DataType] },
+               api_name: :dataTypes
+
+      # @!attribute date_from
+      #   Start date for data to export (inclusive).
+      #
+      #   @return [Time, nil]
+      optional :date_from, Time, api_name: :dateFrom
+
+      # @!attribute date_to
+      #   End date for data to export (inclusive).
+      #
+      #   @return [Time, nil]
+      optional :date_to, Time, api_name: :dateTo
+
+      # @!method initialize(data_types:, date_from: nil, date_to: nil, request_options: {})
+      #   @param data_types [Array<Symbol, Zavudev::Models::ExportCreateParams::DataType>] List of data types to include in the export.
+      #
+      #   @param date_from [Time] Start date for data to export (inclusive).
+      #
+      #   @param date_to [Time] End date for data to export (inclusive).
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # 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
+    end
+  end
+end

data/lib/zavudev/models/export_create_response.rb

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

data/lib/zavudev/models/export_list_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Exports#list
+    class ExportListParams < 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
+      #   Status of a data export job.
+      #
+      #   @return [Symbol, Zavudev::Models::ExportListParams::Status, nil]
+      optional :status, enum: -> { Zavudev::ExportListParams::Status }
+
+      # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
+      #   @param cursor [String]
+      #
+      #   @param limit [Integer]
+      #
+      #   @param status [Symbol, Zavudev::Models::ExportListParams::Status] Status of a data export job.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Status of a data export job.
+      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

data/lib/zavudev/models/export_retrieve_params.rb

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

data/lib/zavudev/models/export_retrieve_response.rb

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

data/lib/zavudev/models/invitation.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#list
+    class Invitation < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute token
+      #   Unique invitation token.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute expires_at
+      #
+      #   @return [Time]
+      required :expires_at, Time, api_name: :expiresAt
+
+      # @!attribute status
+      #   Current status of the partner invitation.
+      #
+      #   @return [Symbol, Zavudev::Models::Invitation::Status]
+      required :status, enum: -> { Zavudev::Invitation::Status }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute url
+      #   Full URL to share with the client.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute client_email
+      #
+      #   @return [String, nil]
+      optional :client_email, String, api_name: :clientEmail, nil?: true
+
+      # @!attribute client_name
+      #
+      #   @return [String, nil]
+      optional :client_name, String, api_name: :clientName, nil?: true
+
+      # @!attribute client_phone
+      #
+      #   @return [String, nil]
+      optional :client_phone, String, api_name: :clientPhone, nil?: true
+
+      # @!attribute completed_at
+      #
+      #   @return [Time, nil]
+      optional :completed_at, Time, api_name: :completedAt, nil?: true
+
+      # @!attribute phone_number_id
+      #   ID of a pre-assigned Zavu phone number for WhatsApp registration.
+      #
+      #   @return [String, nil]
+      optional :phone_number_id, String, api_name: :phoneNumberId, nil?: true
+
+      # @!attribute sender_id
+      #   ID of the sender created when invitation is completed.
+      #
+      #   @return [String, nil]
+      optional :sender_id, String, api_name: :senderId, nil?: true
+
+      # @!attribute started_at
+      #
+      #   @return [Time, nil]
+      optional :started_at, Time, api_name: :startedAt, nil?: true
+
+      # @!attribute viewed_at
+      #
+      #   @return [Time, nil]
+      optional :viewed_at, Time, api_name: :viewedAt, nil?: true
+
+      # @!method initialize(id:, token:, created_at:, expires_at:, status:, updated_at:, url:, client_email: nil, client_name: nil, client_phone: nil, completed_at: nil, phone_number_id: nil, sender_id: nil, started_at: nil, viewed_at: nil)
+      #   @param id [String]
+      #
+      #   @param token [String] Unique invitation token.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param expires_at [Time]
+      #
+      #   @param status [Symbol, Zavudev::Models::Invitation::Status] Current status of the partner invitation.
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param url [String] Full URL to share with the client.
+      #
+      #   @param client_email [String, nil]
+      #
+      #   @param client_name [String, nil]
+      #
+      #   @param client_phone [String, nil]
+      #
+      #   @param completed_at [Time, nil]
+      #
+      #   @param phone_number_id [String, nil] ID of a pre-assigned Zavu phone number for WhatsApp registration.
+      #
+      #   @param sender_id [String, nil] ID of the sender created when invitation is completed.
+      #
+      #   @param started_at [Time, nil]
+      #
+      #   @param viewed_at [Time, nil]
+
+      # Current status of the partner invitation.
+      #
+      # @see Zavudev::Models::Invitation#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+        EXPIRED = :expired
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/invitation_cancel_params.rb

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

data/lib/zavudev/models/invitation_cancel_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#cancel
+    class InvitationCancelResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute invitation
+      #
+      #   @return [Zavudev::Models::Invitation]
+      required :invitation, -> { Zavudev::Invitation }
+
+      # @!method initialize(invitation:)
+      #   @param invitation [Zavudev::Models::Invitation]
+    end
+  end
+end

data/lib/zavudev/models/invitation_create_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#create
+    class InvitationCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute allowed_phone_countries
+      #   ISO country codes for allowed phone numbers.
+      #
+      #   @return [Array<String>, nil]
+      optional :allowed_phone_countries,
+               Zavudev::Internal::Type::ArrayOf[String],
+               api_name: :allowedPhoneCountries
+
+      # @!attribute client_email
+      #   Email of the client being invited.
+      #
+      #   @return [String, nil]
+      optional :client_email, String, api_name: :clientEmail
+
+      # @!attribute client_name
+      #   Name of the client being invited.
+      #
+      #   @return [String, nil]
+      optional :client_name, String, api_name: :clientName
+
+      # @!attribute client_phone
+      #   Phone number of the client in E.164 format.
+      #
+      #   @return [String, nil]
+      optional :client_phone, String, api_name: :clientPhone
+
+      # @!attribute expires_in_days
+      #   Number of days until the invitation expires.
+      #
+      #   @return [Integer, nil]
+      optional :expires_in_days, Integer, api_name: :expiresInDays
+
+      # @!attribute phone_number_id
+      #   ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+      #   the client will use this number instead of their own.
+      #
+      #   @return [String, nil]
+      optional :phone_number_id, String, api_name: :phoneNumberId
+
+      # @!method initialize(allowed_phone_countries: nil, client_email: nil, client_name: nil, client_phone: nil, expires_in_days: nil, phone_number_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::InvitationCreateParams} for more details.
+      #
+      #   @param allowed_phone_countries [Array<String>] ISO country codes for allowed phone numbers.
+      #
+      #   @param client_email [String] Email of the client being invited.
+      #
+      #   @param client_name [String] Name of the client being invited.
+      #
+      #   @param client_phone [String] Phone number of the client in E.164 format.
+      #
+      #   @param expires_in_days [Integer] Number of days until the invitation expires.
+      #
+      #   @param phone_number_id [String] ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/invitation_create_response.rb

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

data/lib/zavudev/models/invitation_list_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Invitations#list
+    class InvitationListParams < 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 partner invitation.
+      #
+      #   @return [Symbol, Zavudev::Models::InvitationListParams::Status, nil]
+      optional :status, enum: -> { Zavudev::InvitationListParams::Status }
+
+      # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
+      #   @param cursor [String]
+      #
+      #   @param limit [Integer]
+      #
+      #   @param status [Symbol, Zavudev::Models::InvitationListParams::Status] Current status of the partner invitation.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Current status of the partner invitation.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+        EXPIRED = :expired
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end