revox 0.1.0 → 0.3.0

data/lib/revox/models/call_export_params.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Call#export
+    class CallExportParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #
+      #   @return [Revox::Models::CallExportParams::Filters]
+      required :filters, -> { Revox::CallExportParams::Filters }
+
+      # @!attribute include_metadata
+      #   Whether to include the metadata in the CSV file. These are the fields you
+      #   (optionally) attached when placing the call.
+      #
+      #   @return [Boolean, nil]
+      optional :include_metadata, Revox::Internal::Type::Boolean
+
+      # @!attribute include_structured_output_fields
+      #   Whether to include the structured output fields in the CSV file. These are
+      #   generated by our AI agent during call analysis phase.
+      #
+      #   @return [Boolean, nil]
+      optional :include_structured_output_fields, Revox::Internal::Type::Boolean
+
+      # @!method initialize(filters:, include_metadata: nil, include_structured_output_fields: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Revox::Models::CallExportParams} for more details.
+      #
+      #   @param filters [Revox::Models::CallExportParams::Filters]
+      #
+      #   @param include_metadata [Boolean] Whether to include the metadata in the CSV file. These are the fields you (optio
+      #
+      #   @param include_structured_output_fields [Boolean] Whether to include the structured output fields in the CSV file. These are gener
+      #
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+
+      class Filters < Revox::Internal::Type::BaseModel
+        # @!attribute assignee_ids
+        #
+        #   @return [Array<String>]
+        required :assignee_ids, Revox::Internal::Type::ArrayOf[String]
+
+        # @!attribute assistant_ids
+        #
+        #   @return [Array<String>]
+        required :assistant_ids, Revox::Internal::Type::ArrayOf[String]
+
+        # @!attribute campaign_ids
+        #
+        #   @return [Array<String>]
+        required :campaign_ids, Revox::Internal::Type::ArrayOf[String]
+
+        # @!attribute directions
+        #
+        #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Direction>]
+        required :directions,
+                 -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Direction] }
+
+        # @!attribute from_phone_numbers
+        #
+        #   @return [Array<String>]
+        required :from_phone_numbers, Revox::Internal::Type::ArrayOf[String]
+
+        # @!attribute outcomes
+        #
+        #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Outcome>]
+        required :outcomes, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Outcome] }
+
+        # @!attribute page
+        #
+        #   @return [Integer]
+        required :page, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute results
+        #
+        #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Result>]
+        required :results, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Result] }
+
+        # @!attribute statuses
+        #
+        #   @return [Array<Symbol, Revox::Models::CallExportParams::Filters::Status>]
+        required :statuses, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallExportParams::Filters::Status] }
+
+        # @!attribute call_ids
+        #
+        #   @return [Array<String>, nil]
+        optional :call_ids, Revox::Internal::Type::ArrayOf[String]
+
+        # @!attribute query
+        #
+        #   @return [String, nil]
+        optional :query, String
+
+        # @!attribute sort_by
+        #
+        #   @return [String, nil]
+        optional :sort_by, String
+
+        # @!attribute sort_direction
+        #
+        #   @return [Symbol, Revox::Models::CallExportParams::Filters::SortDirection, nil]
+        optional :sort_direction, enum: -> { Revox::CallExportParams::Filters::SortDirection }
+
+        # @!attribute to_phone_number
+        #
+        #   @return [String, nil]
+        optional :to_phone_number, String
+
+        # @!method initialize(assignee_ids:, assistant_ids:, campaign_ids:, directions:, from_phone_numbers:, outcomes:, page:, page_size:, results:, statuses:, call_ids: nil, query: nil, sort_by: nil, sort_direction: nil, to_phone_number: nil)
+        #   @param assignee_ids [Array<String>]
+        #   @param assistant_ids [Array<String>]
+        #   @param campaign_ids [Array<String>]
+        #   @param directions [Array<Symbol, Revox::Models::CallExportParams::Filters::Direction>]
+        #   @param from_phone_numbers [Array<String>]
+        #   @param outcomes [Array<Symbol, Revox::Models::CallExportParams::Filters::Outcome>]
+        #   @param page [Integer]
+        #   @param page_size [Integer]
+        #   @param results [Array<Symbol, Revox::Models::CallExportParams::Filters::Result>]
+        #   @param statuses [Array<Symbol, Revox::Models::CallExportParams::Filters::Status>]
+        #   @param call_ids [Array<String>]
+        #   @param query [String]
+        #   @param sort_by [String]
+        #   @param sort_direction [Symbol, Revox::Models::CallExportParams::Filters::SortDirection]
+        #   @param to_phone_number [String]
+
+        module Direction
+          extend Revox::Internal::Type::Enum
+
+          INBOUND = :inbound
+          OUTBOUND = :outbound
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Outcome
+          extend Revox::Internal::Type::Enum
+
+          NOT_INTERESTED = :not_interested
+          INTERESTED = :interested
+          COMPLETED = :completed
+          REQUESTED_CALLBACK_LATER = :requested_callback_later
+          REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
+          DO_NOT_CONTACT = :do_not_contact
+          AI_AVERSE = :ai_averse
+          NONE = :none
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Result
+          extend Revox::Internal::Type::Enum
+
+          IVR = :IVR
+          VOICEMAIL = :voicemail
+          HUMAN = :human
+          UNKNOWN = :unknown
+          IOS_SCREENING_FILTER = :"ios-screening-filter"
+          NONE = :none
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Status
+          extend Revox::Internal::Type::Enum
+
+          INITIALIZING = :initializing
+          QUEUED_FOR_CALLING = :queued_for_calling
+          CALLING = :calling
+          POST_PROCESSING = :post_processing
+          SCHEDULED = :scheduled
+          PAUSED = :paused
+          COMPLETED = :completed
+          CANCELLED = :cancelled
+          ERRORED = :errored
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Revox::Models::CallExportParams::Filters#sort_direction
+        module SortDirection
+          extend Revox::Internal::Type::Enum
+
+          ASC = :asc
+          DESC = :desc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/revox/models/call_export_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Call#export
+    class CallExportResponse < Revox::Internal::Type::BaseModel
+      # @!attribute csv
+      #
+      #   @return [String]
+      required :csv, String
+
+      # @!attribute filename
+      #
+      #   @return [String]
+      required :filename, String
+
+      # @!method initialize(csv:, filename:)
+      #   @param csv [String]
+      #   @param filename [String]
+    end
+  end
+end

