revox 0.3.0 → 0.5.0

data/lib/revox/models/call_create_params.rb

@@ -27,17 +27,13 @@ module Revox
       optional :assistant_id, String
 
       # @!attribute concurrency
-      #   Limit the number of concurrent calls for a given concurrency key.
+      #   Limit the number of concurrent calls for a given concurrency key. The limit
+      #   itself is set server-side; omit this to leave the call ungrouped (bounded only
+      #   by your organization's limit).
       #
       #   @return [Revox::Models::CallCreateParams::Concurrency, nil]
       optional :concurrency, -> { Revox::CallCreateParams::Concurrency }
 
-      # @!attribute force_now
-      #   The prompt to use for the call. This will be given to the LLM (gpt-4.1)
-      #
-      #   @return [Boolean, nil]
-      optional :force_now, Revox::Internal::Type::Boolean
-
       # @!attribute from_phone_number
       #   The phone number to use for making the call (e.g., +1234567890). If not
       #   provided, uses the default trunk.
@@ -66,7 +62,14 @@ module Revox
       #   @return [Time, Object, nil]
       optional :scheduled_at, union: -> { Revox::CallCreateParams::ScheduledAt }
 
-      # @!method initialize(phone_number:, assistant: nil, assistant_id: nil, concurrency: nil, force_now: nil, from_phone_number: nil, metadata: nil, prompt_variables: nil, scheduled_at: nil, request_options: {})
+      # @!attribute skip_calling_window
+      #   Bypass the calling-window check for this call so it dials even outside the
+      #   assistant's configured window. Use for immediate 'call now' dials.
+      #
+      #   @return [Boolean, nil]
+      optional :skip_calling_window, Revox::Internal::Type::Boolean
+
+      # @!method initialize(phone_number:, assistant: nil, assistant_id: nil, concurrency: nil, from_phone_number: nil, metadata: nil, prompt_variables: nil, scheduled_at: nil, skip_calling_window: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Revox::Models::CallCreateParams} for more details.
       #
@@ -76,9 +79,7 @@ module Revox
       #
       #   @param assistant_id [String] The ID of the assistant to use for this call.
       #
-      #   @param concurrency [Revox::Models::CallCreateParams::Concurrency] Limit the number of concurrent calls for a given concurrency key.
-      #
-      #   @param force_now [Boolean] The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+      #   @param concurrency [Revox::Models::CallCreateParams::Concurrency] Limit the number of concurrent calls for a given concurrency key. The limit itse
       #
       #   @param from_phone_number [String] The phone number to use for making the call (e.g., +1234567890). If not provided
       #
@@ -88,6 +89,8 @@ module Revox
       #
       #   @param scheduled_at [Time, Object] Schedule the call to start at a specific date and time (ISO 8601 format). If not
       #
+      #   @param skip_calling_window [Boolean] Bypass the calling-window check for this call so it dials even outside the assis
+      #
       #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
 
       class Assistant < Revox::Internal::Type::BaseModel
@@ -168,14 +171,6 @@ module Revox
         #   @return [String, nil]
         optional :email_notification_address, String, nil?: true
 
-        # @!attribute email_notification_language
-        #   The language used for the notification email content. One of "en" or "fr".
-        #   Defaults to "en".
-        #
-        #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationLanguage, nil]
-        optional :email_notification_language,
-                 enum: -> { Revox::CallCreateParams::Assistant::EmailNotificationLanguage }
-
         # @!attribute email_notification_outcomes
         #   Which call outcomes trigger an email notification. E.g. ["interested",
         #   "completed", "none"]. Use "none" when outcome is null.
@@ -230,8 +225,8 @@ module Revox
         optional :from_phone_number, String, nil?: true
 
         # @!attribute human_transfer_mode
-        #   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.
         #
         #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::HumanTransferMode, nil]
         optional :human_transfer_mode,
@@ -278,6 +273,16 @@ module Revox
         #   @return [Revox::Models::CallCreateParams::Assistant::Position, nil]
         optional :position, -> { Revox::CallCreateParams::Assistant::Position }, nil?: true
 
+        # @!attribute precall_lookup_url
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :precall_lookup_url, String, nil?: true
+
         # @!attribute prompt_flow
         #   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
@@ -359,12 +364,18 @@ module Revox
         #   @return [Float, nil]
         optional :thinking_sound_volume, Float
 
