revox 0.0.2

data/lib/revox/resources/assistants.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class Assistants
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::AssistantCreateParams} for more details.
+      #
+      # @overload create(name:, prompt:, background_sound: nil, calendly: nil, call_retry_config: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, max_call_duration_secs: nil, structured_output_config: nil, transfer_phone_number: nil, voice: nil, voicemail_message: nil, webhook_url: nil, request_options: {})
+      #
+      # @param name [String]
+      #
+      # @param prompt [String] The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+      #
+      # @param background_sound [Symbol, Revox::Models::AssistantCreateParams::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
+      #
+      # @param calendly [Revox::Models::AssistantCreateParams::Calendly, nil]
+      #
+      # @param call_retry_config [Revox::Models::AssistantCreateParams::CallRetryConfig] Configuration for call retry behavior including time windows, delays, and max it
+      #
+      # @param end_of_call_sentence [String] Optional message to say when the agent decides to end the call.
+      #
+      # @param faq_items [Array<Revox::Models::AssistantCreateParams::FaqItem>] FAQ items to associate with this assistant. When provided, replaces all existing
+      #
+      # @param first_sentence [String] The first sentence to use for the call. This will be given to the LLM
+      #
+      # @param first_sentence_delay_ms [Integer] Delay in milliseconds before speaking the first sentence. Default: 400.
+      #
+      # @param first_sentence_mode [Symbol, Revox::Models::AssistantCreateParams::FirstSentenceMode] How the first sentence should be handled. "generated" means the LLM will generat
+      #
+      # @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
+      #
+      # @param llm_model [Revox::Models::AssistantCreateParams::LlmModel::UnionMember0, Revox::Models::AssistantCreateParams::LlmModel::UnionMember1]
+      #
+      # @param max_call_duration_secs [Float] The maximum duration of the call in seconds. This is the maximum time the call w
+      #
+      # @param structured_output_config [Array<Revox::Models::AssistantCreateParams::StructuredOutputConfig>] The structured output config to use for the call. This is used to extract the da
+      #
+      # @param transfer_phone_number [String, nil] Phone number to transfer calls to when users request to speak to a human agent i
+      #
+      # @param voice [Revox::Models::AssistantCreateParams::Voice] The voice to use for the call. You can get the list of voices using the /voices
+      #
+      # @param voicemail_message [String, nil] If set, when voicemail is detected the agent will speak this message then hang u
+      #
+      # @param webhook_url [String] The webhook URL to call when the call is completed.
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AssistantCreateResponse]
+      #
+      # @see Revox::Models::AssistantCreateParams
+      def create(params)
+        parsed, options = Revox::AssistantCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "assistants",
+          body: parsed,
+          model: Revox::Models::AssistantCreateResponse,
+          options: options
+        )
+      end
+
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AssistantRetrieveResponse]
+      #
+      # @see Revox::Models::AssistantRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["assistants/%1$s", id],
+          model: Revox::Models::AssistantRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::AssistantUpdateParams} for more details.
+      #
+      # @overload update(id, background_sound: nil, calendly: nil, call_retry_config: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, max_call_duration_secs: nil, name: nil, prompt: nil, structured_output_config: nil, transfer_phone_number: nil, voice: nil, voicemail_message: nil, webhook_url: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param background_sound [Symbol, Revox::Models::AssistantUpdateParams::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
+      #
+      # @param calendly [Revox::Models::AssistantUpdateParams::Calendly, nil]
+      #
+      # @param call_retry_config [Revox::Models::AssistantUpdateParams::CallRetryConfig] Configuration for call retry behavior including time windows, delays, and max it
+      #
+      # @param end_of_call_sentence [String] Optional message to say when the agent decides to end the call.
+      #
+      # @param faq_items [Array<Revox::Models::AssistantUpdateParams::FaqItem>] FAQ items to associate with this assistant. When provided, replaces all existing
+      #
+      # @param first_sentence [String] The first sentence to use for the call. This will be given to the LLM
+      #
+      # @param first_sentence_delay_ms [Integer] Delay in milliseconds before speaking the first sentence. Default: 400.
+      #
+      # @param first_sentence_mode [Symbol, Revox::Models::AssistantUpdateParams::FirstSentenceMode] How the first sentence should be handled. "generated" means the LLM will generat
+      #
+      # @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
+      #
+      # @param llm_model [Revox::Models::AssistantUpdateParams::LlmModel::UnionMember0, Revox::Models::AssistantUpdateParams::LlmModel::UnionMember1]
+      #
+      # @param max_call_duration_secs [Float] The maximum duration of the call in seconds. This is the maximum time the call w
+      #
+      # @param name [String]
+      #
+      # @param prompt [String] The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+      #
+      # @param structured_output_config [Array<Revox::Models::AssistantUpdateParams::StructuredOutputConfig>] The structured output config to use for the call. This is used to extract the da
+      #
+      # @param transfer_phone_number [String, nil] Phone number to transfer calls to when users request to speak to a human agent i
+      #
+      # @param voice [Revox::Models::AssistantUpdateParams::Voice] The voice to use for the call. You can get the list of voices using the /voices
+      #
+      # @param voicemail_message [String, nil] If set, when voicemail is detected the agent will speak this message then hang u
+      #
+      # @param webhook_url [String] The webhook URL to call when the call is completed.
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AssistantUpdateResponse]
+      #
+      # @see Revox::Models::AssistantUpdateParams
+      def update(id, params = {})
+        parsed, options = Revox::AssistantUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["assistants/%1$s", id],
+          body: parsed,
+          model: Revox::Models::AssistantUpdateResponse,
+          options: options
+        )
+      end
+
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AssistantListResponse]
+      #
+      # @see Revox::Models::AssistantListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "assistants",
+          model: Revox::Models::AssistantListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AssistantDeleteResponse]
+      #
+      # @see Revox::Models::AssistantDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["assistants/%1$s", id],
+          model: Revox::Models::AssistantDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Revox::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/revox/resources/call.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class Call
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::CallCreateParams} for more details.
+      #
+      # Place a new call order. A call order can be resolved over multiple call attempts
+      # spanning up to a few days.
+      #
+      # @overload create(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: {})
+      #
+      # @param phone_number [String] The phone number to call in the E.164 format. Example: +1234567890
+      #
+      # @param assistant [Revox::Models::CallCreateParams::Assistant] You can provide a custom assistant configuration here. If you don't provide an a
+      #
+      # @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 from_phone_number [String] The phone number to use for making the call (e.g., +1234567890). If not provided
+      #
+      # @param metadata [Hash{Symbol=>String}] Metadata to store with the call.
+      #
+      # @param prompt_variables [Hash{Symbol=>String}] Variables to interpolate into the prompt. Wether you use an assistant_id or an a
+      #
+      # @param scheduled_at [Time, Object] Schedule the call to start at a specific date and time (ISO 8601 format). If not
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallCreateResponse]
+      #
+      # @see Revox::Models::CallCreateParams
+      def create(params)
+        parsed, options = Revox::CallCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "call",
+          body: parsed,
+          model: Revox::Models::CallCreateResponse,
+          options: options
+        )
+      end
+
+      # Get a call order by ID.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the call to get.
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallRetrieveResponse]
+      #
+      # @see Revox::Models::CallRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["call/%1$s", id],
+          model: Revox::Models::CallRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Get the list of call orders.
+      #
+      # @overload list(page:, page_size:, request_options: {})
+      #
+      # @param page [Float] The page number you want to get. Starting at 0.
+      #
+      # @param page_size [Float]
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallListResponse]
+      #
+      # @see Revox::Models::CallListParams
+      def list(params)
+        parsed, options = Revox::CallListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "call",
+          query: parsed,
+          model: Revox::Models::CallListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Revox::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/revox/resources/users/me.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class Users
+      class Me
+        # Get the current authenticated user.
+        #
+        # @overload retrieve(request_options: {})
+        #
+        # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Revox::Models::Users::MeRetrieveResponse]
+        #
+        # @see Revox::Models::Users::MeRetrieveParams
+        def retrieve(params = {})
+          @client.request(
+            method: :get,
+            path: "users/me",
+            model: Revox::Models::Users::MeRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Update the current authenticated user.
+        #
+        # @overload update(has_completed_onboarding: nil, request_options: {})
+        #
+        # @param has_completed_onboarding [Boolean]
+        # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Revox::Models::Users::MeUpdateResponse]
+        #
+        # @see Revox::Models::Users::MeUpdateParams
+        def update(params = {})
+          parsed, options = Revox::Users::MeUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: "users/me",
+            body: parsed,
+            model: Revox::Models::Users::MeUpdateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Revox::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/revox/resources/users.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class Users
+      # @return [Revox::Resources::Users::Me]
+      attr_reader :me
+
+      # @api private
+      #
+      # @param client [Revox::Client]
+      def initialize(client:)
+        @client = client
+        @me = Revox::Resources::Users::Me.new(client: client)
+      end
+    end
+  end
+end

data/lib/revox/resources/voices.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class Voices
+      # Get a single voice by ID.
+      #
+      # @overload retrieve(id, provider:, request_options: {})
+      #
+      # @param id [String] The voice ID to get.
+      #
+      # @param provider [Symbol, Revox::Models::VoiceRetrieveParams::Provider]
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::VoiceRetrieveResponse]
+      #
+      # @see Revox::Models::VoiceRetrieveParams
+      def retrieve(id, params)
+        parsed, options = Revox::VoiceRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["voices/%1$s", id],
+          query: parsed,
+          model: Revox::Models::VoiceRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Get the list of voices available for the call. Supports Cartesia, ElevenLabs,
+      # Inworld voices.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::VoiceListResponse]
+      #
+      # @see Revox::Models::VoiceListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "voices",
+          model: Revox::Models::VoiceListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Generate a voice preview audio sample for a given voice ID.
+      #
+      # @overload preview(provider:, voice_id:, text: nil, request_options: {})
+      #
+      # @param provider [Symbol, Revox::Models::VoicePreviewParams::Provider] The provider to use for the preview.
+      #
+      # @param voice_id [String] The voice ID to generate a preview for.
+      #
+      # @param text [String] The text to generate a preview for.
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Revox::Models::VoicePreviewParams
+      def preview(params)
+        parsed, options = Revox::VoicePreviewParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "voices/preview",
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Revox::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/revox/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Revox
+  VERSION = "0.0.2"
+end

