revox 0.3.0 → 0.4.0

data/lib/revox/models/campaign_list_response.rb

@@ -48,21 +48,11 @@ module Revox
         #   @return [Symbol, Revox::Models::CampaignListResponse::Campaign::Status]
         required :status, enum: -> { Revox::Models::CampaignListResponse::Campaign::Status }
 
-        # @!attribute type
-        #
-        #   @return [Symbol, Revox::Models::CampaignListResponse::Campaign::Type]
-        required :type, enum: -> { Revox::Models::CampaignListResponse::Campaign::Type }
-
         # @!attribute updated_at
         #
         #   @return [Object]
         required :updated_at, Revox::Internal::Type::Unknown
 
-        # @!attribute active_takeover_call_id
-        #
-        #   @return [String, nil]
-        optional :active_takeover_call_id, String, nil?: true
-
         # @!attribute assistant
         #
         #   @return [Revox::Models::CampaignListResponse::Campaign::Assistant, nil]
@@ -98,17 +88,10 @@ module Revox
         #   @return [Float, nil]
         optional :max_concurrent_calls, Float, nil?: true
 
-        # @!attribute paused_reason
+        # @!attribute metadata_keys
         #
-        #   @return [Symbol, Revox::Models::CampaignListResponse::Campaign::PausedReason, nil]
-        optional :paused_reason,
-                 enum: -> { Revox::Models::CampaignListResponse::Campaign::PausedReason },
-                 nil?: true
-
-        # @!attribute present_count
-        #
-        #   @return [Float, nil]
-        optional :present_count, Float
+        #   @return [Array<String>, nil]
+        optional :metadata_keys, Revox::Internal::Type::ArrayOf[String]
 
         # @!attribute row_stats
         #
@@ -127,7 +110,7 @@ module Revox
         optional :structured_output_extraction,
                  enum: -> { Revox::Models::CampaignListResponse::Campaign::StructuredOutputExtraction }
 
-        # @!method initialize(id:, assistant_id:, created_at:, is_cancelled:, name:, organization_id:, status:, type:, updated_at:, active_takeover_call_id: nil, assistant: nil, call_retry_config: nil, created_by: nil, from_phone_number: nil, funnel_stats: nil, max_concurrent_calls: nil, paused_reason: nil, present_count: nil, row_stats: nil, scheduled_at: nil, structured_output_extraction: nil)
+        # @!method initialize(id:, assistant_id:, created_at:, is_cancelled:, name:, organization_id:, status:, updated_at:, assistant: nil, call_retry_config: nil, created_by: nil, from_phone_number: nil, funnel_stats: nil, max_concurrent_calls: nil, metadata_keys: nil, row_stats: nil, scheduled_at: nil, structured_output_extraction: nil)
         #   Some parameter documentations has been truncated, see
         #   {Revox::Models::CampaignListResponse::Campaign} for more details.
         #
@@ -145,12 +128,8 @@ module Revox
         #
         #   @param status [Symbol, Revox::Models::CampaignListResponse::Campaign::Status]
         #
-        #   @param type [Symbol, Revox::Models::CampaignListResponse::Campaign::Type]
-        #
         #   @param updated_at [Object]
         #
-        #   @param active_takeover_call_id [String, nil]
-        #
         #   @param assistant [Revox::Models::CampaignListResponse::Campaign::Assistant]
         #
         #   @param call_retry_config [Revox::Models::CampaignListResponse::Campaign::CallRetryConfig, nil] Configuration for call retry behavior including time windows, delays, and max it
@@ -163,9 +142,7 @@ module Revox
         #
         #   @param max_concurrent_calls [Float, nil]
         #
-        #   @param paused_reason [Symbol, Revox::Models::CampaignListResponse::Campaign::PausedReason, nil]
-        #
-        #   @param present_count [Float]
+        #   @param metadata_keys [Array<String>]
         #
         #   @param row_stats [Revox::Models::CampaignListResponse::Campaign::RowStats]
         #
@@ -177,7 +154,6 @@ module Revox
         module Status
           extend Revox::Internal::Type::Enum
 
-          DRAFT = :draft
           RUNNING = :running
           PAUSED = :paused
           COMPLETED = :completed
@@ -186,17 +162,6 @@ module Revox
           #   @return [Array<Symbol>]
         end
 
-        # @see Revox::Models::CampaignListResponse::Campaign#type
-        module Type
-          extend Revox::Internal::Type::Enum
-
-          REGULAR = :regular
-          JUMP_IN = :jump_in
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         # @see Revox::Models::CampaignListResponse::Campaign#assistant
         class Assistant < Revox::Internal::Type::BaseModel
           # @!attribute id
