revox 0.2.0 → 0.4.0

data/rbi/revox/models/user_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Revox
+  module Models
+    class UserRetrieveParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::UserRetrieveParams, Revox::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Revox::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Revox::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/revox/models/user_retrieve_response.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Revox
+  module Models
+    class UserRetrieveResponse < Revox::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Revox::Models::UserRetrieveResponse, Revox::Internal::AnyHash)
+        end
+
+      # The current authenticated user.
+      sig { returns(Revox::Models::UserRetrieveResponse::User) }
+      attr_reader :user
+
+      sig do
+        params(user: Revox::Models::UserRetrieveResponse::User::OrHash).void
+      end
+      attr_writer :user
+
+      sig do
+        params(user: Revox::Models::UserRetrieveResponse::User::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # The current authenticated user.
+        user:
+      )
+      end
+
+      sig do
+        override.returns({ user: Revox::Models::UserRetrieveResponse::User })
+      end
+      def to_hash
+      end
+
+      class User < Revox::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Revox::Models::UserRetrieveResponse::User,
+              Revox::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The time the user was created.
+        sig { returns(T.anything) }
+        attr_accessor :created_at
+
+        # The email address of the user.
+        sig { returns(String) }
+        attr_accessor :email
+
+        # The first name of the user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :first_name
+
+        # Whether the user has completed the onboarding tutorial.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_completed_onboarding
+
+        # The last name of the user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :last_name
+
+        # The ID of the organization the user belongs to.
+        sig { returns(String) }
+        attr_accessor :organization_id
+
+        # The time the user was last updated.
+        sig { returns(T.anything) }
+        attr_accessor :updated_at
+
+        # ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the
+        # default region when normalizing national-format phone numbers.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :organization_country
+
+        # The current authenticated user.
+        sig do
+          params(
+            id: String,
+            created_at: T.anything,
+            email: String,
+            first_name: T.nilable(String),
+            has_completed_onboarding: T::Boolean,
+            last_name: T.nilable(String),
+            organization_id: String,
+            updated_at: T.anything,
+            organization_country: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier of the user.
+          id:,
+          # The time the user was created.
+          created_at:,
+          # The email address of the user.
+          email:,
+          # The first name of the user.
+          first_name:,
+          # Whether the user has completed the onboarding tutorial.
+          has_completed_onboarding:,
+          # The last name of the user.
+          last_name:,
+          # The ID of the organization the user belongs to.
+          organization_id:,
+          # The time the user was last updated.
+          updated_at:,
+          # ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the
+          # default region when normalizing national-format phone numbers.
+          organization_country: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: T.anything,
+              email: String,
+              first_name: T.nilable(String),
+              has_completed_onboarding: T::Boolean,
+              last_name: T.nilable(String),
+              organization_id: String,
+              updated_at: T.anything,
+              organization_country: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_clone_params.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceCloneParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::VoiceCloneParams, Revox::Internal::AnyHash)
+        end
+
+      # Base64-encoded audio data (max ~7.5MB decoded)
+      sig { returns(String) }
+      attr_accessor :audio
+
+      # MIME type of the audio
+      sig { returns(Revox::VoiceCloneParams::ContentType::OrSymbol) }
+      attr_accessor :content_type
+
+      # Language of the voice
+      sig { returns(Revox::VoiceCloneParams::Language::OrSymbol) }
+      attr_accessor :language
+
+      # Name for the cloned voice
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          audio: String,
+          content_type: Revox::VoiceCloneParams::ContentType::OrSymbol,
+          language: Revox::VoiceCloneParams::Language::OrSymbol,
+          name: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Base64-encoded audio data (max ~7.5MB decoded)
+        audio:,
+        # MIME type of the audio
+        content_type:,
+        # Language of the voice
+        language:,
+        # Name for the cloned voice
+        name:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            audio: String,
+            content_type: Revox::VoiceCloneParams::ContentType::OrSymbol,
+            language: Revox::VoiceCloneParams::Language::OrSymbol,
+            name: String,
+            request_options: Revox::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # MIME type of the audio
+      module ContentType
+        extend Revox::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Revox::VoiceCloneParams::ContentType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUDIO_WEBM =
+          T.let(
+            :"audio/webm",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_WAV =
+          T.let(
+            :"audio/wav",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_MPEG =
+          T.let(
+            :"audio/mpeg",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_OGG =
+          T.let(
+            :"audio/ogg",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_MP4 =
+          T.let(
+            :"audio/mp4",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        VIDEO_WEBM =
+          T.let(
+            :"video/webm",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Revox::VoiceCloneParams::ContentType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Language of the voice
+      module Language
+        extend Revox::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Revox::VoiceCloneParams::Language) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EN = T.let(:en, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        FR = T.let(:fr, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        ES = T.let(:es, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        DE = T.let(:de, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        IT = T.let(:it, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        PT = T.let(:pt, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        RU = T.let(:ru, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        ZH = T.let(:zh, Revox::VoiceCloneParams::Language::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Revox::VoiceCloneParams::Language::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_clone_response.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceCloneResponse < Revox::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Revox::Models::VoiceCloneResponse, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :cartesia_voice_id
+
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :language
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          id: String,
+          cartesia_voice_id: String,
+          created_at: String,
+          language: String,
+          name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, cartesia_voice_id:, created_at:, language:, name:)
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            cartesia_voice_id: String,
+            created_at: String,
+            language: String,
+            name: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_delete_params.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceDeleteParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::VoiceDeleteParams, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns({ id: String, request_options: Revox::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_delete_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceDeleteResponse < Revox::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Revox::Models::VoiceDeleteResponse, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig { params(success: T::Boolean).returns(T.attached_class) }
+      def self.new(success:)
+      end
+
+      sig { override.returns({ success: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_list_response.rbi

@@ -248,6 +248,11 @@ module Revox
               :elevenlabs,
               Revox::Models::VoiceListResponse::Voice::Provider::TaggedSymbol
             )
+          GRADIUM =
+            T.let(
+              :gradium,
+              Revox::Models::VoiceListResponse::Voice::Provider::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/revox/models/voice_preview_params.rbi

@@ -105,6 +105,8 @@ module Revox
           T.let(:cartesia, Revox::VoicePreviewParams::Provider::TaggedSymbol)
         ELEVENLABS =
           T.let(:elevenlabs, Revox::VoicePreviewParams::Provider::TaggedSymbol)
+        GRADIUM =
+          T.let(:gradium, Revox::VoicePreviewParams::Provider::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/revox/models/voice_retrieve_params.rbi

@@ -50,6 +50,8 @@ module Revox
           T.let(:cartesia, Revox::VoiceRetrieveParams::Provider::TaggedSymbol)
         ELEVENLABS =
           T.let(:elevenlabs, Revox::VoiceRetrieveParams::Provider::TaggedSymbol)
+        GRADIUM =
+          T.let(:gradium, Revox::VoiceRetrieveParams::Provider::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/revox/models.rbi

@@ -1,6 +1,8 @@
 # typed: strong
 
 module Revox
+  AssistantCloneParams = Revox::Models::AssistantCloneParams
+
   AssistantCreateParams = Revox::Models::AssistantCreateParams
 
   AssistantDeleteParams = Revox::Models::AssistantDeleteParams
@@ -11,10 +13,24 @@ module Revox
 
   AssistantUpdateParams = Revox::Models::AssistantUpdateParams
 
+  AuthStatusRetrieveParams = Revox::Models::AuthStatusRetrieveParams
+
+  CallCancelParams = Revox::Models::CallCancelParams
+
   CallCreateParams = Revox::Models::CallCreateParams
 
+  CallExportParams = Revox::Models::CallExportParams
+
+  CallPauseParams = Revox::Models::CallPauseParams
+
+  CallPhoneHistoryParams = Revox::Models::CallPhoneHistoryParams
+
+  CallResumeParams = Revox::Models::CallResumeParams
+
   CallRetrieveParams = Revox::Models::CallRetrieveParams
 
+  CallSearchParams = Revox::Models::CallSearchParams
+
   CampaignCancelParams = Revox::Models::CampaignCancelParams
 
   CampaignCreateParams = Revox::Models::CampaignCreateParams
@@ -27,9 +43,27 @@ module Revox
 
   CampaignListParams = Revox::Models::CampaignListParams
 
+  CampaignPauseParams = Revox::Models::CampaignPauseParams
+
+  CampaignResumeParams = Revox::Models::CampaignResumeParams
+
   CampaignRetrieveParams = Revox::Models::CampaignRetrieveParams
 
-  Users = Revox::Models::Users
+  CampaignStatisticsParams = Revox::Models::CampaignStatisticsParams
+
+  CampaignUpdateParams = Revox::Models::CampaignUpdateParams
+
+  PhoneNumberDeleteParams = Revox::Models::PhoneNumberDeleteParams
+
+  PhoneNumberListParams = Revox::Models::PhoneNumberListParams
+
+  PhoneNumberUpdateParams = Revox::Models::PhoneNumberUpdateParams
+
+  UserRetrieveParams = Revox::Models::UserRetrieveParams
+
+  VoiceCloneParams = Revox::Models::VoiceCloneParams
+
+  VoiceDeleteParams = Revox::Models::VoiceDeleteParams
 
   VoiceListParams = Revox::Models::VoiceListParams
 

data/rbi/revox/resources/assistants.rbi

@@ -31,8 +31,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[
@@ -62,6 +60,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),
@@ -79,7 +78,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),
@@ -119,9 +123,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,
@@ -143,8 +144,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.
@@ -162,6 +163,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.
@@ -198,9 +205,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
@@ -268,8 +277,6 @@ module Revox
               T::Array[Revox::AssistantUpdateParams::CustomTool::OrHash]
             ),
           email_notification_address: T.nilable(String),
-          email_notification_language:
-            Revox::AssistantUpdateParams::EmailNotificationLanguage::OrSymbol,
           email_notification_outcomes:
             T.nilable(
               T::Array[
@@ -300,6 +307,7 @@ module Revox
           max_duration_end_message: T.nilable(String),
           name: String,
           position: T.nilable(Revox::AssistantUpdateParams::Position::OrHash),
+          precall_lookup_url: T.nilable(String),
           prompt: String,
           prompt_flow:
             T.nilable(Revox::AssistantUpdateParams::PromptFlow::OrHash),
@@ -318,7 +326,12 @@ module Revox
             T.nilable(Revox::AssistantUpdateParams::ThinkingSound::OrSymbol),
           thinking_sound_probability: Float,
           thinking_sound_volume: Float,
-          transfer_phone_number: T.nilable(String),
+          transfer_destinations:
+            T.nilable(
+              T::Array[
+                Revox::AssistantUpdateParams::TransferDestination::OrHash
+              ]
+            ),
           type: Revox::AssistantUpdateParams::Type::OrSymbol,
           voice: Revox::AssistantUpdateParams::Voice::OrHash,
           voicemail_message: T.nilable(String),
@@ -356,9 +369,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,
@@ -380,8 +390,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.
@@ -400,6 +410,12 @@ module Revox
         name: 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,
         # The prompt to use for the call. This will be given to the LLM (gpt-4.1)
         prompt: nil,
         # Visual prompt constructor data (nodes, edges, positions). Used by the UI to
@@ -438,9 +454,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
@@ -492,6 +510,18 @@ module Revox
       def delete(id, request_options: {})
       end
 
+      # Create a full copy of an existing assistant, including every configuration field
+      # and FAQ items. The new assistant has the same configuration as the source, with
+      # the name suffixed by "(Copy)" and a freshly generated API key.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::AssistantCloneResponse)
+      end
+      def clone_(id, request_options: {})
+      end
+
       # @api private
       sig { params(client: Revox::Client).returns(T.attached_class) }
       def self.new(client:)