revox 0.2.0 → 0.4.0

data/lib/revox/models/user_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Users#retrieve
+    class UserRetrieveParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/revox/models/user_retrieve_response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Users#retrieve
+    class UserRetrieveResponse < Revox::Internal::Type::BaseModel
+      # @!attribute user
+      #   The current authenticated user.
+      #
+      #   @return [Revox::Models::UserRetrieveResponse::User]
+      required :user, -> { Revox::Models::UserRetrieveResponse::User }
+
+      # @!method initialize(user:)
+      #   @param user [Revox::Models::UserRetrieveResponse::User] The current authenticated user.
+
+      # @see Revox::Models::UserRetrieveResponse#user
+      class User < Revox::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The time the user was created.
+        #
+        #   @return [Object]
+        required :created_at, Revox::Internal::Type::Unknown
+
+        # @!attribute email
+        #   The email address of the user.
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute first_name
+        #   The first name of the user.
+        #
+        #   @return [String, nil]
+        required :first_name, String, nil?: true
+
+        # @!attribute has_completed_onboarding
+        #   Whether the user has completed the onboarding tutorial.
+        #
+        #   @return [Boolean]
+        required :has_completed_onboarding, Revox::Internal::Type::Boolean
+
+        # @!attribute last_name
+        #   The last name of the user.
+        #
+        #   @return [String, nil]
+        required :last_name, String, nil?: true
+
+        # @!attribute organization_id
+        #   The ID of the organization the user belongs to.
+        #
+        #   @return [String]
+        required :organization_id, String
+
+        # @!attribute updated_at
+        #   The time the user was last updated.
+        #
+        #   @return [Object]
+        required :updated_at, Revox::Internal::Type::Unknown
+
+        # @!attribute organization_country
+        #   ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the
+        #   default region when normalizing national-format phone numbers.
+        #
+        #   @return [String, nil]
+        optional :organization_country, String, nil?: true
+
+        # @!method initialize(id:, created_at:, email:, first_name:, has_completed_onboarding:, last_name:, organization_id:, updated_at:, organization_country: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::UserRetrieveResponse::User} for more details.
+        #
+        #   The current authenticated user.
+        #
+        #   @param id [String] The unique identifier of the user.
+        #
+        #   @param created_at [Object] The time the user was created.
+        #
+        #   @param email [String] The email address of the user.
+        #
+        #   @param first_name [String, nil] The first name of the user.
+        #
+        #   @param has_completed_onboarding [Boolean] Whether the user has completed the onboarding tutorial.
+        #
+        #   @param last_name [String, nil] The last name of the user.
+        #
+        #   @param organization_id [String] The ID of the organization the user belongs to.
+        #
+        #   @param updated_at [Object] The time the user was last updated.
+        #
+        #   @param organization_country [String, nil] ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the defau
+      end
+    end
+  end
+end

data/lib/revox/models/voice_clone_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Voices#clone_
+    class VoiceCloneParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute audio
+      #   Base64-encoded audio data (max ~7.5MB decoded)
+      #
+      #   @return [String]
+      required :audio, String
+
+      # @!attribute content_type
+      #   MIME type of the audio
+      #
+      #   @return [Symbol, Revox::Models::VoiceCloneParams::ContentType]
+      required :content_type, enum: -> { Revox::VoiceCloneParams::ContentType }, api_name: :contentType
+
+      # @!attribute language
+      #   Language of the voice
+      #
+      #   @return [Symbol, Revox::Models::VoiceCloneParams::Language]
+      required :language, enum: -> { Revox::VoiceCloneParams::Language }
+
+      # @!attribute name
+      #   Name for the cloned voice
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(audio:, content_type:, language:, name:, request_options: {})
+      #   @param audio [String] Base64-encoded audio data (max ~7.5MB decoded)
+      #
+      #   @param content_type [Symbol, Revox::Models::VoiceCloneParams::ContentType] MIME type of the audio
+      #
+      #   @param language [Symbol, Revox::Models::VoiceCloneParams::Language] Language of the voice
+      #
+      #   @param name [String] Name for the cloned voice
+      #
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+
+      # MIME type of the audio
+      module ContentType
+        extend Revox::Internal::Type::Enum
+
+        AUDIO_WEBM = :"audio/webm"
+        AUDIO_WAV = :"audio/wav"
+        AUDIO_MPEG = :"audio/mpeg"
+        AUDIO_OGG = :"audio/ogg"
+        AUDIO_MP4 = :"audio/mp4"
+        VIDEO_WEBM = :"video/webm"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Language of the voice
+      module Language
+        extend Revox::Internal::Type::Enum
+
+        EN = :en
+        FR = :fr
+        ES = :es
+        DE = :de
+        IT = :it
+        PT = :pt
+        RU = :ru
+        ZH = :zh
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/revox/models/voice_clone_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Voices#clone_
+    class VoiceCloneResponse < Revox::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cartesia_voice_id
+      #
+      #   @return [String]
+      required :cartesia_voice_id, String, api_name: :cartesiaVoiceId
+
+      # @!attribute created_at
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute language
+      #
+      #   @return [String]
+      required :language, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(id:, cartesia_voice_id:, created_at:, language:, name:)
+      #   @param id [String]
+      #   @param cartesia_voice_id [String]
+      #   @param created_at [String]
+      #   @param language [String]
+      #   @param name [String]
+    end
+  end
+end

