revox 0.2.0 → 0.3.0

data/lib/revox/models/call_search_params.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Call#search
+    class CallSearchParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!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::CallSearchParams::Direction>]
+      required :directions, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallSearchParams::Direction] }
+
+      # @!attribute from_phone_numbers
+      #
+      #   @return [Array<String>]
+      required :from_phone_numbers, Revox::Internal::Type::ArrayOf[String]
+
+      # @!attribute outcomes
+      #
+      #   @return [Array<Symbol, Revox::Models::CallSearchParams::Outcome>]
+      required :outcomes, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallSearchParams::Outcome] }
+
+      # @!attribute page
+      #
+      #   @return [Integer]
+      required :page, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute results
+      #
+      #   @return [Array<Symbol, Revox::Models::CallSearchParams::Result>]
+      required :results, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallSearchParams::Result] }
+
+      # @!attribute statuses
+      #
+      #   @return [Array<Symbol, Revox::Models::CallSearchParams::Status>]
+      required :statuses, -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallSearchParams::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::CallSearchParams::SortDirection, nil]
+      optional :sort_direction, enum: -> { Revox::CallSearchParams::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, request_options: {})
+      #   @param assignee_ids [Array<String>]
+      #   @param assistant_ids [Array<String>]
+      #   @param campaign_ids [Array<String>]
+      #   @param directions [Array<Symbol, Revox::Models::CallSearchParams::Direction>]
+      #   @param from_phone_numbers [Array<String>]
+      #   @param outcomes [Array<Symbol, Revox::Models::CallSearchParams::Outcome>]
+      #   @param page [Integer]
+      #   @param page_size [Integer]
+      #   @param results [Array<Symbol, Revox::Models::CallSearchParams::Result>]
+      #   @param statuses [Array<Symbol, Revox::Models::CallSearchParams::Status>]
+      #   @param call_ids [Array<String>]
+      #   @param query [String]
+      #   @param sort_by [String]
+      #   @param sort_direction [Symbol, Revox::Models::CallSearchParams::SortDirection]
+      #   @param to_phone_number [String]
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+
+      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
+
+      module SortDirection
+        extend Revox::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end