@@ -274,13 +239,6 @@ module Revox
           #   @return [String, nil]
           required :email_notification_address, String, nil?: true
 
-          # @!attribute email_notification_language
-          #   The language used for the notification email content. One of "en" or "fr".
-          #
-          #   @return [Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::EmailNotificationLanguage]
-          required :email_notification_language,
-                   enum: -> { Revox::Models::CampaignListResponse::Campaign::Assistant::EmailNotificationLanguage }
-
           # @!attribute email_notification_outcomes
           #   Which call outcomes trigger an email notification. E.g. ["interested",
           #   "completed", "none"]. Use "none" when outcome is null.
@@ -320,8 +278,8 @@ module Revox
           required :from_phone_number, String, nil?: true
 
           # @!attribute human_transfer_mode
-          #   Warm or cold transfer when transfer_phone_number is set; null when transfer is
-          #   not configured.
+          #   Warm or cold transfer when transfer_destinations is non-empty; null when
+          #   transfer is not configured.
           #
           #   @return [Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::HumanTransferMode, nil]
           required :human_transfer_mode,
@@ -377,6 +335,13 @@ module Revox
           #   @return [Revox::Models::CampaignListResponse::Campaign::Assistant::Position, nil]
           required :position, -> { Revox::Models::CampaignListResponse::Campaign::Assistant::Position }, nil?: true
 
+          # @!attribute precall_lookup_url
+          #   URL fetched before an inbound call is answered to resolve the assistant's prompt
+          #   variables. Null when no lookup is configured.
+          #
+          #   @return [String, nil]
+          required :precall_lookup_url, String, nil?: true
+
           # @!attribute prompt
           #
           #   @return [String]
@@ -464,11 +429,14 @@ module Revox
           #   @return [Float]
           required :thinking_sound_volume, Float
 
-          # @!attribute transfer_phone_number
-          #   Phone number to transfer calls to when users request to speak to a human agent.
+          # @!attribute transfer_destinations
+          #   Where calls can be transferred to when users ask to speak to a human. Null or
+          #   empty when transfer is not configured.
           #
-          #   @return [String, nil]
-          required :transfer_phone_number, String, nil?: true
+          #   @return [Array<Revox::Models::CampaignListResponse::Campaign::Assistant::TransferDestination>, nil]
+          required :transfer_destinations,
+                   -> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignListResponse::Campaign::Assistant::TransferDestination] },
+                   nil?: true
 
           # @!attribute type
           #
@@ -531,6 +499,11 @@ module Revox
           optional :faq_items,
                    -> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignListResponse::Campaign::Assistant::FaqItem] }
 
+          # @!attribute is_inbound_receptionist
+          #
+          #   @return [Boolean, nil]
+          optional :is_inbound_receptionist, Revox::Internal::Type::Boolean
+
           # @!attribute is_realestate_assistant
           #
           #   @return [Boolean, nil]
@@ -541,7 +514,7 @@ module Revox
           #   @return [Float, nil]
           optional :pending_faq_count, Float
 
-          # @!method initialize(id:, after_call_sms_outcomes:, after_call_sms_prompt:, background_sound:, background_sound_volume:, calendly:, call_retry_config:, cartesia_dictionary_pronunciation_id:, created_at:, custom_tools:, email_notification_address:, email_notification_language:, email_notification_outcomes:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, from_phone_number:, human_transfer_mode:, ivr_navigation_enabled:, llm_model:, logo_url:, max_call_duration_secs:, max_duration_end_message:, name:, organization_id:, position:, prompt:, prompt_flow:, slack:, sms_enabled:, sms_template:, structured_output_config:, structured_output_prompt:, stt_context:, stt_model:, thinking_sound:, thinking_sound_probability:, thinking_sound_volume:, transfer_phone_number:, type:, updated_at:, voice:, voicemail_message:, voicemail_sms_prompt:, warm_transfer_summary_instructions:, webhook_url:, zoho:, created_by: nil, faq_items: nil, is_realestate_assistant: nil, pending_faq_count: nil)
+          # @!method initialize(id:, after_call_sms_outcomes:, after_call_sms_prompt:, background_sound:, background_sound_volume:, calendly:, call_retry_config:, cartesia_dictionary_pronunciation_id:, created_at:, custom_tools:, email_notification_address:, email_notification_outcomes:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, from_phone_number:, human_transfer_mode:, ivr_navigation_enabled:, llm_model:, logo_url:, max_call_duration_secs:, max_duration_end_message:, name:, organization_id:, position:, precall_lookup_url:, prompt:, prompt_flow:, slack:, sms_enabled:, sms_template:, structured_output_config:, structured_output_prompt:, stt_context:, stt_model:, thinking_sound:, thinking_sound_probability:, thinking_sound_volume:, transfer_destinations:, type:, updated_at:, voice:, voicemail_message:, voicemail_sms_prompt:, warm_transfer_summary_instructions:, webhook_url:, zoho:, created_by: nil, faq_items: nil, is_inbound_receptionist: nil, is_realestate_assistant: nil, pending_faq_count: nil)
           #   Some parameter documentations has been truncated, see
           #   {Revox::Models::CampaignListResponse::Campaign::Assistant} for more details.
           #
