revox 0.1.0 → 0.3.0

data/sig/revox/models/campaign_statistics_params.rbs

@@ -0,0 +1,20 @@
+module Revox
+  module Models
+    type campaign_statistics_params =
+      { id: String } & Revox::Internal::Type::request_parameters
+
+    class CampaignStatisticsParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Revox::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Revox::RequestOptions }
+    end
+  end
+end

data/sig/revox/models/campaign_statistics_response.rbs

@@ -0,0 +1,458 @@
+module Revox
+  module Models
+    type campaign_statistics_response =
+      { statistics: Revox::Models::CampaignStatisticsResponse::Statistics }
+
+    class CampaignStatisticsResponse < Revox::Internal::Type::BaseModel
+      attr_accessor statistics: Revox::Models::CampaignStatisticsResponse::Statistics
+
+      def initialize: (
+        statistics: Revox::Models::CampaignStatisticsResponse::Statistics
+      ) -> void
+
+      def to_hash: -> {
+        statistics: Revox::Models::CampaignStatisticsResponse::Statistics
+      }
+
+      type statistics =
+        {
+          campaign: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign,
+          data_extraction: Revox::Models::CampaignStatisticsResponse::Statistics::DataExtraction?,
+          effort: Revox::Models::CampaignStatisticsResponse::Statistics::Effort,
+          funnel: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel,
+          hot_lead_outcomes: ::Array[String],
+          inbound: Revox::Models::CampaignStatisticsResponse::Statistics::Inbound,
+          leads: Revox::Models::CampaignStatisticsResponse::Statistics::Leads,
+          outcome_breakdown: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::OutcomeBreakdown]
+        }
+
+      class Statistics < Revox::Internal::Type::BaseModel
+        attr_accessor campaign: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign
+
+        attr_accessor data_extraction: Revox::Models::CampaignStatisticsResponse::Statistics::DataExtraction?
+
+        attr_accessor effort: Revox::Models::CampaignStatisticsResponse::Statistics::Effort
+
+        attr_accessor funnel: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel
+
+        attr_accessor hot_lead_outcomes: ::Array[String]
+
+        attr_accessor inbound: Revox::Models::CampaignStatisticsResponse::Statistics::Inbound
+
+        attr_accessor leads: Revox::Models::CampaignStatisticsResponse::Statistics::Leads
+
+        attr_accessor outcome_breakdown: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::OutcomeBreakdown]
+
+        def initialize: (
+          campaign: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign,
+          data_extraction: Revox::Models::CampaignStatisticsResponse::Statistics::DataExtraction?,
+          effort: Revox::Models::CampaignStatisticsResponse::Statistics::Effort,
+          funnel: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel,
+          hot_lead_outcomes: ::Array[String],
+          inbound: Revox::Models::CampaignStatisticsResponse::Statistics::Inbound,
+          leads: Revox::Models::CampaignStatisticsResponse::Statistics::Leads,
+          outcome_breakdown: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::OutcomeBreakdown]
+        ) -> void
+
+        def to_hash: -> {
+          campaign: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign,
+          data_extraction: Revox::Models::CampaignStatisticsResponse::Statistics::DataExtraction?,
+          effort: Revox::Models::CampaignStatisticsResponse::Statistics::Effort,
+          funnel: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel,
+          hot_lead_outcomes: ::Array[String],
+          inbound: Revox::Models::CampaignStatisticsResponse::Statistics::Inbound,
+          leads: Revox::Models::CampaignStatisticsResponse::Statistics::Leads,
+          outcome_breakdown: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::OutcomeBreakdown]
+        }
+
+        type campaign =
+          {
+            id: String,
+            agent_name: String?,
+            first_activity_at: top,
+            has_activity: bool,
+            is_cancelled: bool,
+            last_activity_at: top,
+            max_attempts_per_contact: Float?,
+            name: String,
+            status: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::status,
+            timezone: String
+          }
+
+        class Campaign < Revox::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor agent_name: String?
+
+          attr_accessor first_activity_at: top
+
+          attr_accessor has_activity: bool
+
+          attr_accessor is_cancelled: bool
+
+          attr_accessor last_activity_at: top
+
+          attr_accessor max_attempts_per_contact: Float?
+
+          attr_accessor name: String
+
+          attr_accessor status: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::status
+
+          attr_accessor timezone: String
+
+          def initialize: (
+            id: String,
+            agent_name: String?,
+            first_activity_at: top,
+            has_activity: bool,
+            is_cancelled: bool,
+            last_activity_at: top,
+            max_attempts_per_contact: Float?,
+            name: String,
+            status: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::status,
+            timezone: String
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            agent_name: String?,
+            first_activity_at: top,
+            has_activity: bool,
+            is_cancelled: bool,
+            last_activity_at: top,
+            max_attempts_per_contact: Float?,
+            name: String,
+            status: Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::status,
+            timezone: String
+          }
+
+          type status = :draft | :running | :paused | :completed
+
+          module Status
+            extend Revox::Internal::Type::Enum
+
+            DRAFT: :draft
+            RUNNING: :running
+            PAUSED: :paused
+            COMPLETED: :completed
+
+            def self?.values: -> ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::status]
+          end
+        end
+
+        type data_extraction = { fields: ::Array[String], intro: String }
+
+        class DataExtraction < Revox::Internal::Type::BaseModel
+          attr_accessor fields: ::Array[String]
+
+          attr_accessor intro: String
+
+          def initialize: (fields: ::Array[String], intro: String) -> void
+
+          def to_hash: -> { fields: ::Array[String], intro: String }
+        end
+
+        type effort =
+          { calls_total: Float, inbound_calls: Float, outbound_attempts: Float }
+
+        class Effort < Revox::Internal::Type::BaseModel
+          attr_accessor calls_total: Float
+
+          attr_accessor inbound_calls: Float
+
+          attr_accessor outbound_attempts: Float
+
+          def initialize: (
+            calls_total: Float,
+            inbound_calls: Float,
+            outbound_attempts: Float
+          ) -> void
+
+          def to_hash: -> {
+            calls_total: Float,
+            inbound_calls: Float,
+            outbound_attempts: Float
+          }
+        end
+
+        type funnel =
+          {
+            called: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Called,
+            hot_leads: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::HotLeads,
+            reached: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Reached,
+            real_exchanges: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::RealExchanges
+          }
+
+        class Funnel < Revox::Internal::Type::BaseModel
+          attr_accessor called: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Called
+
+          attr_accessor hot_leads: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::HotLeads
+
+          attr_accessor reached: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Reached
+
+          attr_accessor real_exchanges: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::RealExchanges
+
+          def initialize: (
+            called: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Called,
+            hot_leads: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::HotLeads,
+            reached: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Reached,
+            real_exchanges: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::RealExchanges
+          ) -> void
+
+          def to_hash: -> {
+            called: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Called,
+            hot_leads: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::HotLeads,
+            reached: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Reached,
+            real_exchanges: Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::RealExchanges
+          }
+
+          type called = { count: Float, imported_rows: Float }
+
+          class Called < Revox::Internal::Type::BaseModel
+            attr_accessor count: Float
+
+            attr_accessor imported_rows: Float
+
+            def initialize: (count: Float, imported_rows: Float) -> void
+
+            def to_hash: -> { count: Float, imported_rows: Float }
+          end
+
+          type hot_leads = { count: Float, pct_of_reached: Float? }
+
+          class HotLeads < Revox::Internal::Type::BaseModel
+            attr_accessor count: Float
+
+            attr_accessor pct_of_reached: Float?
+
+            def initialize: (count: Float, pct_of_reached: Float?) -> void
+
+            def to_hash: -> { count: Float, pct_of_reached: Float? }
+          end
+
+          type reached =
+            {
+              count: Float,
+              inbound: Float,
+              outbound: Float,
+              overlap: Float,
+              pct_of_called: Float?
+            }
+
+          class Reached < Revox::Internal::Type::BaseModel
+            attr_accessor count: Float
+
+            attr_accessor inbound: Float
+
+            attr_accessor outbound: Float
+
+            attr_accessor overlap: Float
+
+            attr_accessor pct_of_called: Float?
+
+            def initialize: (
+              count: Float,
+              inbound: Float,
+              outbound: Float,
+              overlap: Float,
+              pct_of_called: Float?
+            ) -> void
+
+            def to_hash: -> {
+              count: Float,
+              inbound: Float,
+              outbound: Float,
+              overlap: Float,
+              pct_of_called: Float?
+            }
+          end
+
+          type real_exchanges = { count: Float, pct_of_reached: Float? }
+
+          class RealExchanges < Revox::Internal::Type::BaseModel
+            attr_accessor count: Float
+
+            attr_accessor pct_of_reached: Float?
+
+            def initialize: (count: Float, pct_of_reached: Float?) -> void
+
+            def to_hash: -> { count: Float, pct_of_reached: Float? }
+          end
+        end
+
+        type inbound = { unique_callers: Float }
+
+        class Inbound < Revox::Internal::Type::BaseModel
+          attr_accessor unique_callers: Float
+
+          def initialize: (unique_callers: Float) -> void
+
+          def to_hash: -> { unique_callers: Float }
+        end
+
+        type leads =
+          {
+            hot: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot],
+            warm: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm]
+          }
+
+        class Leads < Revox::Internal::Type::BaseModel
+          attr_accessor hot: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot]
+
+          attr_accessor warm: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm]
+
+          def initialize: (
+            hot: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot],
+            warm: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm]
+          ) -> void
+
+          def to_hash: -> {
+            hot: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot],
+            warm: ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm]
+          }
+
+          type hot =
+            {
+              attempt_id: String?,
+              call_id: String,
+              direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::direction,
+              email: String?,
+              last_activity_at: top,
+              name: String,
+              phone: String,
+              summary: String?
+            }
+
+          class Hot < Revox::Internal::Type::BaseModel
+            attr_accessor attempt_id: String?
+
+            attr_accessor call_id: String
+
+            attr_accessor direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::direction
+
+            attr_accessor email: String?
+
+            attr_accessor last_activity_at: top
+
+            attr_accessor name: String
+
+            attr_accessor phone: String
+
+            attr_accessor summary: String?
+
+            def initialize: (
+              attempt_id: String?,
+              call_id: String,
+              direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::direction,
+              email: String?,
+              last_activity_at: top,
+              name: String,
+              phone: String,
+              summary: String?
+            ) -> void
+
+            def to_hash: -> {
+              attempt_id: String?,
+              call_id: String,
+              direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::direction,
+              email: String?,
+              last_activity_at: top,
+              name: String,
+              phone: String,
+              summary: String?
+            }
+
+            type direction = :inbound | :outbound
+
+            module Direction
+              extend Revox::Internal::Type::Enum
+
+              INBOUND: :inbound
+              OUTBOUND: :outbound
+
+              def self?.values: -> ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::direction]
+            end
+          end
+
+          type warm =
+            {
+              attempt_id: String?,
+              call_id: String,
+              direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::direction,
+              email: String?,
+              last_activity_at: top,
+              name: String,
+              phone: String,
+              summary: String?
+            }
+
+          class Warm < Revox::Internal::Type::BaseModel
+            attr_accessor attempt_id: String?
+
+            attr_accessor call_id: String
+
+            attr_accessor direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::direction
+
+            attr_accessor email: String?
+
+            attr_accessor last_activity_at: top
+
+            attr_accessor name: String
+
+            attr_accessor phone: String
+
+            attr_accessor summary: String?
+
+            def initialize: (
+              attempt_id: String?,
+              call_id: String,
+              direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::direction,
+              email: String?,
+              last_activity_at: top,
+              name: String,
+              phone: String,
+              summary: String?
+            ) -> void
+
+            def to_hash: -> {
+              attempt_id: String?,
+              call_id: String,
+              direction: Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::direction,
+              email: String?,
+              last_activity_at: top,
+              name: String,
+              phone: String,
+              summary: String?
+            }
+
+            type direction = :inbound | :outbound
+
+            module Direction
+              extend Revox::Internal::Type::Enum
+
+              INBOUND: :inbound
+              OUTBOUND: :outbound
+
+              def self?.values: -> ::Array[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::direction]
+            end
+          end
+        end
+
+        type outcome_breakdown =
+          { count: Float, label: String, outcome: String }
+
+        class OutcomeBreakdown < Revox::Internal::Type::BaseModel
+          attr_accessor count: Float
+
+          attr_accessor label: String
+
+          attr_accessor outcome: String
+
+          def initialize: (count: Float, label: String, outcome: String) -> void
+
+          def to_hash: -> { count: Float, label: String, outcome: String }
+        end
+      end
+    end
+  end
+end

