revox 0.4.0 → 0.5.0

data/rbi/revox/models.rbi

@@ -41,6 +41,8 @@ module Revox
 
   CampaignGetRowsParams = Revox::Models::CampaignGetRowsParams
 
+  CampaignLaunchParams = Revox::Models::CampaignLaunchParams
+
   CampaignListParams = Revox::Models::CampaignListParams
 
   CampaignPauseParams = Revox::Models::CampaignPauseParams

data/rbi/revox/resources/campaigns.rbi

@@ -133,6 +133,32 @@ module Revox
       def get_rows(id, request_options: {})
       end
 
+      # Send the campaign's calls matching a selection. In ai_first mode each call is
+      # handed to the admission scheduler at the requested time and follows the retry
+      # configuration from there. In speed_dial mode a live operator session dials them,
+      # and any call waiting on an AI retry is un-scheduled first so the same contact is
+      # never dialed twice. Calls the AI is already dialing are skipped, as are calls
+      # whose attempt budget is spent.
+      sig do
+        params(
+          id: String,
+          mode: Revox::CampaignLaunchParams::Mode::OrSymbol,
+          selection: Revox::CampaignLaunchParams::Selection::OrHash,
+          scheduled_at: Time,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CampaignLaunchResponse)
+      end
+      def launch(
+        id,
+        mode:,
+        selection:,
+        # When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed
+        # dial session cannot be scheduled.
+        scheduled_at: nil,
+        request_options: {}
+      )
+      end
+
       # Pause a running campaign so no further calls are placed. In-progress calls are
       # allowed to finish; pending and scheduled calls are held until the campaign is
       # resumed. Scheduled retry timers keep counting down, so a call resumed before its

data/sig/revox/models/campaign_launch_params.rbs

