revox 0.4.0 → 0.5.0

data/lib/revox/models.rb

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

data/lib/revox/resources/campaigns.rb

@@ -196,6 +196,42 @@ module Revox
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::CampaignLaunchParams} for more details.
+      #
+      # 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.
+      #
+      # @overload launch(id, mode:, selection:, scheduled_at: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Revox::Models::CampaignLaunchResponse]
+      #
+      # @see Revox::Models::CampaignLaunchParams
+      def launch(id, params)
+        parsed, options = Revox::CampaignLaunchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["campaigns/%1$s/launch-calls", id],
+          body: parsed,
+          model: Revox::Models::CampaignLaunchResponse,
+          options: 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/lib/revox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Revox
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/revox.rb

@@ -92,6 +92,8 @@ require_relative "revox/models/campaign_export_rows_params"
 require_relative "revox/models/campaign_export_rows_response"
 require_relative "revox/models/campaign_get_rows_params"
 require_relative "revox/models/campaign_get_rows_response"
+require_relative "revox/models/campaign_launch_params"
+require_relative "revox/models/campaign_launch_response"
 require_relative "revox/models/campaign_list_params"
 require_relative "revox/models/campaign_list_response"
 require_relative "revox/models/campaign_pause_params"

data/rbi/revox/models/campaign_launch_params.rbi

