revox 0.0.2 → 0.1.0

data/rbi/revox/models/voice_preview_params.rbi

@@ -19,18 +19,10 @@ module Revox
       sig { returns(String) }
       attr_accessor :voice_id
 
-      # The text to generate a preview for.
-      sig { returns(T.nilable(String)) }
-      attr_reader :text
-
-      sig { params(text: String).void }
-      attr_writer :text
-
       sig do
         params(
           provider: Revox::VoicePreviewParams::Provider::OrSymbol,
           voice_id: String,
-          text: String,
           request_options: Revox::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -39,8 +31,6 @@ module Revox
         provider:,
         # The voice ID to generate a preview for.
         voice_id:,
-        # The text to generate a preview for.
-        text: nil,
         request_options: {}
       )
       end
@@ -50,7 +40,6 @@ module Revox
           {
             provider: Revox::VoicePreviewParams::Provider::OrSymbol,
             voice_id: String,
-            text: String,
             request_options: Revox::RequestOptions
           }
         )

data/rbi/revox/models/voice_retrieve_params.rbi

@@ -11,21 +11,26 @@ module Revox
           T.any(Revox::VoiceRetrieveParams, Revox::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig { returns(Revox::VoiceRetrieveParams::Provider::OrSymbol) }
       attr_accessor :provider
 
       sig do
         params(
+          id: String,
           provider: Revox::VoiceRetrieveParams::Provider::OrSymbol,
           request_options: Revox::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(provider:, request_options: {})
+      def self.new(id:, provider:, request_options: {})
       end
 
       sig do
         override.returns(
           {
+            id: String,
             provider: Revox::VoiceRetrieveParams::Provider::OrSymbol,
             request_options: Revox::RequestOptions
           }

data/rbi/revox/models.rbi

@@ -17,6 +17,20 @@ module Revox
 
   CallRetrieveParams = Revox::Models::CallRetrieveParams
 
+  CampaignCancelParams = Revox::Models::CampaignCancelParams
+
+  CampaignCreateParams = Revox::Models::CampaignCreateParams
+
+  CampaignDeleteParams = Revox::Models::CampaignDeleteParams
+
+  CampaignExportRowsParams = Revox::Models::CampaignExportRowsParams
+
+  CampaignGetRowsParams = Revox::Models::CampaignGetRowsParams
+
+  CampaignListParams = Revox::Models::CampaignListParams
+
+  CampaignRetrieveParams = Revox::Models::CampaignRetrieveParams
+
   Users = Revox::Models::Users
 
   VoiceListParams = Revox::Models::VoiceListParams

data/rbi/revox/resources/assistants.rbi

@@ -3,13 +3,18 @@
 module Revox
   module Resources
     class Assistants
+      # Create a new AI assistant with a custom prompt, voice, and behavior
+      # configuration. Assistants define how the AI agent behaves during calls,
+      # including the system prompt given to the LLM, the first sentence spoken, the
+      # voice provider and voice ID (Cartesia or ElevenLabs), and end-of-call behavior.
+      # Once created, reference the assistant by its ID when placing calls.
       sig do
         params(
           name: String,
           prompt: String,
           background_sound:
             T.nilable(Revox::AssistantCreateParams::BackgroundSound::OrSymbol),
-          calendly: T.nilable(Revox::AssistantCreateParams::Calendly::OrHash),
+          calendly: Revox::AssistantCreateParams::Calendly::OrHash,
           call_retry_config:
             Revox::AssistantCreateParams::CallRetryConfig::OrHash,
           end_of_call_sentence: String,
@@ -86,6 +91,10 @@ module Revox
       )
       end
 
+      # Retrieve a single assistant by its unique ID. Returns the full assistant
+      # configuration including prompt, voice settings, and first sentence mode. Useful
+      # for inspecting an assistant's current setup before updating it or placing a
+      # call.
       sig do
         params(
           id: String,
@@ -95,12 +104,16 @@ module Revox
       def retrieve(id, request_options: {})
       end
 
+      # Update one or more fields on an existing assistant. Supports partial updates —
+      # only the fields you include in the request body will be changed. You can update
+      # the prompt, voice, first sentence, name, or any other assistant property without
+      # affecting the rest of the configuration.
       sig do
         params(
           id: String,
           background_sound:
             T.nilable(Revox::AssistantUpdateParams::BackgroundSound::OrSymbol),
-          calendly: T.nilable(Revox::AssistantUpdateParams::Calendly::OrHash),
+          calendly: Revox::AssistantUpdateParams::Calendly::OrHash,
           call_retry_config:
             Revox::AssistantUpdateParams::CallRetryConfig::OrHash,
           end_of_call_sentence: String,
@@ -180,6 +193,9 @@ module Revox
       )
       end
 
+      # Retrieve all assistants associated with your account. Each assistant in the
+      # response includes its full configuration: prompt, voice settings, and first
+      # sentence. Use this endpoint to list available assistants before placing calls.
       sig do
         params(request_options: Revox::RequestOptions::OrHash).returns(
           Revox::Models::AssistantListResponse
@@ -188,6 +204,9 @@ module Revox
       def list(request_options: {})
       end
 
+      # Permanently delete an assistant by its ID. Any future calls referencing this
+      # assistant ID will fail. Existing call records that used this assistant are not
+      # affected.
       sig do
         params(
           id: String,

data/rbi/revox/resources/call.rbi

@@ -3,8 +3,12 @@
 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.
+      # Place a new outbound call order. Provide either an existing assistant ID or a
+      # custom assistant configuration. The call can be scheduled for a specific time or
+      # started immediately. A single call order may be resolved over multiple call
+      # attempts spanning up to a few days, with automatic retries when voicemail is
+      # detected. You can also set concurrency limits and pass prompt variables for
+      # dynamic personalization.
       sig do
         params(
           phone_number: String,
@@ -47,7 +51,10 @@ module Revox
       )
       end
 
-      # Get a call order by ID.
+      # Retrieve the full details of a call order by its unique ID. The response
+      # includes the call status, call attempts, transcript, recording URL, timestamps,
+      # and metadata. Use this endpoint to poll for call completion or inspect results
+      # after a call has finished.
       sig do
         params(
           id: String,
@@ -61,18 +68,23 @@ module Revox
       )
       end
 
-      # Get the list of call orders.
+      # Retrieve a paginated list of call attempts. Each entry includes the call status,
+      # phone number, assistant used, transcript, and timestamps. Use the page and
+      # page_size query parameters to navigate through results.
       sig do
         params(
-          page: Float,
-          page_size: Float,
+          page: Integer,
+          page_size: Integer,
+          statuses: T::Array[Revox::CallListParams::Status::OrSymbol],
           request_options: Revox::RequestOptions::OrHash
         ).returns(Revox::Models::CallListResponse)
       end
       def list(
         # The page number you want to get. Starting at 0.
         page:,
+        # The number of calls to return per page.
         page_size:,
+        statuses: nil,
         request_options: {}
       )
       end

data/rbi/revox/resources/campaigns.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Revox
+  module Resources
+    class Campaigns
+      # Create a new outbound calling campaign and launch it immediately. If
+      # scheduled_at is set, all calls will be queued until the specified time instead
+      # of starting right away.
+      sig do
+        params(
+          assistant_id: String,
+          contacts: T::Array[Revox::CampaignCreateParams::Contact::OrHash],
+          name: String,
+          call_retry_config:
+            Revox::CampaignCreateParams::CallRetryConfig::OrHash,
+          from_phone_number: String,
+          max_concurrent_calls: Float,
+          scheduled_at: Revox::CampaignCreateParams::ScheduledAt::Variants,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CampaignCreateResponse)
+      end
+      def create(
+        # The ID of the assistant to use
+        assistant_id:,
+        # The list of contacts to call
+        contacts:,
+        # The name of the campaign
+        name:,
+        # Override retry configuration for calls in this campaign. If not provided, uses
+        # the assistant's retry config.
+        call_retry_config: nil,
+        # The phone number to use for outbound calls (E.164 format, e.g., +1234567890)
+        from_phone_number: nil,
+        # Maximum number of concurrent calls allowed for this campaign
+        max_concurrent_calls: nil,
+        # Schedule all calls in this campaign to start at a specific date and time (ISO
+        # 8601 format)
+        scheduled_at: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve the full details of a single campaign by its unique ID. Can be used to
+      # poll for campaign completion.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CampaignRetrieveResponse)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Retrieve all campaigns for your organization, including both active and
+      # completed ones.
+      sig do
+        params(request_options: Revox::RequestOptions::OrHash).returns(
+          Revox::Models::CampaignListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Permanently delete a campaign and all its associated rows. This action is
+      # irreversible. In-progress calls will not be affected, but no new calls will be
+      # placed.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CampaignDeleteResponse)
+      end
+      def delete(id, request_options: {})
+      end
+
+      # Cancel a running or scheduled campaign. Pending and queued calls will be
+      # aborted, while in-progress calls will be allowed to finish. Unlike deletion, the
+      # campaign and its rows are preserved for historical reference.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CampaignCancelResponse)
+      end
+      def cancel(id, request_options: {})
+      end
+
+      # Export all rows of a campaign as a CSV file for offline analysis or reporting.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CampaignExportRowsResponse)
+      end
+      def export_rows(id, request_options: {})
+      end
+
+      # Retrieve a paginated list of rows (contacts) for a given campaign. Supports
+      # filtering by text query, call statuses, and call result.
+      sig do
+        params(
+          id: String,
+          page: Float,
+          page_size: Float,
+          query: String,
+          result: Revox::CampaignGetRowsParams::Result::OrSymbol,
+          statuses: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CampaignGetRowsResponse)
+      end
+      def get_rows(
+        id,
+        page:,
+        page_size:,
+        query: nil,
+        result: nil,
+        statuses: 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/resources/voices.rbi

@@ -3,7 +3,8 @@
 module Revox
   module Resources
     class Voices
-      # Get a single voice by ID.
+      # Retrieve details for a single voice by its unique ID and provider. Returns the
+      # voice name, description, and provider metadata.
       sig do
         params(
           id: String,
@@ -19,8 +20,10 @@ module Revox
       )
       end
 
-      # Get the list of voices available for the call. Supports Cartesia, ElevenLabs,
-      # Inworld voices.
+      # Retrieve the full catalog of voices available for AI calls. The list includes
+      # voices from Cartesia and ElevenLabs, each with a name, language, accent, and
+      # provider-specific ID. Use this endpoint to browse voices before assigning one to
+      # an assistant or a call.
       sig do
         params(request_options: Revox::RequestOptions::OrHash).returns(
           Revox::Models::VoiceListResponse
@@ -29,12 +32,13 @@ module Revox
       def list(request_options: {})
       end
 
-      # Generate a voice preview audio sample for a given voice ID.
+      # Generate a short audio preview for a given voice. Provide the voice ID and
+      # provider, and the API returns an audio/mpeg stream you can play back to hear how
+      # the voice sounds before assigning it to an assistant.
       sig do
         params(
           provider: Revox::VoicePreviewParams::Provider::OrSymbol,
           voice_id: String,
-          text: String,
           request_options: Revox::RequestOptions::OrHash
         ).void
       end
@@ -43,8 +47,6 @@ module Revox
         provider:,
         # The voice ID to generate a preview for.
         voice_id:,
-        # The text to generate a preview for.
-        text: nil,
         request_options: {}
       )
       end

data/sig/revox/client.rbs

@@ -10,6 +10,8 @@ module Revox
 
     attr_reader api_key: String
 
+    attr_reader campaigns: Revox::Resources::Campaigns
+
     attr_reader assistants: Revox::Resources::Assistants
 
     attr_reader call: Revox::Resources::Call

data/sig/revox/internal/util.rbs

@@ -106,6 +106,16 @@ module Revox
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/revox/models/assistant_create_params.rbs

@@ -5,7 +5,7 @@ module Revox
         name: String,
         prompt: String,
         background_sound: Revox::Models::AssistantCreateParams::background_sound?,
-        calendly: Revox::AssistantCreateParams::Calendly?,
+        calendly: Revox::AssistantCreateParams::Calendly,
         call_retry_config: Revox::AssistantCreateParams::CallRetryConfig,
         end_of_call_sentence: String,
         faq_items: ::Array[Revox::AssistantCreateParams::FaqItem],
@@ -33,7 +33,11 @@ module Revox
 
       attr_accessor background_sound: Revox::Models::AssistantCreateParams::background_sound?
 
-      attr_accessor calendly: Revox::AssistantCreateParams::Calendly?
+      attr_reader calendly: Revox::AssistantCreateParams::Calendly?
+
+      def calendly=: (
+        Revox::AssistantCreateParams::Calendly
+      ) -> Revox::AssistantCreateParams::Calendly
 
       attr_reader call_retry_config: Revox::AssistantCreateParams::CallRetryConfig?
 
@@ -103,7 +107,7 @@ module Revox
         name: String,
         prompt: String,
         ?background_sound: Revox::Models::AssistantCreateParams::background_sound?,
-        ?calendly: Revox::AssistantCreateParams::Calendly?,
+        ?calendly: Revox::AssistantCreateParams::Calendly,
         ?call_retry_config: Revox::AssistantCreateParams::CallRetryConfig,
         ?end_of_call_sentence: String,
         ?faq_items: ::Array[Revox::AssistantCreateParams::FaqItem],
@@ -125,7 +129,7 @@ module Revox
         name: String,
         prompt: String,
         background_sound: Revox::Models::AssistantCreateParams::background_sound?,
-        calendly: Revox::AssistantCreateParams::Calendly?,
+        calendly: Revox::AssistantCreateParams::Calendly,
         call_retry_config: Revox::AssistantCreateParams::CallRetryConfig,
         end_of_call_sentence: String,
         faq_items: ::Array[Revox::AssistantCreateParams::FaqItem],

data/sig/revox/models/assistant_delete_params.rbs

@@ -1,15 +1,20 @@
 module Revox
   module Models
     type assistant_delete_params =
-      {  } & Revox::Internal::Type::request_parameters
+      { id: String } & Revox::Internal::Type::request_parameters
 
     class AssistantDeleteParams < Revox::Internal::Type::BaseModel
       extend Revox::Internal::Type::RequestParameters::Converter
       include Revox::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Revox::request_opts) -> void
+      attr_accessor id: String
 
-      def to_hash: -> { request_options: Revox::RequestOptions }
+      def initialize: (
+        id: String,
+        ?request_options: Revox::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Revox::RequestOptions }
     end
   end
 end

data/sig/revox/models/assistant_retrieve_params.rbs

@@ -1,15 +1,20 @@
 module Revox
   module Models
     type assistant_retrieve_params =
-      {  } & Revox::Internal::Type::request_parameters
+      { id: String } & Revox::Internal::Type::request_parameters
 
     class AssistantRetrieveParams < Revox::Internal::Type::BaseModel
       extend Revox::Internal::Type::RequestParameters::Converter
       include Revox::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Revox::request_opts) -> void
+      attr_accessor id: String
 
-      def to_hash: -> { request_options: Revox::RequestOptions }
+      def initialize: (
+        id: String,
+        ?request_options: Revox::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Revox::RequestOptions }
     end
   end
 end

data/sig/revox/models/assistant_update_params.rbs

@@ -2,8 +2,9 @@ module Revox
   module Models
     type assistant_update_params =
       {
+        id: String,
         background_sound: Revox::Models::AssistantUpdateParams::background_sound?,
-        calendly: Revox::AssistantUpdateParams::Calendly?,
+        calendly: Revox::AssistantUpdateParams::Calendly,
         call_retry_config: Revox::AssistantUpdateParams::CallRetryConfig,
         end_of_call_sentence: String,
         faq_items: ::Array[Revox::AssistantUpdateParams::FaqItem],
@@ -27,9 +28,15 @@ module Revox
       extend Revox::Internal::Type::RequestParameters::Converter
       include Revox::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor background_sound: Revox::Models::AssistantUpdateParams::background_sound?
 
-      attr_accessor calendly: Revox::AssistantUpdateParams::Calendly?
+      attr_reader calendly: Revox::AssistantUpdateParams::Calendly?
+
+      def calendly=: (
+        Revox::AssistantUpdateParams::Calendly
+      ) -> Revox::AssistantUpdateParams::Calendly
 
       attr_reader call_retry_config: Revox::AssistantUpdateParams::CallRetryConfig?
 
@@ -104,8 +111,9 @@ module Revox
       def webhook_url=: (String) -> String
 
       def initialize: (
+        id: String,
         ?background_sound: Revox::Models::AssistantUpdateParams::background_sound?,
-        ?calendly: Revox::AssistantUpdateParams::Calendly?,
+        ?calendly: Revox::AssistantUpdateParams::Calendly,
         ?call_retry_config: Revox::AssistantUpdateParams::CallRetryConfig,
         ?end_of_call_sentence: String,
         ?faq_items: ::Array[Revox::AssistantUpdateParams::FaqItem],
@@ -126,8 +134,9 @@ module Revox
       ) -> void
 
       def to_hash: -> {
+        id: String,
         background_sound: Revox::Models::AssistantUpdateParams::background_sound?,
-        calendly: Revox::AssistantUpdateParams::Calendly?,
+        calendly: Revox::AssistantUpdateParams::Calendly,
         call_retry_config: Revox::AssistantUpdateParams::CallRetryConfig,
         end_of_call_sentence: String,
         faq_items: ::Array[Revox::AssistantUpdateParams::FaqItem],

data/sig/revox/models/call_create_params.rbs

@@ -88,7 +88,7 @@ module Revox
         {
           prompt: String,
           background_sound: Revox::Models::CallCreateParams::Assistant::background_sound?,
-          calendly: Revox::CallCreateParams::Assistant::Calendly?,
+          calendly: Revox::CallCreateParams::Assistant::Calendly,
           call_retry_config: Revox::CallCreateParams::Assistant::CallRetryConfig,
           end_of_call_sentence: String,
           faq_items: ::Array[Revox::CallCreateParams::Assistant::FaqItem],
@@ -110,7 +110,11 @@ module Revox
 
         attr_accessor background_sound: Revox::Models::CallCreateParams::Assistant::background_sound?
 
-        attr_accessor calendly: Revox::CallCreateParams::Assistant::Calendly?
+        attr_reader calendly: Revox::CallCreateParams::Assistant::Calendly?
+
+        def calendly=: (
+          Revox::CallCreateParams::Assistant::Calendly
+        ) -> Revox::CallCreateParams::Assistant::Calendly
 
         attr_reader call_retry_config: Revox::CallCreateParams::Assistant::CallRetryConfig?
 
@@ -179,7 +183,7 @@ module Revox
         def initialize: (
           prompt: String,
           ?background_sound: Revox::Models::CallCreateParams::Assistant::background_sound?,
-          ?calendly: Revox::CallCreateParams::Assistant::Calendly?,
+          ?calendly: Revox::CallCreateParams::Assistant::Calendly,
           ?call_retry_config: Revox::CallCreateParams::Assistant::CallRetryConfig,
           ?end_of_call_sentence: String,
           ?faq_items: ::Array[Revox::CallCreateParams::Assistant::FaqItem],
@@ -199,7 +203,7 @@ module Revox
         def to_hash: -> {
           prompt: String,
           background_sound: Revox::Models::CallCreateParams::Assistant::background_sound?,
-          calendly: Revox::CallCreateParams::Assistant::Calendly?,
+          calendly: Revox::CallCreateParams::Assistant::Calendly,
           call_retry_config: Revox::CallCreateParams::Assistant::CallRetryConfig,
           end_of_call_sentence: String,
           faq_items: ::Array[Revox::CallCreateParams::Assistant::FaqItem],