revox 0.2.0 → 0.4.0

data/rbi/revox/models/assistant_create_params.rbi

@@ -93,25 +93,6 @@ module Revox
       sig { returns(T.nilable(String)) }
       attr_accessor :email_notification_address
 
-      # The language used for the notification email content. One of "en" or "fr".
-      # Defaults to "en".
-      sig do
-        returns(
-          T.nilable(
-            Revox::AssistantCreateParams::EmailNotificationLanguage::OrSymbol
-          )
-        )
-      end
-      attr_reader :email_notification_language
-
-      sig do
-        params(
-          email_notification_language:
-            Revox::AssistantCreateParams::EmailNotificationLanguage::OrSymbol
-        ).void
-      end
-      attr_writer :email_notification_language
-
       # Which call outcomes trigger an email notification. E.g. ["interested",
       # "completed", "none"]. Use "none" when outcome is null.
       sig do
@@ -185,8 +166,8 @@ module Revox
       sig { returns(T.nilable(String)) }
       attr_accessor :from_phone_number
 
-      # When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER;
-      # trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
+      # When transfer_destinations is non-empty: "warm" (AI bridges) or "cold" (SIP
+      # REFER; trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
       sig do
         returns(
           T.nilable(Revox::AssistantCreateParams::HumanTransferMode::OrSymbol)
@@ -259,6 +240,14 @@ module Revox
       end
       attr_writer :position
 
+      # Inbound calls only. URL fetched over HTTP GET right before the call is answered,
+      # with `{{phone}}` replaced by the caller's number in E.164 format (URL-encoded).
+      # It must return `{"prompt_variables": {...}}` covering every `{{variable}}` the
+      # assistant declares, otherwise the call is errored. Must be an http(s) URL
+      # containing `{{phone}}`. When null, no lookup is performed.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :precall_lookup_url
+
       # Visual prompt constructor data (nodes, edges, positions). Used by the UI to
       # re-open the visual editor. Does not affect call behavior — the flattened prompt
       # field is what the LLM receives.
@@ -376,10 +365,16 @@ module Revox
       sig { params(thinking_sound_volume: Float).void }
       attr_writer :thinking_sound_volume
 
-      # Phone number to transfer calls to when users request to speak to a human agent
-      # in E.164 format (e.g. +1234567890).
-      sig { returns(T.nilable(String)) }
-      attr_accessor :transfer_phone_number
+      # Where calls can be transferred to when users ask to speak to a human. With a
+      # single entry the assistant always transfers there; with several, it picks one at
+      # transfer time by applying the routing rules written in the assistant's own
+      # prompt (which refer to the destination labels). Empty or null disables transfer.
+      sig do
+        returns(
+          T.nilable(T::Array[Revox::AssistantCreateParams::TransferDestination])
+        )
+      end
+      attr_accessor :transfer_destinations
 
       # Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step'
       # orchestrates a flow of sub-assistants, 'sub-assistant' is a step inside a
@@ -456,8 +451,6 @@ module Revox
               T::Array[Revox::AssistantCreateParams::CustomTool::OrHash]
             ),
           email_notification_address: T.nilable(String),