data/sig/revox/models/campaign_update_params.rbs

@@ -0,0 +1,203 @@
+module Revox
+  module Models
+    type campaign_update_params =
+      {
+        id: String,
+        assistant_id: String,
+        call_retry_config: Revox::CampaignUpdateParams::CallRetryConfig?,
+        contacts: ::Array[Revox::CampaignUpdateParams::Contact],
+        from_phone_number: String?,
+        max_concurrent_calls: Float?,
+        name: String,
+        scheduled_at: Revox::Models::CampaignUpdateParams::scheduled_at?,
+        type: Revox::Models::CampaignUpdateParams::type_
+      }
+      & Revox::Internal::Type::request_parameters
+
+    class CampaignUpdateParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_reader assistant_id: String?
+
+      def assistant_id=: (String) -> String
+
+      attr_accessor call_retry_config: Revox::CampaignUpdateParams::CallRetryConfig?
+
+      attr_reader contacts: ::Array[Revox::CampaignUpdateParams::Contact]?
+
+      def contacts=: (
+        ::Array[Revox::CampaignUpdateParams::Contact]
+      ) -> ::Array[Revox::CampaignUpdateParams::Contact]
+
+      attr_accessor from_phone_number: String?
+
+      attr_accessor max_concurrent_calls: Float?
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      attr_accessor scheduled_at: Revox::Models::CampaignUpdateParams::scheduled_at?
+
+      attr_reader type: Revox::Models::CampaignUpdateParams::type_?
+
+      def type=: (
+        Revox::Models::CampaignUpdateParams::type_
+      ) -> Revox::Models::CampaignUpdateParams::type_
+
+      def initialize: (
+        id: String,
+        ?assistant_id: String,
+        ?call_retry_config: Revox::CampaignUpdateParams::CallRetryConfig?,
+        ?contacts: ::Array[Revox::CampaignUpdateParams::Contact],
+        ?from_phone_number: String?,
+        ?max_concurrent_calls: Float?,
+        ?name: String,
+        ?scheduled_at: Revox::Models::CampaignUpdateParams::scheduled_at?,
+        ?type: Revox::Models::CampaignUpdateParams::type_,
+        ?request_options: Revox::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        assistant_id: String,
+        call_retry_config: Revox::CampaignUpdateParams::CallRetryConfig?,
+        contacts: ::Array[Revox::CampaignUpdateParams::Contact],
+        from_phone_number: String?,
+        max_concurrent_calls: Float?,
+        name: String,
+        scheduled_at: Revox::Models::CampaignUpdateParams::scheduled_at?,
+        type: Revox::Models::CampaignUpdateParams::type_,
+        request_options: Revox::RequestOptions
+      }
+
+      type call_retry_config =
+        {
+          allowed_days: ::Array[Revox::Models::CampaignUpdateParams::CallRetryConfig::allowed_day],
+          call_twice_in_a_row: bool,
+          calling_windows: ::Array[Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow],
+          max_retry_attempts: Integer,
+          timezone: String?
+        }
+
+      class CallRetryConfig < Revox::Internal::Type::BaseModel
+        attr_accessor allowed_days: ::Array[Revox::Models::CampaignUpdateParams::CallRetryConfig::allowed_day]
+
+        attr_accessor call_twice_in_a_row: bool
+
+        attr_accessor calling_windows: ::Array[Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow]
+
+        attr_accessor max_retry_attempts: Integer
+
+        attr_accessor timezone: String?
+
+        def initialize: (
+          allowed_days: ::Array[Revox::Models::CampaignUpdateParams::CallRetryConfig::allowed_day],
+          call_twice_in_a_row: bool,
+          calling_windows: ::Array[Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow],
+          max_retry_attempts: Integer,
+          ?timezone: String?
+        ) -> void
+
+        def to_hash: -> {
+          allowed_days: ::Array[Revox::Models::CampaignUpdateParams::CallRetryConfig::allowed_day],
+          call_twice_in_a_row: bool,
+          calling_windows: ::Array[Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow],
+          max_retry_attempts: Integer,
+          timezone: String?
+        }
+
+        type allowed_day =
+          :monday
+          | :tuesday
+          | :wednesday
+          | :thursday
+          | :friday
+          | :saturday
+          | :sunday
+
+        module AllowedDay
+          extend Revox::Internal::Type::Enum
+
+          MONDAY: :monday
+          TUESDAY: :tuesday
+          WEDNESDAY: :wednesday
+          THURSDAY: :thursday
+          FRIDAY: :friday
+          SATURDAY: :saturday
+          SUNDAY: :sunday
+
+          def self?.values: -> ::Array[Revox::Models::CampaignUpdateParams::CallRetryConfig::allowed_day]
+        end
+
+        type calling_window =
+          {
+            calling_window_end_time: String,
+            calling_window_start_time: String,
+            retry_delay_seconds: Integer
+          }
+
+        class CallingWindow < Revox::Internal::Type::BaseModel
+          attr_accessor calling_window_end_time: String
+
+          attr_accessor calling_window_start_time: String
+
+          attr_accessor retry_delay_seconds: Integer
+
+          def initialize: (
+            calling_window_end_time: String,
+            calling_window_start_time: String,
+            retry_delay_seconds: Integer
+          ) -> void
+
+          def to_hash: -> {
+            calling_window_end_time: String,
+            calling_window_start_time: String,
+            retry_delay_seconds: Integer
+          }
+        end
+      end
+
+      type contact =
+        { prompt_variables: ::Hash[Symbol, String], to_phone_number: String }
+
+      class Contact < Revox::Internal::Type::BaseModel
+        attr_accessor prompt_variables: ::Hash[Symbol, String]
+
+        attr_accessor to_phone_number: String
+
+        def initialize: (
+          prompt_variables: ::Hash[Symbol, String],
+          to_phone_number: String
+        ) -> void
+
+        def to_hash: -> {
+          prompt_variables: ::Hash[Symbol, String],
+          to_phone_number: String
+        }
+      end
+
+      type scheduled_at = Time | top
+
+      module ScheduledAt
+        extend Revox::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Revox::Models::CampaignUpdateParams::scheduled_at]
+      end
+
+      type type_ = :regular | :jump_in
+
+      module Type
+        extend Revox::Internal::Type::Enum
+
+        REGULAR: :regular
+        JUMP_IN: :jump_in
+
+        def self?.values: -> ::Array[Revox::Models::CampaignUpdateParams::type_]
+      end
+    end
+  end
+end