-        # @!attribute transfer_phone_number
-        #   Phone number to transfer calls to when users request to speak to a human agent
-        #   in E.164 format (e.g. +1234567890).
+        # @!attribute transfer_destinations
+        #   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.
         #
-        #   @return [String, nil]
-        optional :transfer_phone_number, String, nil?: true
+        #   @return [Array<Revox::Models::CallCreateParams::Assistant::TransferDestination>, nil]
+        optional :transfer_destinations,
+                 -> {
+                   Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::TransferDestination]
+                 },
+                 nil?: true
 
         # @!attribute type
         #   Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step'
@@ -418,7 +429,7 @@ module Revox
         #   @return [Revox::Models::CallCreateParams::Assistant::Zoho, nil]
         optional :zoho, -> { Revox::CallCreateParams::Assistant::Zoho }, nil?: true
 
-        # @!method initialize(prompt:, after_call_sms_outcomes: nil, after_call_sms_prompt: nil, background_sound: nil, background_sound_volume: nil, calendly: nil, call_retry_config: nil, cartesia_dictionary_pronunciation_id: nil, custom_tools: nil, email_notification_address: nil, email_notification_language: nil, email_notification_outcomes: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, from_phone_number: nil, human_transfer_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, logo_url: nil, max_call_duration_secs: nil, max_duration_end_message: nil, position: nil, prompt_flow: nil, slack: nil, sms_enabled: nil, sms_template: nil, structured_output_config: nil, structured_output_prompt: nil, stt_context: nil, stt_model: nil, thinking_sound: nil, thinking_sound_probability: nil, thinking_sound_volume: nil, transfer_phone_number: nil, type: nil, voice: nil, voicemail_message: nil, voicemail_sms_prompt: nil, warm_transfer_summary_instructions: nil, webhook_url: nil, zoho: nil)
+        # @!method initialize(prompt:, after_call_sms_outcomes: nil, after_call_sms_prompt: nil, background_sound: nil, background_sound_volume: nil, calendly: nil, call_retry_config: nil, cartesia_dictionary_pronunciation_id: nil, custom_tools: nil, email_notification_address: nil, email_notification_outcomes: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, from_phone_number: nil, human_transfer_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, logo_url: nil, max_call_duration_secs: nil, max_duration_end_message: nil, position: nil, precall_lookup_url: nil, prompt_flow: nil, slack: nil, sms_enabled: nil, sms_template: nil, structured_output_config: nil, structured_output_prompt: nil, stt_context: nil, stt_model: nil, thinking_sound: nil, thinking_sound_probability: nil, thinking_sound_volume: nil, transfer_destinations: nil, type: nil, voice: nil, voicemail_message: nil, voicemail_sms_prompt: nil, warm_transfer_summary_instructions: nil, webhook_url: nil, zoho: nil)
         #   Some parameter documentations has been truncated, see
         #   {Revox::Models::CallCreateParams::Assistant} for more details.
         #
@@ -445,8 +456,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::CallCreateParams::Assistant::EmailNotificationLanguage] The language used for the notification email content. One of "en" or "fr". Defau
-        #
         #   @param email_notification_outcomes [Array<Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationOutcome>, nil] Which call outcomes trigger an email notification. E.g. ["interested", "complete
         #
         #   @param end_of_call_sentence [String] Optional message to say when the agent decides to end the call.
@@ -461,7 +470,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::CallCreateParams::Assistant::HumanTransferMode, nil] When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER; tru
+        #   @param human_transfer_mode [Symbol, Revox::Models::CallCreateParams::Assistant::HumanTransferMode, nil] When transfer_destinations is non-empty: "warm" (AI bridges) or "cold" (SIP REFE
         #
         #   @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
         #
@@ -475,6 +484,8 @@ module Revox
         #
         #   @param position [Revox::Models::CallCreateParams::Assistant::Position, nil] Canvas position of this assistant's node in its multi-step flow editor.
         #
+        #   @param precall_lookup_url [String, nil] Inbound calls only. URL fetched over HTTP GET right before the call is answered,
+        #
         #   @param prompt_flow [Revox::Models::CallCreateParams::Assistant::PromptFlow, nil] Visual prompt constructor data (nodes, edges, positions). Used by the UI to re-o
         #
         #   @param slack [Revox::Models::CallCreateParams::Assistant::Slack, nil] Slack notification config. When set, posts a message to the chosen channel after
