revox 0.0.2

data/rbi/revox/models/voice_retrieve_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceRetrieveParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::VoiceRetrieveParams, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(Revox::VoiceRetrieveParams::Provider::OrSymbol) }
+      attr_accessor :provider
+
+      sig do
+        params(
+          provider: Revox::VoiceRetrieveParams::Provider::OrSymbol,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(provider:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            provider: Revox::VoiceRetrieveParams::Provider::OrSymbol,
+            request_options: Revox::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Provider
+        extend Revox::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Revox::VoiceRetrieveParams::Provider) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CARTESIA =
+          T.let(:cartesia, Revox::VoiceRetrieveParams::Provider::TaggedSymbol)
+        ELEVENLABS =
+          T.let(:elevenlabs, Revox::VoiceRetrieveParams::Provider::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Revox::VoiceRetrieveParams::Provider::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_retrieve_response.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceRetrieveResponse < Revox::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Revox::Models::VoiceRetrieveResponse, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(Revox::Models::VoiceRetrieveResponse::Voice) }
+      attr_reader :voice
+
+      sig do
+        params(voice: Revox::Models::VoiceRetrieveResponse::Voice::OrHash).void
+      end
+      attr_writer :voice
+
+      sig do
+        params(
+          voice: Revox::Models::VoiceRetrieveResponse::Voice::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(voice:)
+      end
+
+      sig do
+        override.returns({ voice: Revox::Models::VoiceRetrieveResponse::Voice })
+      end
+      def to_hash
+      end
+
+      class Voice < Revox::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Revox::Models::VoiceRetrieveResponse::Voice,
+              Revox::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig do
+          params(id: String, name: String, description: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(id:, name:, description: nil)
+        end
+
+        sig do
+          override.returns({ id: String, name: String, description: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/revox/models.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Revox
+  AssistantCreateParams = Revox::Models::AssistantCreateParams
+
+  AssistantDeleteParams = Revox::Models::AssistantDeleteParams
+
+  AssistantListParams = Revox::Models::AssistantListParams
+
+  AssistantRetrieveParams = Revox::Models::AssistantRetrieveParams
+
+  AssistantUpdateParams = Revox::Models::AssistantUpdateParams
+
+  CallCreateParams = Revox::Models::CallCreateParams
+
+  CallListParams = Revox::Models::CallListParams
+
+  CallRetrieveParams = Revox::Models::CallRetrieveParams
+
+  Users = Revox::Models::Users
+
+  VoiceListParams = Revox::Models::VoiceListParams
+
+  VoicePreviewParams = Revox::Models::VoicePreviewParams
+
+  VoiceRetrieveParams = Revox::Models::VoiceRetrieveParams
+end

data/rbi/revox/request_options.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Revox
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Revox::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias { T.any(Revox::RequestOptions, Revox::Internal::AnyHash) }
+
+    # @api private
+    sig { params(opts: Revox::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: Revox::Internal::AnyHash).returns(T.attached_class) }
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/revox/resources/assistants.rbi

@@ -0,0 +1,206 @@
+# typed: strong
+
+module Revox
+  module Resources
+    class Assistants
+      sig do
+        params(
+          name: String,
+          prompt: String,
+          background_sound:
+            T.nilable(Revox::AssistantCreateParams::BackgroundSound::OrSymbol),
+          calendly: T.nilable(Revox::AssistantCreateParams::Calendly::OrHash),
+          call_retry_config:
+            Revox::AssistantCreateParams::CallRetryConfig::OrHash,
+          end_of_call_sentence: String,
+          faq_items: T::Array[Revox::AssistantCreateParams::FaqItem::OrHash],
+          first_sentence: String,
+          first_sentence_delay_ms: Integer,
+          first_sentence_mode:
+            Revox::AssistantCreateParams::FirstSentenceMode::OrSymbol,
+          ivr_navigation_enabled: T::Boolean,
+          llm_model:
+            T.any(
+              Revox::AssistantCreateParams::LlmModel::UnionMember0::OrHash,
+              Revox::AssistantCreateParams::LlmModel::UnionMember1::OrHash
+            ),
+          max_call_duration_secs: Float,
+          structured_output_config:
+            T::Array[
+              Revox::AssistantCreateParams::StructuredOutputConfig::OrHash
+            ],
+          transfer_phone_number: T.nilable(String),
+          voice: Revox::AssistantCreateParams::Voice::OrHash,
+          voicemail_message: T.nilable(String),
+          webhook_url: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::AssistantCreateResponse)
+      end
+      def create(
+        name:,
+        # The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+        prompt:,
+        # The background sound to play during the call. Useful to give the impression that
+        # your AI agent is in an office, in the street, or anywhere else you want.
+        background_sound: nil,
+        calendly: nil,
+        # Configuration for call retry behavior including time windows, delays, and max
+        # iterations. If not provided, defaults will be used.
+        call_retry_config: nil,
+        # Optional message to say when the agent decides to end the call.
+        end_of_call_sentence: nil,
+        # FAQ items to associate with this assistant. When provided, replaces all existing
+        # FAQ items.
+        faq_items: nil,
+        # The first sentence to use for the call. This will be given to the LLM
+        first_sentence: nil,
+        # Delay in milliseconds before speaking the first sentence. Default: 400.
+        first_sentence_delay_ms: nil,
+        # How the first sentence should be handled. "generated" means the LLM will
+        # generate a response based on the first_sentence instruction. "static" means the
+        # first_sentence will be spoken exactly as provided. "none" means the agent will
+        # not speak first and will wait for the user.
+        first_sentence_mode: nil,
+        # Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
+        # skip turns to navigate phone menus.
+        ivr_navigation_enabled: nil,
+        llm_model: nil,
+        # The maximum duration of the call in seconds. This is the maximum time the call
+        # will be allowed to run.
+        max_call_duration_secs: nil,
+        # The structured output config to use for the call. This is used to extract the
+        # data from the call (like email, name, company name, etc.).
+        structured_output_config: 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,
+        # The voice to use for the call. You can get the list of voices using the /voices
+        # endpoint
+        voice: nil,
+        # If set, when voicemail is detected the agent will speak this message then hang
+        # up; if null, hang up immediately.
+        voicemail_message: nil,
+        # The webhook URL to call when the call is completed.
+        webhook_url: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::AssistantRetrieveResponse)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      sig do
+        params(
+          id: String,
+          background_sound:
+            T.nilable(Revox::AssistantUpdateParams::BackgroundSound::OrSymbol),
+          calendly: T.nilable(Revox::AssistantUpdateParams::Calendly::OrHash),
+          call_retry_config:
+            Revox::AssistantUpdateParams::CallRetryConfig::OrHash,
+          end_of_call_sentence: String,
+          faq_items: T::Array[Revox::AssistantUpdateParams::FaqItem::OrHash],
+          first_sentence: String,
+          first_sentence_delay_ms: Integer,
+          first_sentence_mode:
+            Revox::AssistantUpdateParams::FirstSentenceMode::OrSymbol,
+          ivr_navigation_enabled: T::Boolean,
+          llm_model:
+            T.any(
+              Revox::AssistantUpdateParams::LlmModel::UnionMember0::OrHash,
+              Revox::AssistantUpdateParams::LlmModel::UnionMember1::OrHash
+            ),
+          max_call_duration_secs: Float,
+          name: String,
+          prompt: String,
+          structured_output_config:
+            T::Array[
+              Revox::AssistantUpdateParams::StructuredOutputConfig::OrHash
+            ],
+          transfer_phone_number: T.nilable(String),
+          voice: Revox::AssistantUpdateParams::Voice::OrHash,
+          voicemail_message: T.nilable(String),
+          webhook_url: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::AssistantUpdateResponse)
+      end
+      def update(
+        id,
+        # The background sound to play during the call. Useful to give the impression that
+        # your AI agent is in an office, in the street, or anywhere else you want.
+        background_sound: nil,
+        calendly: nil,
+        # Configuration for call retry behavior including time windows, delays, and max
+        # iterations. If not provided, defaults will be used.
+        call_retry_config: nil,
+        # Optional message to say when the agent decides to end the call.
+        end_of_call_sentence: nil,
+        # FAQ items to associate with this assistant. When provided, replaces all existing
+        # FAQ items.
+        faq_items: nil,
+        # The first sentence to use for the call. This will be given to the LLM
+        first_sentence: nil,
+        # Delay in milliseconds before speaking the first sentence. Default: 400.
+        first_sentence_delay_ms: nil,
+        # How the first sentence should be handled. "generated" means the LLM will
+        # generate a response based on the first_sentence instruction. "static" means the
+        # first_sentence will be spoken exactly as provided. "none" means the agent will
+        # not speak first and will wait for the user.
+        first_sentence_mode: nil,
+        # Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
+        # skip turns to navigate phone menus.
+        ivr_navigation_enabled: nil,
+        llm_model: nil,
+        # The maximum duration of the call in seconds. This is the maximum time the call
+        # will be allowed to run.
+        max_call_duration_secs: nil,
+        name: nil,
+        # The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+        prompt: nil,
+        # The structured output config to use for the call. This is used to extract the
+        # data from the call (like email, name, company name, etc.).
+        structured_output_config: 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,
+        # The voice to use for the call. You can get the list of voices using the /voices
+        # endpoint
+        voice: nil,
+        # If set, when voicemail is detected the agent will speak this message then hang
+        # up; if null, hang up immediately.
+        voicemail_message: nil,
+        # The webhook URL to call when the call is completed.
+        webhook_url: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(request_options: Revox::RequestOptions::OrHash).returns(
+          Revox::Models::AssistantListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::AssistantDeleteResponse)
+      end
+      def delete(id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Revox::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/revox/resources/call.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Revox
+  module Resources
+    class Call
+      # Place a new call order. A call order can be resolved over multiple call attempts
+      # spanning up to a few days.
+      sig do
+        params(
+          phone_number: String,
+          assistant: Revox::CallCreateParams::Assistant::OrHash,
+          assistant_id: String,
+          concurrency: Revox::CallCreateParams::Concurrency::OrHash,
+          force_now: T::Boolean,
+          from_phone_number: String,
+          metadata: T::Hash[Symbol, String],
+          prompt_variables: T::Hash[Symbol, String],
+          scheduled_at: Revox::CallCreateParams::ScheduledAt::Variants,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallCreateResponse)
+      end
+      def create(
+        # The phone number to call in the E.164 format. Example: +1234567890
+        phone_number:,
+        # You can provide a custom assistant configuration here. If you don't provide an
+        # assistant_id, this assistant object will be used for this call.
+        assistant: nil,
+        # The ID of the assistant to use for this call.
+        assistant_id: nil,
+        # Limit the number of concurrent calls for a given concurrency key.
+        concurrency: nil,
+        # The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+        force_now: nil,
+        # The phone number to use for making the call (e.g., +1234567890). If not
+        # provided, uses the default trunk.
+        from_phone_number: nil,
+        # Metadata to store with the call.
+        metadata: nil,
+        # Variables to interpolate into the prompt. Wether you use an assistant_id or an
+        # assistant object, this will be used to interpolate the variables into the
+        # prompt.
+        prompt_variables: nil,
+        # Schedule the call to start at a specific date and time (ISO 8601 format). If not
+        # provided, the call will start immediately.
+        scheduled_at: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a call order by ID.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the call to get.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get the list of call orders.
+      sig do
+        params(
+          page: Float,
+          page_size: Float,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallListResponse)
+      end
+      def list(
+        # The page number you want to get. Starting at 0.
+        page:,
+        page_size:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Revox::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/revox/resources/users/me.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Revox
+  module Resources
+    class Users
+      class Me
+        # Get the current authenticated user.
+        sig do
+          params(request_options: Revox::RequestOptions::OrHash).returns(
+            Revox::Models::Users::MeRetrieveResponse
+          )
+        end
+        def retrieve(request_options: {})
+        end
+
+        # Update the current authenticated user.
+        sig do
+          params(
+            has_completed_onboarding: T::Boolean,
+            request_options: Revox::RequestOptions::OrHash
+          ).returns(Revox::Models::Users::MeUpdateResponse)
+        end
+        def update(has_completed_onboarding: nil, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Revox::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/revox/resources/users.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Revox
+  module Resources
+    class Users
+      sig { returns(Revox::Resources::Users::Me) }
+      attr_reader :me
+
+      # @api private
+      sig { params(client: Revox::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/revox/resources/voices.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Revox
+  module Resources
+    class Voices
+      # Get a single voice by ID.
+      sig do
+        params(
+          id: String,
+          provider: Revox::VoiceRetrieveParams::Provider::OrSymbol,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::VoiceRetrieveResponse)
+      end
+      def retrieve(
+        # The voice ID to get.
+        id,
+        provider:,
+        request_options: {}
+      )
+      end
+
+      # Get the list of voices available for the call. Supports Cartesia, ElevenLabs,
+      # Inworld voices.
+      sig do
+        params(request_options: Revox::RequestOptions::OrHash).returns(
+          Revox::Models::VoiceListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Generate a voice preview audio sample for a given voice ID.
+      sig do
+        params(
+          provider: Revox::VoicePreviewParams::Provider::OrSymbol,
+          voice_id: String,
+          text: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).void
+      end
+      def preview(
+        # The provider to use for the preview.
+        provider:,
+        # The voice ID to generate a preview for.
+        voice_id:,
+        # The text to generate a preview for.
+        text: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Revox::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/revox/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Revox
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/revox/client.rbs

@@ -0,0 +1,32 @@
+module Revox
+  class Client < Revox::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader assistants: Revox::Resources::Assistants
+
+    attr_reader call: Revox::Resources::Call
+
+    attr_reader voices: Revox::Resources::Voices
+
+    attr_reader users: Revox::Resources::Users
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end