@@ -567,8 +540,6 @@ module Revox
           #
           #   @param email_notification_address [String, nil] Email address(es) to receive notifications when a call ends with a matching outc
           #
-          #   @param email_notification_language [Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::EmailNotificationLanguage] The language used for the notification email content. One of "en" or "fr".
-          #
           #   @param email_notification_outcomes [Array<Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::EmailNotificationOutcome>, nil] Which call outcomes trigger an email notification. E.g. ["interested", "complete
           #
           #   @param end_of_call_sentence [String, nil]
@@ -581,7 +552,7 @@ module Revox
           #
           #   @param from_phone_number [String, nil] Override the default outbound phone number for calls placed with this assistant.
           #
-          #   @param human_transfer_mode [Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::HumanTransferMode, nil] Warm or cold transfer when transfer_phone_number is set; null when transfer is n
+          #   @param human_transfer_mode [Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::HumanTransferMode, nil] Warm or cold transfer when transfer_destinations is non-empty; null when transfe
           #
           #   @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
           #
@@ -599,6 +570,8 @@ module Revox
           #
           #   @param position [Revox::Models::CampaignListResponse::Campaign::Assistant::Position, nil]
           #
+          #   @param precall_lookup_url [String, nil] URL fetched before an inbound call is answered to resolve the assistant's prompt
+          #
           #   @param prompt [String]
           #
           #   @param prompt_flow [Revox::Models::CampaignListResponse::Campaign::Assistant::PromptFlow, nil]
@@ -623,7 +596,7 @@ module Revox
           #
           #   @param thinking_sound_volume [Float] Volume of the thinking sound (0 = silent, 1 = max).
           #
-          #   @param transfer_phone_number [String, nil] Phone number to transfer calls to when users request to speak to a human agent.
+          #   @param transfer_destinations [Array<Revox::Models::CampaignListResponse::Campaign::Assistant::TransferDestination>, nil] Where calls can be transferred to when users ask to speak to a human. Null or em
           #
           #   @param type [Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::Type]
           #
@@ -645,6 +618,8 @@ module Revox
           #
           #   @param faq_items [Array<Revox::Models::CampaignListResponse::Campaign::Assistant::FaqItem>]
           #
+          #   @param is_inbound_receptionist [Boolean]
+          #
           #   @param is_realestate_assistant [Boolean]
           #
           #   @param pending_faq_count [Float]
@@ -656,9 +631,6 @@ module Revox
             INTERESTED = :interested
             COMPLETED = :completed
             REQUESTED_CALLBACK_LATER = :requested_callback_later
-            REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
-            DO_NOT_CONTACT = :do_not_contact
-            AI_AVERSE = :ai_averse
             NONE = :none
 
             # @!method self.values
@@ -792,7 +764,8 @@ module Revox
               required :calling_window_start_time, String
 
               # @!attribute retry_delay_seconds
-              #   Delay between retry attempts in seconds. Default: 7200 (2 hours).
+              #   Delay between retry attempts in seconds. 0 retries as soon as the calling window
+              #   allows. Default: 7200 (2 hours).
               #
               #   @return [Integer]
               required :retry_delay_seconds, Integer
@@ -806,7 +779,7 @@ module Revox
               #
               #   @param calling_window_start_time [String] Start time for the calling window in the recipient's timezone (or timezone_overr
               #
-              #   @param retry_delay_seconds [Integer] Delay between retry attempts in seconds. Default: 7200 (2 hours).
+              #   @param retry_delay_seconds [Integer] Delay between retry attempts in seconds. 0 retries as soon as the calling window
             end
           end
 
@@ -989,19 +962,6 @@ module Revox
             end
           end
 