-          email_notification_language:
-            Revox::AssistantCreateParams::EmailNotificationLanguage::OrSymbol,
           email_notification_outcomes:
             T.nilable(
               T::Array[
@@ -487,6 +480,7 @@ module Revox
           max_call_duration_secs: Float,
           max_duration_end_message: T.nilable(String),
           position: T.nilable(Revox::AssistantCreateParams::Position::OrHash),
+          precall_lookup_url: T.nilable(String),
           prompt_flow:
             T.nilable(Revox::AssistantCreateParams::PromptFlow::OrHash),
           slack: T.nilable(Revox::AssistantCreateParams::Slack::OrHash),
@@ -504,7 +498,12 @@ module Revox
             T.nilable(Revox::AssistantCreateParams::ThinkingSound::OrSymbol),
           thinking_sound_probability: Float,
           thinking_sound_volume: Float,
-          transfer_phone_number: T.nilable(String),
+          transfer_destinations:
+            T.nilable(
+              T::Array[
+                Revox::AssistantCreateParams::TransferDestination::OrHash
+              ]
+            ),
           type: Revox::AssistantCreateParams::Type::OrSymbol,
           voice: Revox::AssistantCreateParams::Voice::OrHash,
           voicemail_message: T.nilable(String),
@@ -544,9 +543,6 @@ module Revox
         # outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com,
         # bob@y.com").
         email_notification_address: nil,
-        # The language used for the notification email content. One of "en" or "fr".
-        # Defaults to "en".
-        email_notification_language: nil,
         # Which call outcomes trigger an email notification. E.g. ["interested",
         # "completed", "none"]. Use "none" when outcome is null.
         email_notification_outcomes: nil,
@@ -568,8 +564,8 @@ module Revox
         # Must be a phone number owned by the organization in E.164 format (e.g.
         # +1234567890). When null, the organization's default phone number is used.
         from_phone_number: nil,
-        # When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER;
-        # trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
+        # When transfer_destinations is non-empty: "warm" (AI bridges) or "cold" (SIP
+        # REFER; trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
         human_transfer_mode: nil,
         # Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
         # skip turns to navigate phone menus.
@@ -587,6 +583,12 @@ module Revox
         max_duration_end_message: nil,
         # Canvas position of this assistant's node in its multi-step flow editor.
         position: nil,
+        # Inbound calls only. URL fetched over HTTP GET right before the call is answered,
+        # with `{{phone}}` replaced by the caller's number in E.164 format (URL-encoded).
+        # It must return `{"prompt_variables": {...}}` covering every `{{variable}}` the
+        # assistant declares, otherwise the call is errored. Must be an http(s) URL
+        # containing `{{phone}}`. When null, no lookup is performed.
+        precall_lookup_url: nil,
         # Visual prompt constructor data (nodes, edges, positions). Used by the UI to
         # re-open the visual editor. Does not affect call behavior — the flattened prompt
         # field is what the LLM receives.
@@ -623,9 +625,11 @@ module Revox
         thinking_sound_probability: nil,
         # Volume of the thinking sound (0 = silent, 1 = max).
         thinking_sound_volume: nil,
-        # Phone number to transfer calls to when users request to speak to a human agent
-        # in E.164 format (e.g. +1234567890).
-        transfer_phone_number: nil,
+        # Where calls can be transferred to when users ask to speak to a human. With a
+        # single entry the assistant always transfers there; with several, it picks one at
+        # transfer time by applying the routing rules written in the assistant's own
+        # prompt (which refer to the destination labels). Empty or null disables transfer.
+        transfer_destinations: nil,
         # Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step'
         # orchestrates a flow of sub-assistants, 'sub-assistant' is a step inside a
         # multi-step flow (hidden from the assistants list). Flow transitions are managed
@@ -677,8 +681,6 @@ module Revox
             custom_tools:
               T.nilable(T::Array[Revox::AssistantCreateParams::CustomTool]),
             email_notification_address: T.nilable(String),
-            email_notification_language:
-              Revox::AssistantCreateParams::EmailNotificationLanguage::OrSymbol,
             email_notification_outcomes:
               T.nilable(
                 T::Array[
@@ -708,6 +710,7 @@ module Revox
             max_call_duration_secs: Float,
             max_duration_end_message: T.nilable(String),
             position: T.nilable(Revox::AssistantCreateParams::Position),
+            precall_lookup_url: T.nilable(String),
             prompt_flow: T.nilable(Revox::AssistantCreateParams::PromptFlow),
             slack: T.nilable(Revox::AssistantCreateParams::Slack),
             sms_enabled: T::Boolean,
@@ -721,7 +724,10 @@ module Revox
               T.nilable(Revox::AssistantCreateParams::ThinkingSound::OrSymbol),
             thinking_sound_probability: Float,
             thinking_sound_volume: Float,
-            transfer_phone_number: T.nilable(String),
+            transfer_destinations:
+              T.nilable(
+                T::Array[Revox::AssistantCreateParams::TransferDestination]
+              ),
             type: Revox::AssistantCreateParams::Type::OrSymbol,
             voice: Revox::AssistantCreateParams::Voice,
             voicemail_message: T.nilable(String),
@@ -765,21 +771,6 @@ module Revox
             :requested_callback_later,
             Revox::AssistantCreateParams::AfterCallSMSOutcome::TaggedSymbol
           )
-        REQUESTED_CALLBACK_NEW_NUMBER =
-          T.let(
-            :requested_callback_new_number,
-            Revox::AssistantCreateParams::AfterCallSMSOutcome::TaggedSymbol
-          )
-        DO_NOT_CONTACT =
-          T.let(
-            :do_not_contact,
-            Revox::AssistantCreateParams::AfterCallSMSOutcome::TaggedSymbol
-          )
-        AI_AVERSE =
-          T.let(
-            :ai_averse,
-            Revox::AssistantCreateParams::AfterCallSMSOutcome::TaggedSymbol
-          )
         NONE =
           T.let(
             :none,
@@ -1045,7 +1036,8 @@ module Revox
           sig { returns(String) }
           attr_accessor :calling_window_start_time
 
-          # 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).
           sig { returns(Integer) }
           attr_accessor :retry_delay_seconds
 
@@ -1065,7 +1057,8 @@ module Revox
             # timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour).
             # Examples: '09:00', '10am'. Default: '10:00'.
             calling_window_start_time:,
-            # 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).
             retry_delay_seconds:
           )
           end
@@ -1428,42 +1421,6 @@ module Revox
         end
       end
 
-      # The language used for the notification email content. One of "en" or "fr".
-      # Defaults to "en".
-      module EmailNotificationLanguage
-        extend Revox::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Revox::AssistantCreateParams::EmailNotificationLanguage
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        EN =
-          T.let(
-            :en,
-            Revox::AssistantCreateParams::EmailNotificationLanguage::TaggedSymbol
-          )
-        FR =
-          T.let(
-            :fr,
-            Revox::AssistantCreateParams::EmailNotificationLanguage::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Revox::AssistantCreateParams::EmailNotificationLanguage::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
       module EmailNotificationOutcome
         extend Revox::Internal::Type::Enum
 
@@ -1496,21 +1453,6 @@ module Revox
             :requested_callback_later,
             Revox::AssistantCreateParams::EmailNotificationOutcome::TaggedSymbol
           )
-        REQUESTED_CALLBACK_NEW_NUMBER =
-          T.let(
-            :requested_callback_new_number,
-            Revox::AssistantCreateParams::EmailNotificationOutcome::TaggedSymbol
-          )
-        DO_NOT_CONTACT =
-          T.let(
-            :do_not_contact,
-            Revox::AssistantCreateParams::EmailNotificationOutcome::TaggedSymbol
-          )
-        AI_AVERSE =
-          T.let(
-            :ai_averse,
-            Revox::AssistantCreateParams::EmailNotificationOutcome::TaggedSymbol
-          )
         NONE =
           T.let(
             :none,
@@ -1594,8 +1536,8 @@ module Revox
         end
       end
 
-      # When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER;
-      # trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
+      # When transfer_destinations is non-empty: "warm" (AI bridges) or "cold" (SIP
+      # REFER; trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
       module HumanTransferMode
         extend Revox::Internal::Type::Enum
 
@@ -2163,9 +2105,11 @@ module Revox
             T.any(Revox::AssistantCreateParams::Slack, Revox::Internal::AnyHash)
           end
 
-        # The Slack channel ID where the notification will be posted.
-        sig { returns(String) }
-        attr_accessor :channel_id
+        # 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.
+        sig { returns(T::Array[Revox::AssistantCreateParams::Slack::Channel]) }
+        attr_accessor :channels
 
         # The Nango connection ID linking the org's Slack workspace to Revox.
         sig { returns(String) }
@@ -2180,15 +2124,11 @@ module Revox
         end
         attr_accessor :outcomes
 
-        # Human-readable Slack channel name, cached for display in the UI.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :channel_name
-
         # 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.
         sig { returns(T.nilable(String)) }
         attr_accessor :template
 
@@ -2196,29 +2136,29 @@ module Revox
         # a call ends with one of the configured outcomes.
         sig do
           params(
-            channel_id: String,
+            channels:
+              T::Array[Revox::AssistantCreateParams::Slack::Channel::OrHash],
             connection_id: String,
             outcomes:
               T::Array[Revox::AssistantCreateParams::Slack::Outcome::OrSymbol],
-            channel_name: T.nilable(String),
             template: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
-          # The Slack channel ID where the notification will be posted.
-          channel_id:,
+          # 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.
+          channels:,
           # The Nango connection ID linking the org's Slack workspace to Revox.
           connection_id:,
           # Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
           # Use 'none' to notify when outcome is null.
           outcomes:,
-          # Human-readable Slack channel name, cached for display in the UI.
-          channel_name: nil,
           # 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.
           template: nil
         )
         end
@@ -2226,13 +2166,12 @@ module Revox
         sig do
           override.returns(
             {
-              channel_id: String,
+              channels: T::Array[Revox::AssistantCreateParams::Slack::Channel],
               connection_id: String,
               outcomes:
                 T::Array[
                   Revox::AssistantCreateParams::Slack::Outcome::OrSymbol
                 ],
-              channel_name: T.nilable(String),
               template: T.nilable(String)
             }
           )
@@ -2240,6 +2179,43 @@ module Revox
         def to_hash
         end
 
+        class Channel < Revox::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Revox::AssistantCreateParams::Slack::Channel,
+                Revox::Internal::AnyHash
+              )
+            end
+
+          # The Slack channel ID (e.g. 'C01234567').
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Human-readable Slack channel name, cached for display in the UI and given to the
+          # LLM when the agent prompt routes by channel name.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          sig do
+            params(id: String, name: T.nilable(String)).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The Slack channel ID (e.g. 'C01234567').
+            id:,
+            # Human-readable Slack channel name, cached for display in the UI and given to the
+            # LLM when the agent prompt routes by channel name.
+            name: nil
+          )
+          end
+
+          sig { override.returns({ id: String, name: T.nilable(String) }) }
+          def to_hash
+          end
+        end
+
         module Outcome
           extend Revox::Internal::Type::Enum
 
@@ -2269,21 +2245,6 @@ module Revox
               :requested_callback_later,
               Revox::AssistantCreateParams::Slack::Outcome::TaggedSymbol
             )
-          REQUESTED_CALLBACK_NEW_NUMBER =
-            T.let(
-              :requested_callback_new_number,
-              Revox::AssistantCreateParams::Slack::Outcome::TaggedSymbol
-            )
-          DO_NOT_CONTACT =
-            T.let(
-              :do_not_contact,
-              Revox::AssistantCreateParams::Slack::Outcome::TaggedSymbol
-            )
-          AI_AVERSE =
-            T.let(
-              :ai_averse,
-              Revox::AssistantCreateParams::Slack::Outcome::TaggedSymbol
-            )
           NONE =
             T.let(
               :none,
@@ -2579,6 +2540,41 @@ module Revox
         end
       end
 
+      class TransferDestination < Revox::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Revox::AssistantCreateParams::TransferDestination,
+              Revox::Internal::AnyHash
+            )
+          end
+
+        # Human-meaningful name for this destination (e.g. "Sales"). The assistant's
+        # prompt refers to these labels when describing who to transfer to.
+        sig { returns(String) }
+        attr_accessor :label
+
+        # Destination phone number in E.164 format (e.g. +1234567890).
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        sig do
+          params(label: String, phone_number: String).returns(T.attached_class)
+        end
+        def self.new(
+          # Human-meaningful name for this destination (e.g. "Sales"). The assistant's
+          # prompt refers to these labels when describing who to transfer to.
+          label:,
+          # Destination phone number in E.164 format (e.g. +1234567890).
+          phone_number:
+        )
+        end
+
+        sig { override.returns({ label: String, phone_number: String }) }
+        def to_hash
+        end
+      end
+
       # Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step'
       # orchestrates a flow of sub-assistants, 'sub-assistant' is a step inside a
       # multi-step flow (hidden from the assistants list). Flow transitions are managed
@@ -2640,7 +2636,7 @@ module Revox
         attr_writer :model
 
         # 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.
         sig { returns(T.nilable(Float)) }
         attr_reader :speed
 
@@ -2675,7 +2671,7 @@ module Revox
           # for other providers.
           model: nil,
           # 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.
           speed: nil,
           # Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other
           # providers.
@@ -2717,6 +2713,11 @@ module Revox
               :elevenlabs,
               Revox::AssistantCreateParams::Voice::Provider::TaggedSymbol
             )
+          GRADIUM =
+            T.let(
+              :gradium,
+              Revox::AssistantCreateParams::Voice::Provider::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -2925,21 +2926,6 @@ module Revox
               :requested_callback_later,
               Revox::AssistantCreateParams::Zoho::Outcome::TaggedSymbol
             )
-          REQUESTED_CALLBACK_NEW_NUMBER =
-            T.let(
-              :requested_callback_new_number,
-              Revox::AssistantCreateParams::Zoho::Outcome::TaggedSymbol
-            )
-          DO_NOT_CONTACT =
-            T.let(
-              :do_not_contact,
-              Revox::AssistantCreateParams::Zoho::Outcome::TaggedSymbol
-            )
-          AI_AVERSE =
-            T.let(
-              :ai_averse,
-              Revox::AssistantCreateParams::Zoho::Outcome::TaggedSymbol
-            )
           NONE =
             T.let(
               :none,