revox 0.3.0 → 0.5.0

data/lib/revox/models/campaign_launch_params.rb

@@ -12,9 +12,190 @@ module Revox
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute mode
+      #
+      #   @return [Symbol, Revox::Models::CampaignLaunchParams::Mode]
+      required :mode, enum: -> { Revox::CampaignLaunchParams::Mode }
+
+      # @!attribute selection
+      #
+      #   @return [Revox::Models::CampaignLaunchParams::Selection]
+      required :selection, -> { Revox::CampaignLaunchParams::Selection }
+
+      # @!attribute scheduled_at
+      #   When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed
+      #   dial session cannot be scheduled.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time
+
+      # @!method initialize(id:, mode:, selection:, scheduled_at: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Revox::Models::CampaignLaunchParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param mode [Symbol, Revox::Models::CampaignLaunchParams::Mode]
+      #
+      #   @param selection [Revox::Models::CampaignLaunchParams::Selection]
+      #
+      #   @param scheduled_at [Time] When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed
+      #
       #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+
+      module Mode
+        extend Revox::Internal::Type::Enum
+
+        AI_FIRST = :ai_first
+        SPEED_DIAL = :speed_dial
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Selection < Revox::Internal::Type::BaseModel
+        # @!attribute filters
+        #
+        #   @return [Revox::Models::CampaignLaunchParams::Selection::Filters]
+        required :filters, -> { Revox::CampaignLaunchParams::Selection::Filters }
+
+        # @!attribute rows
+        #
+        #   @return [Revox::Models::CampaignLaunchParams::Selection::Rows]
+        required :rows, -> { Revox::CampaignLaunchParams::Selection::Rows }
+
+        # @!method initialize(filters:, rows:)
+        #   @param filters [Revox::Models::CampaignLaunchParams::Selection::Filters]
+        #   @param rows [Revox::Models::CampaignLaunchParams::Selection::Rows]
+
+        # @see Revox::Models::CampaignLaunchParams::Selection#filters
+        class Filters < Revox::Internal::Type::BaseModel
+          # @!attribute assignee_ids
+          #
+          #   @return [Array<String>]
+          required :assignee_ids, Revox::Internal::Type::ArrayOf[String]
+
+          # @!attribute directions
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Direction>]
+          required :directions,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Direction] }
+
+          # @!attribute outcomes
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Outcome>]
+          required :outcomes,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Outcome] }
+
+          # @!attribute results
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Result>]
+          required :results,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Result] }
+
+          # @!attribute statuses
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Status>]
+          required :statuses,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Status] }
+
+          # @!attribute query
+          #
+          #   @return [String, nil]
+          optional :query, String
+
+          # @!method initialize(assignee_ids:, directions:, outcomes:, results:, statuses:, query: nil)
+          #   @param assignee_ids [Array<String>]
+          #   @param directions [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Direction>]
+          #   @param outcomes [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Outcome>]
+          #   @param results [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Result>]
+          #   @param statuses [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Status>]
+          #   @param query [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
+            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
+            NOT_LAUNCHED = :not_launched
+            SCHEDULED = :scheduled
+            PAUSED = :paused
+            COMPLETED = :completed
+            CANCELLED = :cancelled
+            ERRORED = :errored
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Revox::Models::CampaignLaunchParams::Selection#rows
+        class Rows < Revox::Internal::Type::BaseModel
+          # @!attribute call_ids
+          #
+          #   @return [Array<String>]
+          required :call_ids, Revox::Internal::Type::ArrayOf[String]
+
+          # @!attribute mode
+          #
+          #   @return [Symbol, Revox::Models::CampaignLaunchParams::Selection::Rows::Mode]
+          required :mode, enum: -> { Revox::CampaignLaunchParams::Selection::Rows::Mode }
+
+          # @!method initialize(call_ids:, mode:)
+          #   @param call_ids [Array<String>]
+          #   @param mode [Symbol, Revox::Models::CampaignLaunchParams::Selection::Rows::Mode]
+
+          # @see Revox::Models::CampaignLaunchParams::Selection::Rows#mode
+          module Mode
+            extend Revox::Internal::Type::Enum
+
+            ALL_EXCEPT = :all_except
+            ONLY = :only
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
     end
   end
 end