-          # The language used for the notification email content. One of "en" or "fr".
-          #
-          # @see Revox::Models::CampaignListResponse::Campaign::Assistant#email_notification_language
-          module EmailNotificationLanguage
-            extend Revox::Internal::Type::Enum
-
-            EN = :en
-            FR = :fr
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
           module EmailNotificationOutcome
             extend Revox::Internal::Type::Enum
 
@@ -1009,9 +969,6 @@ module Revox
             INTERESTED = :interested
             COMPLETED = :completed
             REQUESTED_CALLBACK_LATER = :requested_callback_later
-            REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
-            DO_NOT_CONTACT = :do_not_contact
-            AI_AVERSE = :ai_averse
             NONE = :none
 
             # @!method self.values
@@ -1030,8 +987,8 @@ module Revox
             #   @return [Array<Symbol>]
           end
 
-          # Warm or cold transfer when transfer_phone_number is set; null when transfer is
-          # not configured.
+          # Warm or cold transfer when transfer_destinations is non-empty; null when
+          # transfer is not configured.
           #
           # @see Revox::Models::CampaignListResponse::Campaign::Assistant#human_transfer_mode
           module HumanTransferMode
@@ -1322,11 +1279,14 @@ module Revox
 
           # @see Revox::Models::CampaignListResponse::Campaign::Assistant#slack
           class Slack < Revox::Internal::Type::BaseModel
-            # @!attribute channel_id
-            #   The Slack channel ID where the notification will be posted.
+            # @!attribute channels
+            #   The Slack channels eligible to receive the notification. When more than one is
+            #   configured, the agent prompt may define routing rules to narrow it down per
+            #   call; with no such rules every channel here is notified.
             #
-            #   @return [String]
-            required :channel_id, String
+            #   @return [Array<Revox::Models::CampaignListResponse::Campaign::Assistant::Slack::Channel>]
+            required :channels,
+                     -> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignListResponse::Campaign::Assistant::Slack::Channel] }
 
             # @!attribute connection_id
             #   The Nango connection ID linking the org's Slack workspace to Revox.
@@ -1342,38 +1302,54 @@ module Revox
             required :outcomes,
                      -> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignListResponse::Campaign::Assistant::Slack::Outcome] }
 
-            # @!attribute channel_name
-            #   Human-readable Slack channel name, cached for display in the UI.
-            #
-            #   @return [String, nil]
-            optional :channel_name, String, nil?: true
-
             # @!attribute template
             #   Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
             #   {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}},
-            #   {{last_name}}, {{email}}, {{company}}, {{contact_name}}, {{contact_line}}, plus
-            #   prompt_variables and structured_output keys. When null/empty a default template
-            #   is used.
+            #   {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}},
+            #   {{contact_line}}, plus prompt_variables and structured_output keys. When
+            #   null/empty a default template is used.
             #
             #   @return [String, nil]
             optional :template, String, nil?: true
 
-            # @!method initialize(channel_id:, connection_id:, outcomes:, channel_name: nil, template: nil)
+            # @!method initialize(channels:, connection_id:, outcomes:, template: nil)
             #   Some parameter documentations has been truncated, see
             #   {Revox::Models::CampaignListResponse::Campaign::Assistant::Slack} for more
             #   details.
             #
-            #   @param channel_id [String] The Slack channel ID where the notification will be posted.
+            #   @param channels [Array<Revox::Models::CampaignListResponse::Campaign::Assistant::Slack::Channel>] The Slack channels eligible to receive the notification. When more than one is c
             #
             #   @param connection_id [String] The Nango connection ID linking the org's Slack workspace to Revox.
             #
             #   @param outcomes [Array<Symbol, Revox::Models::CampaignListResponse::Campaign::Assistant::Slack::Outcome>] Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
             #
-            #   @param channel_name [String, nil] Human-readable Slack channel name, cached for display in the UI.
-            #
             #   @param template [String, nil] Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
             #   {{call\_
 
+            class Channel < Revox::Internal::Type::BaseModel
+              # @!attribute id
+              #   The Slack channel ID (e.g. 'C01234567').
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute name
+              #   Human-readable Slack channel name, cached for display in the UI and given to the
+              #   LLM when the agent prompt routes by channel name.
+              #
+              #   @return [String, nil]
+              optional :name, String, nil?: true
+
+              # @!method initialize(id:, name: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Revox::Models::CampaignListResponse::Campaign::Assistant::Slack::Channel} for
+              #   more details.
+              #
+              #   @param id [String] The Slack channel ID (e.g. 'C01234567').
+              #
+              #   @param name [String, nil] Human-readable Slack channel name, cached for display in the UI and given to the
+            end
+
             module Outcome
               extend Revox::Internal::Type::Enum
 