@@ -0,0 +1,542 @@
+# typed: strong
+
+module Revox
+  module Models
+    class CampaignLaunchParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::CampaignLaunchParams, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Revox::CampaignLaunchParams::Mode::OrSymbol) }
+      attr_accessor :mode
+
+      sig { returns(Revox::CampaignLaunchParams::Selection) }
+      attr_reader :selection
+
+      sig do
+        params(selection: Revox::CampaignLaunchParams::Selection::OrHash).void
+      end
+      attr_writer :selection
+
+      # When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed
+      # dial session cannot be scheduled.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :scheduled_at
+
+      sig { params(scheduled_at: Time).void }
+      attr_writer :scheduled_at
+
+      sig do
+        params(
+          id: String,
+          mode: Revox::CampaignLaunchParams::Mode::OrSymbol,
+          selection: Revox::CampaignLaunchParams::Selection::OrHash,
+          scheduled_at: Time,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            mode: Revox::CampaignLaunchParams::Mode::OrSymbol,
+            selection: Revox::CampaignLaunchParams::Selection,
+            scheduled_at: Time,
+            request_options: Revox::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Mode
+        extend Revox::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Revox::CampaignLaunchParams::Mode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AI_FIRST =
+          T.let(:ai_first, Revox::CampaignLaunchParams::Mode::TaggedSymbol)
+        SPEED_DIAL =
+          T.let(:speed_dial, Revox::CampaignLaunchParams::Mode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Revox::CampaignLaunchParams::Mode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Selection < Revox::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Revox::CampaignLaunchParams::Selection,
+              Revox::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Revox::CampaignLaunchParams::Selection::Filters) }
+        attr_reader :filters
+
+        sig do
+          params(
+            filters: Revox::CampaignLaunchParams::Selection::Filters::OrHash
+          ).void
+        end
+        attr_writer :filters
+
+        sig { returns(Revox::CampaignLaunchParams::Selection::Rows) }
+        attr_reader :rows
+
+        sig do
+          params(
+            rows: Revox::CampaignLaunchParams::Selection::Rows::OrHash
+          ).void
+        end
+        attr_writer :rows
+
+        sig do
+          params(
+            filters: Revox::CampaignLaunchParams::Selection::Filters::OrHash,
+            rows: Revox::CampaignLaunchParams::Selection::Rows::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(filters:, rows:)
+        end
+
+        sig do
+          override.returns(
+            {
+              filters: Revox::CampaignLaunchParams::Selection::Filters,
+              rows: Revox::CampaignLaunchParams::Selection::Rows
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Filters < Revox::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Revox::CampaignLaunchParams::Selection::Filters,
+                Revox::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :assignee_ids
+
+          sig do
+            returns(
+              T::Array[
+                Revox::CampaignLaunchParams::Selection::Filters::Direction::OrSymbol
+              ]
+            )
+          end
+          attr_accessor :directions
+
+          sig do
+            returns(
+              T::Array[
+                Revox::CampaignLaunchParams::Selection::Filters::Outcome::OrSymbol
+              ]
+            )
+          end
+          attr_accessor :outcomes
+
+          sig do
+            returns(
+              T::Array[
+                Revox::CampaignLaunchParams::Selection::Filters::Result::OrSymbol
+              ]
+            )
+          end
+          attr_accessor :results
+
+          sig do
+            returns(
+              T::Array[
+                Revox::CampaignLaunchParams::Selection::Filters::Status::OrSymbol
+              ]
+            )
+          end
+          attr_accessor :statuses
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :query
+
+          sig { params(query: String).void }
+          attr_writer :query
+
+          sig do
+            params(
+              assignee_ids: T::Array[String],
+              directions:
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Direction::OrSymbol
+                ],
+              outcomes:
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Outcome::OrSymbol
+                ],
+              results:
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Result::OrSymbol
+                ],
+              statuses:
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Status::OrSymbol
+                ],
+              query: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            assignee_ids:,
+            directions:,
+            outcomes:,
+            results:,
+            statuses:,
+            query: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                assignee_ids: T::Array[String],
+                directions:
+                  T::Array[
+                    Revox::CampaignLaunchParams::Selection::Filters::Direction::OrSymbol
+                  ],
+                outcomes:
+                  T::Array[
+                    Revox::CampaignLaunchParams::Selection::Filters::Outcome::OrSymbol
+                  ],
+                results:
+                  T::Array[
+                    Revox::CampaignLaunchParams::Selection::Filters::Result::OrSymbol
+                  ],
+                statuses:
+                  T::Array[
+                    Revox::CampaignLaunchParams::Selection::Filters::Status::OrSymbol
+                  ],
+                query: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Direction
+            extend Revox::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Revox::CampaignLaunchParams::Selection::Filters::Direction
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INBOUND =
+              T.let(
+                :inbound,
+                Revox::CampaignLaunchParams::Selection::Filters::Direction::TaggedSymbol
+              )
+            OUTBOUND =
+              T.let(
+                :outbound,
+                Revox::CampaignLaunchParams::Selection::Filters::Direction::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Direction::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Outcome
+            extend Revox::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Revox::CampaignLaunchParams::Selection::Filters::Outcome
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NOT_INTERESTED =
+              T.let(
+                :not_interested,
+                Revox::CampaignLaunchParams::Selection::Filters::Outcome::TaggedSymbol
+              )
+            INTERESTED =
+              T.let(
+                :interested,
+                Revox::CampaignLaunchParams::Selection::Filters::Outcome::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                Revox::CampaignLaunchParams::Selection::Filters::Outcome::TaggedSymbol
+              )
+            REQUESTED_CALLBACK_LATER =
+              T.let(
+                :requested_callback_later,
+                Revox::CampaignLaunchParams::Selection::Filters::Outcome::TaggedSymbol
+              )
+            NONE =
+              T.let(
+                :none,
+                Revox::CampaignLaunchParams::Selection::Filters::Outcome::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Outcome::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Result
+            extend Revox::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Revox::CampaignLaunchParams::Selection::Filters::Result
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IVR =
+              T.let(
+                :IVR,
+                Revox::CampaignLaunchParams::Selection::Filters::Result::TaggedSymbol
+              )
+            VOICEMAIL =
+              T.let(
+                :voicemail,
+                Revox::CampaignLaunchParams::Selection::Filters::Result::TaggedSymbol
+              )
+            HUMAN =
+              T.let(
+                :human,
+                Revox::CampaignLaunchParams::Selection::Filters::Result::TaggedSymbol
+              )
+            UNKNOWN =
+              T.let(
+                :unknown,
+                Revox::CampaignLaunchParams::Selection::Filters::Result::TaggedSymbol
+              )
+            IOS_SCREENING_FILTER =
+              T.let(
+                :"ios-screening-filter",
+                Revox::CampaignLaunchParams::Selection::Filters::Result::TaggedSymbol
+              )
+            NONE =
+              T.let(
+                :none,
+                Revox::CampaignLaunchParams::Selection::Filters::Result::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Result::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Status
+            extend Revox::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Revox::CampaignLaunchParams::Selection::Filters::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INITIALIZING =
+              T.let(
+                :initializing,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            QUEUED_FOR_CALLING =
+              T.let(
+                :queued_for_calling,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            CALLING =
+              T.let(
+                :calling,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            POST_PROCESSING =
+              T.let(
+                :post_processing,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            NOT_LAUNCHED =
+              T.let(
+                :not_launched,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            SCHEDULED =
+              T.let(
+                :scheduled,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            PAUSED =
+              T.let(
+                :paused,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            CANCELLED =
+              T.let(
+                :cancelled,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+            ERRORED =
+              T.let(
+                :errored,
+                Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Filters::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        class Rows < Revox::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Revox::CampaignLaunchParams::Selection::Rows,
+                Revox::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :call_ids
+
+          sig do
+            returns(
+              Revox::CampaignLaunchParams::Selection::Rows::Mode::OrSymbol
+            )
+          end
+          attr_accessor :mode
+
+          sig do
+            params(
+              call_ids: T::Array[String],
+              mode: Revox::CampaignLaunchParams::Selection::Rows::Mode::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(call_ids:, mode:)
+          end
+
+          sig do
+            override.returns(
+              {
+                call_ids: T::Array[String],
+                mode:
+                  Revox::CampaignLaunchParams::Selection::Rows::Mode::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Mode
+            extend Revox::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Revox::CampaignLaunchParams::Selection::Rows::Mode
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ALL_EXCEPT =
+              T.let(
+                :all_except,
+                Revox::CampaignLaunchParams::Selection::Rows::Mode::TaggedSymbol
+              )
+            ONLY =
+              T.let(
+                :only,
+                Revox::CampaignLaunchParams::Selection::Rows::Mode::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Revox::CampaignLaunchParams::Selection::Rows::Mode::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end