@@ -0,0 +1,233 @@
+module Revox
+  module Models
+    type campaign_launch_params =
+      {
+        id: String,
+        mode: Revox::Models::CampaignLaunchParams::mode,
+        selection: Revox::CampaignLaunchParams::Selection,
+        scheduled_at: Time
+      }
+      & Revox::Internal::Type::request_parameters
+
+    class CampaignLaunchParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_accessor mode: Revox::Models::CampaignLaunchParams::mode
+
+      attr_accessor selection: Revox::CampaignLaunchParams::Selection
+
+      attr_reader scheduled_at: Time?
+
+      def scheduled_at=: (Time) -> Time
+
+      def initialize: (
+        id: String,
+        mode: Revox::Models::CampaignLaunchParams::mode,
+        selection: Revox::CampaignLaunchParams::Selection,
+        ?scheduled_at: Time,
+        ?request_options: Revox::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        mode: Revox::Models::CampaignLaunchParams::mode,
+        selection: Revox::CampaignLaunchParams::Selection,
+        scheduled_at: Time,
+        request_options: Revox::RequestOptions
+      }
+
+      type mode = :ai_first | :speed_dial
+
+      module Mode
+        extend Revox::Internal::Type::Enum
+
+        AI_FIRST: :ai_first
+        SPEED_DIAL: :speed_dial
+
+        def self?.values: -> ::Array[Revox::Models::CampaignLaunchParams::mode]
+      end
+
+      type selection =
+        {
+          filters: Revox::CampaignLaunchParams::Selection::Filters,
+          rows: Revox::CampaignLaunchParams::Selection::Rows
+        }
+
+      class Selection < Revox::Internal::Type::BaseModel
+        attr_accessor filters: Revox::CampaignLaunchParams::Selection::Filters
+
+        attr_accessor rows: Revox::CampaignLaunchParams::Selection::Rows
+
+        def initialize: (
+          filters: Revox::CampaignLaunchParams::Selection::Filters,
+          rows: Revox::CampaignLaunchParams::Selection::Rows
+        ) -> void
+
+        def to_hash: -> {
+          filters: Revox::CampaignLaunchParams::Selection::Filters,
+          rows: Revox::CampaignLaunchParams::Selection::Rows
+        }
+
+        type filters =
+          {
+            assignee_ids: ::Array[String],
+            directions: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::direction],
+            outcomes: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::outcome],
+            results: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::result],
+            statuses: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::status],
+            query: String
+          }
+
+        class Filters < Revox::Internal::Type::BaseModel
+          attr_accessor assignee_ids: ::Array[String]
+
+          attr_accessor directions: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::direction]
+
+          attr_accessor outcomes: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::outcome]
+
+          attr_accessor results: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::result]
+
+          attr_accessor statuses: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::status]
+
+          attr_reader query: String?
+
+          def query=: (String) -> String
+
+          def initialize: (
+            assignee_ids: ::Array[String],
+            directions: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::direction],
+            outcomes: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::outcome],
+            results: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::result],
+            statuses: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::status],
+            ?query: String
+          ) -> void
+
+          def to_hash: -> {
+            assignee_ids: ::Array[String],
+            directions: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::direction],
+            outcomes: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::outcome],
+            results: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::result],
+            statuses: ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::status],
+            query: String
+          }
+
+          type direction = :inbound | :outbound
+
+          module Direction
+            extend Revox::Internal::Type::Enum
+
+            INBOUND: :inbound
+            OUTBOUND: :outbound
+
+            def self?.values: -> ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::direction]
+          end
+
+          type outcome =
+            :not_interested
+            | :interested
+            | :completed
+            | :requested_callback_later
+            | :none
+
+          module Outcome
+            extend Revox::Internal::Type::Enum
+
+            NOT_INTERESTED: :not_interested
+            INTERESTED: :interested
+            COMPLETED: :completed
+            REQUESTED_CALLBACK_LATER: :requested_callback_later
+            NONE: :none
+
+            def self?.values: -> ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::outcome]
+          end
+
+          type result =
+            :IVR
+            | :voicemail
+            | :human
+            | :unknown
+            | :"ios-screening-filter"
+            | :none
+
+          module Result
+            extend Revox::Internal::Type::Enum
+
+            IVR: :IVR
+            VOICEMAIL: :voicemail
+            HUMAN: :human
+            UNKNOWN: :unknown
+            IOS_SCREENING_FILTER: :"ios-screening-filter"
+            NONE: :none
+
+            def self?.values: -> ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::result]
+          end
+
+          type status =
+            :initializing
+            | :queued_for_calling
+            | :calling
+            | :post_processing
+            | :not_launched
+            | :scheduled
+            | :paused
+            | :completed
+            | :cancelled
+            | :errored
+
+          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
+
+            def self?.values: -> ::Array[Revox::Models::CampaignLaunchParams::Selection::Filters::status]
+          end
+        end
+
+        type rows =
+          {
+            call_ids: ::Array[String],
+            mode: Revox::Models::CampaignLaunchParams::Selection::Rows::mode
+          }
+
+        class Rows < Revox::Internal::Type::BaseModel
+          attr_accessor call_ids: ::Array[String]
+
+          attr_accessor mode: Revox::Models::CampaignLaunchParams::Selection::Rows::mode
+
+          def initialize: (
+            call_ids: ::Array[String],
+            mode: Revox::Models::CampaignLaunchParams::Selection::Rows::mode
+          ) -> void
+
+          def to_hash: -> {
+            call_ids: ::Array[String],
+            mode: Revox::Models::CampaignLaunchParams::Selection::Rows::mode
+          }
+
+          type mode = :all_except | :only
+
+          module Mode
+            extend Revox::Internal::Type::Enum
+
+            ALL_EXCEPT: :all_except
+            ONLY: :only
+
+            def self?.values: -> ::Array[Revox::Models::CampaignLaunchParams::Selection::Rows::mode]
+          end
+        end
+      end
+    end
+  end
+end