@@ -1381,9 +1357,6 @@ module Revox
               INTERESTED = :interested
               COMPLETED = :completed
               REQUESTED_CALLBACK_LATER = :requested_callback_later
-              REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
-              DO_NOT_CONTACT = :do_not_contact
-              AI_AVERSE = :ai_averse
               NONE = :none
 
               # @!method self.values
@@ -1511,6 +1484,22 @@ module Revox
             #   @return [Array<Symbol>]
           end
 
+          class TransferDestination < Revox::Internal::Type::BaseModel
+            # @!attribute label
+            #
+            #   @return [String]
+            required :label, String
+
+            # @!attribute phone_number
+            #
+            #   @return [String]
+            required :phone_number, String
+
+            # @!method initialize(label:, phone_number:)
+            #   @param label [String]
+            #   @param phone_number [String]
+          end
+
           # @see Revox::Models::CampaignListResponse::Campaign::Assistant#type
           module Type
             extend Revox::Internal::Type::Enum
@@ -1546,7 +1535,7 @@ module Revox
 
             # @!attribute speed
             #   The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
-            #   0.7–1.2. Default is 1.0.
+            #   0.7–1.2, Gradium 0.6–1.5. Default is 1.0.
             #
             #   @return [Float, nil]
             optional :speed, Float
@@ -1581,6 +1570,7 @@ module Revox
 
               CARTESIA = :cartesia
               ELEVENLABS = :elevenlabs
+              GRADIUM = :gradium
 
               # @!method self.values
               #   @return [Array<Symbol>]
@@ -1696,9 +1686,6 @@ module Revox
               INTERESTED = :interested
               COMPLETED = :completed
               REQUESTED_CALLBACK_LATER = :requested_callback_later
-              REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
-              DO_NOT_CONTACT = :do_not_contact
-              AI_AVERSE = :ai_averse
               NONE = :none
 
               # @!method self.values
@@ -1877,7 +1864,8 @@ module Revox
             required :calling_window_start_time, String
 
             # @!attribute retry_delay_seconds
-            #   Delay between retry attempts in seconds. Default: 7200 (2 hours).
+            #   Delay between retry attempts in seconds. 0 retries as soon as the calling window
+            #   allows. Default: 7200 (2 hours).
             #
             #   @return [Integer]
             required :retry_delay_seconds, Integer
@@ -1891,7 +1879,7 @@ module Revox
             #
             #   @param calling_window_start_time [String] Start time for the calling window in the recipient's timezone (or timezone_overr
             #
-            #   @param retry_delay_seconds [Integer] Delay between retry attempts in seconds. Default: 7200 (2 hours).
+            #   @param retry_delay_seconds [Integer] Delay between retry attempts in seconds. 0 retries as soon as the calling window
           end
         end
 
@@ -1953,17 +1941,6 @@ module Revox
           #   @param total_leads [Float]
         end
 
-        # @see Revox::Models::CampaignListResponse::Campaign#paused_reason
-        module PausedReason
-          extend Revox::Internal::Type::Enum
-
-          MANUAL = :manual
-          NO_PRESENCE = :no_presence
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         # @see Revox::Models::CampaignListResponse::Campaign#row_stats
         class RowStats < Revox::Internal::Type::BaseModel
           # @!attribute calling
@@ -1981,6 +1958,11 @@ module Revox
           #   @return [Float]
           required :failed, Float
 
+          # @!attribute not_launched
+          #
+          #   @return [Float]
+          required :not_launched, Float
+
           # @!attribute pending
           #
           #   @return [Float]
@@ -1991,17 +1973,24 @@ module Revox
           #   @return [Float]
           required :retry_, Float, api_name: :retry
 
+          # @!attribute skipped
+          #
+          #   @return [Float]
+          required :skipped, Float
+
           # @!attribute total
           #
           #   @return [Float]
           required :total, Float
 
-          # @!method initialize(calling:, completed:, failed:, pending:, retry_:, total:)
+          # @!method initialize(calling:, completed:, failed:, not_launched:, pending:, retry_:, skipped:, total:)
           #   @param calling [Float]
           #   @param completed [Float]
           #   @param failed [Float]
+          #   @param not_launched [Float]
           #   @param pending [Float]
           #   @param retry_ [Float]
+          #   @param skipped [Float]
           #   @param total [Float]
         end