data/lib/revox.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "revox/version"
+require_relative "revox/internal/util"
+require_relative "revox/internal/type/converter"
+require_relative "revox/internal/type/unknown"
+require_relative "revox/internal/type/boolean"
+require_relative "revox/internal/type/file_input"
+require_relative "revox/internal/type/enum"
+require_relative "revox/internal/type/union"
+require_relative "revox/internal/type/array_of"
+require_relative "revox/internal/type/hash_of"
+require_relative "revox/internal/type/base_model"
+require_relative "revox/internal/type/base_page"
+require_relative "revox/internal/type/request_parameters"
+require_relative "revox/internal"
+require_relative "revox/request_options"
+require_relative "revox/file_part"
+require_relative "revox/errors"
+require_relative "revox/internal/transport/base_client"
+require_relative "revox/internal/transport/pooled_net_requester"
+require_relative "revox/client"
+require_relative "revox/models/assistant_create_params"
+require_relative "revox/models/assistant_create_response"
+require_relative "revox/models/assistant_delete_params"
+require_relative "revox/models/assistant_delete_response"
+require_relative "revox/models/assistant_list_params"
+require_relative "revox/models/assistant_list_response"
+require_relative "revox/models/assistant_retrieve_params"
+require_relative "revox/models/assistant_retrieve_response"
+require_relative "revox/models/assistant_update_params"
+require_relative "revox/models/assistant_update_response"
+require_relative "revox/models/call_create_params"
+require_relative "revox/models/call_create_response"
+require_relative "revox/models/call_list_params"
+require_relative "revox/models/call_list_response"
+require_relative "revox/models/call_retrieve_params"
+require_relative "revox/models/call_retrieve_response"
+require_relative "revox/models/users/me_retrieve_params"
+require_relative "revox/models/users/me_retrieve_response"
+require_relative "revox/models/users/me_update_params"
+require_relative "revox/models/users/me_update_response"
+require_relative "revox/models/voice_list_params"
+require_relative "revox/models/voice_list_response"
+require_relative "revox/models/voice_preview_params"
+require_relative "revox/models/voice_retrieve_params"
+require_relative "revox/models/voice_retrieve_response"
+require_relative "revox/models"
+require_relative "revox/resources/assistants"
+require_relative "revox/resources/call"
+require_relative "revox/resources/users"
+require_relative "revox/resources/users/me"
+require_relative "revox/resources/voices"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/revox/client.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Revox
+  class Client < Revox::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(Revox::Resources::Assistants) }
+    attr_reader :assistants
+
+    sig { returns(Revox::Resources::Call) }
+    attr_reader :call
+
+    sig { returns(Revox::Resources::Voices) }
+    attr_reader :voices
+
+    sig { returns(Revox::Resources::Users) }
+    attr_reader :users
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["REVOX_API_KEY"]`
+      api_key: ENV["REVOX_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["REVOX_BASE_URL"]`
+      base_url: ENV["REVOX_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Revox::Client::DEFAULT_MAX_RETRIES,
+      timeout: Revox::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Revox::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Revox::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end