revox 0.1.0 → 0.3.0

data/lib/revox/models/campaign_statistics_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Campaigns#statistics
+    class CampaignStatisticsParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/revox/models/campaign_statistics_response.rb

@@ -0,0 +1,486 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Campaigns#statistics
+    class CampaignStatisticsResponse < Revox::Internal::Type::BaseModel
+      # @!attribute statistics
+      #
+      #   @return [Revox::Models::CampaignStatisticsResponse::Statistics]
+      required :statistics, -> { Revox::Models::CampaignStatisticsResponse::Statistics }
+
+      # @!method initialize(statistics:)
+      #   @param statistics [Revox::Models::CampaignStatisticsResponse::Statistics]
+
+      # @see Revox::Models::CampaignStatisticsResponse#statistics
+      class Statistics < Revox::Internal::Type::BaseModel
+        # @!attribute campaign
+        #
+        #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Campaign]
+        required :campaign, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Campaign }
+
+        # @!attribute data_extraction
+        #
+        #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::DataExtraction, nil]
+        required :data_extraction,
+                 -> { Revox::Models::CampaignStatisticsResponse::Statistics::DataExtraction },
+                 nil?: true
+
+        # @!attribute effort
+        #
+        #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Effort]
+        required :effort, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Effort }
+
+        # @!attribute funnel
+        #
+        #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel]
+        required :funnel, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Funnel }
+
+        # @!attribute hot_lead_outcomes
+        #
+        #   @return [Array<String>]
+        required :hot_lead_outcomes, Revox::Internal::Type::ArrayOf[String]
+
+        # @!attribute inbound
+        #
+        #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Inbound]
+        required :inbound, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Inbound }
+
+        # @!attribute leads
+        #
+        #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Leads]
+        required :leads, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Leads }
+
+        # @!attribute outcome_breakdown
+        #
+        #   @return [Array<Revox::Models::CampaignStatisticsResponse::Statistics::OutcomeBreakdown>]
+        required :outcome_breakdown,
+                 -> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignStatisticsResponse::Statistics::OutcomeBreakdown] }
+
+        # @!method initialize(campaign:, data_extraction:, effort:, funnel:, hot_lead_outcomes:, inbound:, leads:, outcome_breakdown:)
+        #   @param campaign [Revox::Models::CampaignStatisticsResponse::Statistics::Campaign]
+        #   @param data_extraction [Revox::Models::CampaignStatisticsResponse::Statistics::DataExtraction, nil]
+        #   @param effort [Revox::Models::CampaignStatisticsResponse::Statistics::Effort]
+        #   @param funnel [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel]
+        #   @param hot_lead_outcomes [Array<String>]
+        #   @param inbound [Revox::Models::CampaignStatisticsResponse::Statistics::Inbound]
+        #   @param leads [Revox::Models::CampaignStatisticsResponse::Statistics::Leads]
+        #   @param outcome_breakdown [Array<Revox::Models::CampaignStatisticsResponse::Statistics::OutcomeBreakdown>]
+
+        # @see Revox::Models::CampaignStatisticsResponse::Statistics#campaign
+        class Campaign < Revox::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute agent_name
+          #
+          #   @return [String, nil]
+          required :agent_name, String, nil?: true
+
+          # @!attribute first_activity_at
+          #
+          #   @return [Object]
+          required :first_activity_at, Revox::Internal::Type::Unknown
+
+          # @!attribute has_activity
+          #
+          #   @return [Boolean]
+          required :has_activity, Revox::Internal::Type::Boolean
+
+          # @!attribute is_cancelled
+          #
+          #   @return [Boolean]
+          required :is_cancelled, Revox::Internal::Type::Boolean
+
+          # @!attribute last_activity_at
+          #
+          #   @return [Object]
+          required :last_activity_at, Revox::Internal::Type::Unknown
+
+          # @!attribute max_attempts_per_contact
+          #
+          #   @return [Float, nil]
+          required :max_attempts_per_contact, Float, nil?: true
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::Status]
+          required :status, enum: -> { Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::Status }
+
+          # @!attribute timezone
+          #
+          #   @return [String]
+          required :timezone, String
+
+          # @!method initialize(id:, agent_name:, first_activity_at:, has_activity:, is_cancelled:, last_activity_at:, max_attempts_per_contact:, name:, status:, timezone:)
+          #   @param id [String]
+          #   @param agent_name [String, nil]
+          #   @param first_activity_at [Object]
+          #   @param has_activity [Boolean]
+          #   @param is_cancelled [Boolean]
+          #   @param last_activity_at [Object]
+          #   @param max_attempts_per_contact [Float, nil]
+          #   @param name [String]
+          #   @param status [Symbol, Revox::Models::CampaignStatisticsResponse::Statistics::Campaign::Status]
+          #   @param timezone [String]
+
+          # @see Revox::Models::CampaignStatisticsResponse::Statistics::Campaign#status
+          module Status
+            extend Revox::Internal::Type::Enum
+
+            DRAFT = :draft
+            RUNNING = :running
+            PAUSED = :paused
+            COMPLETED = :completed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Revox::Models::CampaignStatisticsResponse::Statistics#data_extraction
+        class DataExtraction < Revox::Internal::Type::BaseModel
+          # @!attribute fields
+          #
+          #   @return [Array<String>]
+          required :fields, Revox::Internal::Type::ArrayOf[String]
+
+          # @!attribute intro
+          #
+          #   @return [String]
+          required :intro, String
+
+          # @!method initialize(fields:, intro:)
+          #   @param fields [Array<String>]
+          #   @param intro [String]
+        end
+
+        # @see Revox::Models::CampaignStatisticsResponse::Statistics#effort
+        class Effort < Revox::Internal::Type::BaseModel
+          # @!attribute calls_total
+          #
+          #   @return [Float]
+          required :calls_total, Float
+
+          # @!attribute inbound_calls
+          #
+          #   @return [Float]
+          required :inbound_calls, Float
+
+          # @!attribute outbound_attempts
+          #
+          #   @return [Float]
+          required :outbound_attempts, Float
+
+          # @!method initialize(calls_total:, inbound_calls:, outbound_attempts:)
+          #   @param calls_total [Float]
+          #   @param inbound_calls [Float]
+          #   @param outbound_attempts [Float]
+        end
+
+        # @see Revox::Models::CampaignStatisticsResponse::Statistics#funnel
+        class Funnel < Revox::Internal::Type::BaseModel
+          # @!attribute called
+          #
+          #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Called]
+          required :called, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Called }
+
+          # @!attribute hot_leads
+          #
+          #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::HotLeads]
+          required :hot_leads, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::HotLeads }
+
+          # @!attribute reached
+          #
+          #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Reached]
+          required :reached, -> { Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Reached }
+
+          # @!attribute real_exchanges
+          #
+          #   @return [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::RealExchanges]
+          required :real_exchanges,
+                   -> { Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::RealExchanges }
+
+          # @!method initialize(called:, hot_leads:, reached:, real_exchanges:)
+          #   @param called [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Called]
+          #   @param hot_leads [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::HotLeads]
+          #   @param reached [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::Reached]
+          #   @param real_exchanges [Revox::Models::CampaignStatisticsResponse::Statistics::Funnel::RealExchanges]
+
+          # @see Revox::Models::CampaignStatisticsResponse::Statistics::Funnel#called
+          class Called < Revox::Internal::Type::BaseModel
+            # @!attribute count
+            #
+            #   @return [Float]
+            required :count, Float
+
+            # @!attribute imported_rows
+            #
+            #   @return [Float]
+            required :imported_rows, Float
+
+            # @!method initialize(count:, imported_rows:)
+            #   @param count [Float]
+            #   @param imported_rows [Float]
+          end
+
+          # @see Revox::Models::CampaignStatisticsResponse::Statistics::Funnel#hot_leads
+          class HotLeads < Revox::Internal::Type::BaseModel
+            # @!attribute count
+            #
+            #   @return [Float]
+            required :count, Float
+
+            # @!attribute pct_of_reached
+            #
+            #   @return [Float, nil]
+            required :pct_of_reached, Float, nil?: true
+
+            # @!method initialize(count:, pct_of_reached:)
+            #   @param count [Float]
+            #   @param pct_of_reached [Float, nil]
+          end
+
+          # @see Revox::Models::CampaignStatisticsResponse::Statistics::Funnel#reached
+          class Reached < Revox::Internal::Type::BaseModel
+            # @!attribute count
+            #
+            #   @return [Float]
+            required :count, Float
+
+            # @!attribute inbound
+            #
+            #   @return [Float]
+            required :inbound, Float
+
+            # @!attribute outbound
+            #
+            #   @return [Float]
+            required :outbound, Float
+
+            # @!attribute overlap
+            #
+            #   @return [Float]
+            required :overlap, Float
+
+            # @!attribute pct_of_called
+            #
+            #   @return [Float, nil]
+            required :pct_of_called, Float, nil?: true
+
+            # @!method initialize(count:, inbound:, outbound:, overlap:, pct_of_called:)
+            #   @param count [Float]
+            #   @param inbound [Float]
+            #   @param outbound [Float]
+            #   @param overlap [Float]
+            #   @param pct_of_called [Float, nil]
+          end
+
+          # @see Revox::Models::CampaignStatisticsResponse::Statistics::Funnel#real_exchanges
+          class RealExchanges < Revox::Internal::Type::BaseModel
+            # @!attribute count
+            #
+            #   @return [Float]
+            required :count, Float
+
+            # @!attribute pct_of_reached
+            #
+            #   @return [Float, nil]
+            required :pct_of_reached, Float, nil?: true
+
+            # @!method initialize(count:, pct_of_reached:)
+            #   @param count [Float]
+            #   @param pct_of_reached [Float, nil]
+          end
+        end
+
+        # @see Revox::Models::CampaignStatisticsResponse::Statistics#inbound
+        class Inbound < Revox::Internal::Type::BaseModel
+          # @!attribute unique_callers
+          #
+          #   @return [Float]
+          required :unique_callers, Float
+
+          # @!method initialize(unique_callers:)
+          #   @param unique_callers [Float]
+        end
+
+        # @see Revox::Models::CampaignStatisticsResponse::Statistics#leads
+        class Leads < Revox::Internal::Type::BaseModel
+          # @!attribute hot
+          #
+          #   @return [Array<Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot>]
+          required :hot,
+                   -> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot] }
+
+          # @!attribute warm
+          #
+          #   @return [Array<Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm>]
+          required :warm,
+                   -> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm] }
+
+          # @!method initialize(hot:, warm:)
+          #   @param hot [Array<Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot>]
+          #   @param warm [Array<Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm>]
+
+          class Hot < Revox::Internal::Type::BaseModel
+            # @!attribute attempt_id
+            #
+            #   @return [String, nil]
+            required :attempt_id, String, nil?: true
+
+            # @!attribute call_id
+            #
+            #   @return [String]
+            required :call_id, String
+
+            # @!attribute direction
+            #
+            #   @return [Symbol, Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::Direction]
+            required :direction,
+                     enum: -> { Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::Direction }
+
+            # @!attribute email
+            #
+            #   @return [String, nil]
+            required :email, String, nil?: true
+
+            # @!attribute last_activity_at
+            #
+            #   @return [Object]
+            required :last_activity_at, Revox::Internal::Type::Unknown
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute phone
+            #
+            #   @return [String]
+            required :phone, String
+
+            # @!attribute summary
+            #
+            #   @return [String, nil]
+            required :summary, String, nil?: true
+
+            # @!method initialize(attempt_id:, call_id:, direction:, email:, last_activity_at:, name:, phone:, summary:)
+            #   @param attempt_id [String, nil]
+            #   @param call_id [String]
+            #   @param direction [Symbol, Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot::Direction]
+            #   @param email [String, nil]
+            #   @param last_activity_at [Object]
+            #   @param name [String]
+            #   @param phone [String]
+            #   @param summary [String, nil]
+
+            # @see Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Hot#direction
+            module Direction
+              extend Revox::Internal::Type::Enum
+
+              INBOUND = :inbound
+              OUTBOUND = :outbound
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Warm < Revox::Internal::Type::BaseModel
+            # @!attribute attempt_id
+            #
+            #   @return [String, nil]
+            required :attempt_id, String, nil?: true
+
+            # @!attribute call_id
+            #
+            #   @return [String]
+            required :call_id, String
+
+            # @!attribute direction
+            #
+            #   @return [Symbol, Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::Direction]
+            required :direction,
+                     enum: -> { Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::Direction }
+
+            # @!attribute email
+            #
+            #   @return [String, nil]
+            required :email, String, nil?: true
+
+            # @!attribute last_activity_at
+            #
+            #   @return [Object]
+            required :last_activity_at, Revox::Internal::Type::Unknown
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute phone
+            #
+            #   @return [String]
+            required :phone, String
+
+            # @!attribute summary
+            #
+            #   @return [String, nil]
+            required :summary, String, nil?: true
+
+            # @!method initialize(attempt_id:, call_id:, direction:, email:, last_activity_at:, name:, phone:, summary:)
+            #   @param attempt_id [String, nil]
+            #   @param call_id [String]
+            #   @param direction [Symbol, Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm::Direction]
+            #   @param email [String, nil]
+            #   @param last_activity_at [Object]
+            #   @param name [String]
+            #   @param phone [String]
+            #   @param summary [String, nil]
+
+            # @see Revox::Models::CampaignStatisticsResponse::Statistics::Leads::Warm#direction
+            module Direction
+              extend Revox::Internal::Type::Enum
+
+              INBOUND = :inbound
+              OUTBOUND = :outbound
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        class OutcomeBreakdown < Revox::Internal::Type::BaseModel
+          # @!attribute count
+          #
+          #   @return [Float]
+          required :count, Float
+
+          # @!attribute label
+          #
+          #   @return [String]
+          required :label, String
+
+          # @!attribute outcome
+          #
+          #   @return [String]
+          required :outcome, String
+
+          # @!method initialize(count:, label:, outcome:)
+          #   @param count [Float]
+          #   @param label [String]
+          #   @param outcome [String]
+        end
+      end
+    end
+  end
+end