@@ -497,7 +508,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 i
+        #   @param transfer_destinations [Array<Revox::Models::CallCreateParams::Assistant::TransferDestination>, nil] Where calls can be transferred to when users ask to speak to a human. With a sin
         #
         #   @param type [Symbol, Revox::Models::CallCreateParams::Assistant::Type] Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step' orche
         #
@@ -520,9 +531,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
@@ -654,7 +662,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
@@ -668,7 +677,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
 
@@ -851,20 +860,6 @@ module Revox
           end
         end
 
-        # The language used for the notification email content. One of "en" or "fr".
-        # Defaults to "en".
-        #
-        # @see Revox::Models::CallCreateParams::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
 
@@ -872,9 +867,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
@@ -914,8 +906,8 @@ module Revox
           #   @return [Array<Symbol>]
         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.
         #
         # @see Revox::Models::CallCreateParams::Assistant#human_transfer_mode
         module HumanTransferMode
@@ -1209,11 +1201,14 @@ module Revox
 
         # @see Revox::Models::CallCreateParams::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::CallCreateParams::Assistant::Slack::Channel>]
+          required :channels,
+                   -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::Slack::Channel] }
 
           # @!attribute connection_id
           #   The Nango connection ID linking the org's Slack workspace to Revox.
@@ -1229,40 +1224,55 @@ module Revox
           required :outcomes,
                    -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::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::CallCreateParams::Assistant::Slack} for more details.
           #
           #   Slack notification config. When set, posts a message to the chosen channel after
           #   a call ends with one of the configured outcomes.
           #
-          #   @param channel_id [String] The Slack channel ID where the notification will be posted.
+          #   @param channels [Array<Revox::Models::CallCreateParams::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::CallCreateParams::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::CallCreateParams::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
 
@@ -1270,9 +1280,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
@@ -1400,6 +1407,30 @@ module Revox
           #   @return [Array<Symbol>]
         end
 
+        class TransferDestination < Revox::Internal::Type::BaseModel
+          # @!attribute label
+          #   Human-meaningful name for this destination (e.g. "Sales"). The assistant's
+          #   prompt refers to these labels when describing who to transfer to.
+          #
+          #   @return [String]
+          required :label, String
+
+          # @!attribute phone_number
+          #   Destination phone number in E.164 format (e.g. +1234567890).
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!method initialize(label:, phone_number:)
+          #   Some parameter documentations has been truncated, see
+          #   {Revox::Models::CallCreateParams::Assistant::TransferDestination} for more
+          #   details.
+          #
+          #   @param label [String] Human-meaningful name for this destination (e.g. "Sales"). The assistant's promp
+          #
+          #   @param phone_number [String] Destination phone number in E.164 format (e.g. +1234567890).
+        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
@@ -1440,7 +1471,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
@@ -1477,6 +1508,7 @@ module Revox
 
             CARTESIA = :cartesia
             ELEVENLABS = :elevenlabs
+            GRADIUM = :gradium
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -1595,9 +1627,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
@@ -1608,23 +1637,21 @@ module Revox
 
       class Concurrency < Revox::Internal::Type::BaseModel
         # @!attribute key
-        #   The key for which you want to limit the number of concurrent calls.
+        #   Groups this call with every other call sharing the same key, for concurrency
+        #   purposes.
         #
         #   @return [String]
         required :key, String
 
-        # @!attribute max
-        #   The maximum number of concurrent calls to allow for the given concurrency key.
-        #
-        #   @return [Float]
-        required :max, Float
-
-        # @!method initialize(key:, max:)
-        #   Limit the number of concurrent calls for a given concurrency key.
+        # @!method initialize(key:)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::CallCreateParams::Concurrency} for more details.
         #
-        #   @param key [String] The key for which you want to limit the number of concurrent calls.
+        #   Limit the number of concurrent calls for a given concurrency key. The limit
+        #   itself is set server-side; omit this to leave the call ungrouped (bounded only
+        #   by your organization's limit).
         #
-        #   @param max [Float] The maximum number of concurrent calls to allow for the given concurrency key.
+        #   @param key [String] Groups this call with every other call sharing the same key, for concurrency pur
       end
 
       # Schedule the call to start at a specific date and time (ISO 8601 format). If not