revox 0.0.2 → 0.2.0

data/lib/revox/resources/campaigns.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class Campaigns
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::CampaignCreateParams} for more details.
+      #
+      # Create a new outbound calling campaign. By default the campaign launches
+      # immediately. Set launch to false to save as a draft for later review.
+      #
+      # @overload create(assistant_id:, contacts:, launch:, name:, type:, call_retry_config: nil, from_phone_number: nil, max_concurrent_calls: nil, scheduled_at: nil, request_options: {})
+      #
+      # @param assistant_id [String] The ID of the assistant to use
+      #
+      # @param contacts [Array<Revox::Models::CampaignCreateParams::Contact>] The list of contacts to call
+      #
+      # @param launch [Boolean] Whether to launch the campaign immediately. Set to false to save as a draft.
+      #
+      # @param name [String] The name of the campaign
+      #
+      # @param type [Symbol, Revox::Models::CampaignCreateParams::Type] Campaign type. 'jump_in' campaigns only dial while someone is on the campaign pa
+      #
+      # @param call_retry_config [Revox::Models::CampaignCreateParams::CallRetryConfig] Override retry configuration for calls in this campaign. If not provided, uses t
+      #
+      # @param from_phone_number [String] The phone number to use for outbound calls (E.164 format, e.g., +1234567890)
+      #
+      # @param max_concurrent_calls [Float] Maximum number of concurrent calls allowed for this campaign
+      #
+      # @param scheduled_at [Time, Object] Schedule all calls in this campaign to start at a specific date and time (ISO 86
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignCreateResponse]
+      #
+      # @see Revox::Models::CampaignCreateParams
+      def create(params)
+        parsed, options = Revox::CampaignCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "campaigns",
+          body: parsed,
+          model: Revox::Models::CampaignCreateResponse,
+          options: options
+        )
+      end
+
+      # Retrieve the full details of a single campaign by its unique ID. Can be used to
+      # poll for campaign completion.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignRetrieveResponse]
+      #
+      # @see Revox::Models::CampaignRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["campaigns/%1$s", id],
+          model: Revox::Models::CampaignRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve all campaigns for your organization, including both active and
+      # completed ones.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignListResponse]
+      #
+      # @see Revox::Models::CampaignListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "campaigns",
+          model: Revox::Models::CampaignListResponse,
+          options: params[: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.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignDeleteResponse]
+      #
+      # @see Revox::Models::CampaignDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["campaigns/%1$s", id],
+          model: Revox::Models::CampaignDeleteResponse,
+          options: params[: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.
+      #
+      # @overload cancel(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignCancelResponse]
+      #
+      # @see Revox::Models::CampaignCancelParams
+      def cancel(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["campaigns/%1$s/cancel", id],
+          model: Revox::Models::CampaignCancelResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Export all rows of a campaign as a CSV file for offline analysis or reporting.
+      #
+      # @overload export_rows(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignExportRowsResponse]
+      #
+      # @see Revox::Models::CampaignExportRowsParams
+      def export_rows(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["campaigns/%1$s/export", id],
+          model: Revox::Models::CampaignExportRowsResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve all contact rows for a campaign. Useful for loading draft campaign data
+      # for editing.
+      #
+      # @overload get_rows(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignGetRowsResponse]
+      #
+      # @see Revox::Models::CampaignGetRowsParams
+      def get_rows(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["campaigns/%1$s/rows", id],
+          model: Revox::Models::CampaignGetRowsResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Revox::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/revox/resources/voices.rb

@@ -3,7 +3,7 @@
 module Revox
   module Resources
     class Voices
-      # Get a single voice by ID.
+      # Retrieve details for a single voice by its unique ID and provider.
       #
       # @overload retrieve(id, provider:, request_options: {})
       #
@@ -18,17 +18,18 @@ module Revox
       # @see Revox::Models::VoiceRetrieveParams
       def retrieve(id, params)
         parsed, options = Revox::VoiceRetrieveParams.dump_request(params)
+        query = Revox::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["voices/%1$s", id],
-          query: parsed,
+          query: query,
           model: Revox::Models::VoiceRetrieveResponse,
           options: options
         )
       end
 
-      # Get the list of voices available for the call. Supports Cartesia, ElevenLabs,
-      # Inworld voices.
+      # Retrieve all voices available for AI calls, including preset voices from
+      # Cartesia/ElevenLabs and your organization's cloned voices.
       #
       # @overload list(request_options: {})
       #
@@ -46,15 +47,24 @@ module Revox
         )
       end
 
-      # Generate a voice preview audio sample for a given voice ID.
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::VoicePreviewParams} for more details.
       #
-      # @overload preview(provider:, voice_id:, text: nil, request_options: {})
+      # Generate a short audio preview for a given voice.
+      #
+      # @overload preview(provider:, voice_id:, model: nil, speed: nil, text: nil, volume: 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 model [Symbol, Revox::Models::VoicePreviewParams::Model] Cartesia model for the preview. Defaults to sonic-3. Ignored for other providers
+      #
+      # @param speed [Float] Speed for preview. Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default 1.0.
+      #
+      # @param text [String] Custom text for the preview. If omitted, a short default is used.
+      #
+      # @param volume [Float] Volume for Cartesia preview (0.5–2.0). Ignored for other providers.
       #
       # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/revox/version.rb

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

data/lib/revox.rb

@@ -64,10 +64,22 @@ 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/campaign_cancel_params"
+require_relative "revox/models/campaign_cancel_response"
+require_relative "revox/models/campaign_create_params"
+require_relative "revox/models/campaign_create_response"
+require_relative "revox/models/campaign_delete_params"
+require_relative "revox/models/campaign_delete_response"
+require_relative "revox/models/campaign_export_rows_params"
+require_relative "revox/models/campaign_export_rows_response"
+require_relative "revox/models/campaign_get_rows_params"
+require_relative "revox/models/campaign_get_rows_response"
+require_relative "revox/models/campaign_list_params"
+require_relative "revox/models/campaign_list_response"
+require_relative "revox/models/campaign_retrieve_params"
+require_relative "revox/models/campaign_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"
@@ -80,6 +92,7 @@ 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/campaigns"
 require_relative "revox/resources/users"
 require_relative "revox/resources/users/me"
 require_relative "revox/resources/voices"

data/rbi/revox/client.rbi

@@ -13,6 +13,9 @@ module Revox
     sig { returns(String) }
     attr_reader :api_key
 
+    sig { returns(Revox::Resources::Campaigns) }
+    attr_reader :campaigns
+
     sig { returns(Revox::Resources::Assistants) }
     attr_reader :assistants
 

data/rbi/revox/internal/util.rbi

@@ -144,12 +144,20 @@ module Revox
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)
@@ -295,6 +303,26 @@ module Revox
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Revox::Internal::AnyHash).returns(
+            Revox::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Revox::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(