data/lib/revox/models/voice_delete_params.rb

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

data/lib/revox/models/voice_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Voices#delete
+    class VoiceDeleteResponse < Revox::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Revox::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/revox/models/voice_list_response.rb

@@ -120,6 +120,7 @@ module Revox
 
           CARTESIA = :cartesia
           ELEVENLABS = :elevenlabs
+          GRADIUM = :gradium
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/revox/models/voice_preview_params.rb

@@ -68,6 +68,7 @@ module Revox
 
         CARTESIA = :cartesia
         ELEVENLABS = :elevenlabs
+        GRADIUM = :gradium
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/revox/models/voice_retrieve_params.rb

@@ -27,6 +27,7 @@ module Revox
 
         CARTESIA = :cartesia
         ELEVENLABS = :elevenlabs
+        GRADIUM = :gradium
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/revox/models.rb

@@ -39,6 +39,8 @@ module Revox
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  AssistantCloneParams = Revox::Models::AssistantCloneParams
+
   AssistantCreateParams = Revox::Models::AssistantCreateParams
 
   AssistantDeleteParams = Revox::Models::AssistantDeleteParams
@@ -49,10 +51,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
@@ -65,9 +81,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/lib/revox/resources/assistants.rb

@@ -12,7 +12,7 @@ module Revox
       # voice provider and voice ID (Cartesia or ElevenLabs), and end-of-call behavior.
       # Once created, reference the assistant by its ID when placing calls.
       #
-      # @overload create(name:, 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, request_options: {})
+      # @overload create(name:, 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, request_options: {})
       #
       # @param name [String]
       #
@@ -36,8 +36,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::AssistantCreateParams::EmailNotificationLanguage] The language used for the notification email content. One of "en" or "fr". Defau
-      #
       # @param email_notification_outcomes [Array<Symbol, Revox::Models::AssistantCreateParams::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.
@@ -52,7 +50,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::AssistantCreateParams::HumanTransferMode, nil] When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER; tru
+      # @param human_transfer_mode [Symbol, Revox::Models::AssistantCreateParams::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
       #
@@ -66,6 +64,8 @@ module Revox
       #
       # @param position [Revox::Models::AssistantCreateParams::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::AssistantCreateParams::PromptFlow, nil] Visual prompt constructor data (nodes, edges, positions). Used by the UI to re-o
       #
       # @param slack [Revox::Models::AssistantCreateParams::Slack, nil] Slack notification config. When set, posts a message to the chosen channel after
@@ -88,7 +88,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::AssistantCreateParams::TransferDestination>, nil] Where calls can be transferred to when users ask to speak to a human. With a sin
       #
       # @param type [Symbol, Revox::Models::AssistantCreateParams::Type] Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step' orche
       #
@@ -150,7 +150,7 @@ module Revox
       # the prompt, voice, first sentence, name, or any other assistant property without
       # affecting the rest of the configuration.
       #
-      # @overload update(id, 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, name: nil, position: nil, prompt: 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, request_options: {})
+      # @overload update(id, 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, name: nil, position: nil, precall_lookup_url: nil, prompt: 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, request_options: {})
       #
       # @param id [String]
       #
@@ -172,8 +172,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::AssistantUpdateParams::EmailNotificationLanguage] The language used for the notification email content. One of "en" or "fr". Defau
-      #
       # @param email_notification_outcomes [Array<Symbol, Revox::Models::AssistantUpdateParams::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.
@@ -188,7 +186,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::AssistantUpdateParams::HumanTransferMode, nil] When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER; tru
+      # @param human_transfer_mode [Symbol, Revox::Models::AssistantUpdateParams::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
       #
@@ -204,6 +202,8 @@ module Revox
       #
       # @param position [Revox::Models::AssistantUpdateParams::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 [String] The prompt to use for the call. This will be given to the LLM (gpt-4.1)
       #
       # @param prompt_flow [Revox::Models::AssistantUpdateParams::PromptFlow, nil] Visual prompt constructor data (nodes, edges, positions). Used by the UI to re-o
@@ -228,7 +228,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::AssistantUpdateParams::TransferDestination>, nil] Where calls can be transferred to when users ask to speak to a human. With a sin
       #
       # @param type [Symbol, Revox::Models::AssistantUpdateParams::Type] Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step' orche
       #
@@ -301,6 +301,27 @@ module Revox
         )
       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.
+      #
+      # @overload clone_(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AssistantCloneResponse]
+      #
+      # @see Revox::Models::AssistantCloneParams
+      def clone_(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["assistants/%1$s/clone", id],
+          model: Revox::Models::AssistantCloneResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Revox::Client]

data/lib/revox/resources/auth_status.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class AuthStatus
+      # Check if your API key is still valid.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AuthStatusRetrieveResponse]
+      #
+      # @see Revox::Models::AuthStatusRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "auth-status",
+          model: Revox::Models::AuthStatusRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Revox::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end