data/lib/revox/models/call_pause_params.rb

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

data/lib/revox/models/call_pause_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Call#pause
+    class CallPauseResponse < Revox::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Revox::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/revox/models/call_phone_history_params.rb

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

data/lib/revox/models/call_phone_history_response.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Call#phone_history
+    class CallPhoneHistoryResponse < Revox::Internal::Type::BaseModel
+      # @!attribute phone_history
+      #
+      #   @return [Hash{Symbol=>Revox::Models::CallPhoneHistoryResponse::PhoneHistory}]
+      required :phone_history,
+               -> { Revox::Internal::Type::HashOf[Revox::Models::CallPhoneHistoryResponse::PhoneHistory] }
+
+      # @!method initialize(phone_history:)
+      #   @param phone_history [Hash{Symbol=>Revox::Models::CallPhoneHistoryResponse::PhoneHistory}]
+
+      class PhoneHistory < Revox::Internal::Type::BaseModel
+        # @!attribute campaigns
+        #
+        #   @return [Array<Revox::Models::CallPhoneHistoryResponse::PhoneHistory::Campaign>]
+        required :campaigns,
+                 -> { Revox::Internal::Type::ArrayOf[Revox::Models::CallPhoneHistoryResponse::PhoneHistory::Campaign] }
+
+        # @!attribute count
+        #
+        #   @return [Float]
+        required :count, Float
+
+        # @!attribute do_not_contact
+        #
+        #   @return [Boolean]
+        required :do_not_contact, Revox::Internal::Type::Boolean
+
+        # @!attribute hot
+        #
+        #   @return [Boolean]
+        required :hot, Revox::Internal::Type::Boolean
+
+        # @!attribute last_called_at
+        #
+        #   @return [String, nil]
+        required :last_called_at, String, nil?: true
+
+        # @!attribute last_outcome
+        #
+        #   @return [Symbol, Revox::Models::CallPhoneHistoryResponse::PhoneHistory::LastOutcome, nil]
+        required :last_outcome,
+                 enum: -> { Revox::Models::CallPhoneHistoryResponse::PhoneHistory::LastOutcome },
+                 nil?: true
+
+        # @!attribute reached_human
+        #
+        #   @return [Boolean]
+        required :reached_human, Revox::Internal::Type::Boolean
+
+        # @!method initialize(campaigns:, count:, do_not_contact:, hot:, last_called_at:, last_outcome:, reached_human:)
+        #   @param campaigns [Array<Revox::Models::CallPhoneHistoryResponse::PhoneHistory::Campaign>]
+        #   @param count [Float]
+        #   @param do_not_contact [Boolean]
+        #   @param hot [Boolean]
+        #   @param last_called_at [String, nil]
+        #   @param last_outcome [Symbol, Revox::Models::CallPhoneHistoryResponse::PhoneHistory::LastOutcome, nil]
+        #   @param reached_human [Boolean]
+
+        class Campaign < Revox::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(id:, name:)
+          #   @param id [String]
+          #   @param name [String]
+        end
+
+        # @see Revox::Models::CallPhoneHistoryResponse::PhoneHistory#last_outcome
+        module LastOutcome
+          extend Revox::Internal::Type::Enum
+
+          NOT_INTERESTED = :not_interested
+          INTERESTED = :interested
+          COMPLETED = :completed
+          REQUESTED_CALLBACK_LATER = :requested_callback_later
+          REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
+          DO_NOT_CONTACT = :do_not_contact
+          AI_AVERSE = :ai_averse
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/revox/models/call_resume_params.rb

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

data/lib/revox/models/call_resume_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Call#resume
+    class CallResumeResponse < Revox::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Revox::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end