revox 0.2.0 → 0.4.0

data/lib/revox/resources/call.rb

@@ -13,7 +13,7 @@ module Revox
       # detected. You can also set concurrency limits and pass prompt variables for
       # dynamic personalization.
       #
-      # @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: {})
+      # @overload create(phone_number:, assistant: nil, assistant_id: nil, concurrency: nil, from_phone_number: nil, metadata: nil, prompt_variables: nil, scheduled_at: nil, skip_calling_window: nil, request_options: {})
       #
       # @param phone_number [String] The phone number to call in the E.164 format. Example: +1234567890
       #
@@ -21,9 +21,7 @@ module Revox
       #
       # @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 concurrency [Revox::Models::CallCreateParams::Concurrency] Limit the number of concurrent calls for a given concurrency key. The limit itse
       #
       # @param from_phone_number [String] The phone number to use for making the call (e.g., +1234567890). If not provided
       #
@@ -33,6 +31,8 @@ module Revox
       #
       # @param scheduled_at [Time, Object] Schedule the call to start at a specific date and time (ISO 8601 format). If not
       #
+      # @param skip_calling_window [Boolean] Bypass the calling-window check for this call so it dials even outside the assis
+      #
       # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Revox::Models::CallCreateResponse]
@@ -72,6 +72,151 @@ module Revox
         )
       end
 
+      # Cancel a running or scheduled call.
+      #
+      # @overload cancel(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallCancelResponse]
+      #
+      # @see Revox::Models::CallCancelParams
+      def cancel(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["call/%1$s/cancel", id],
+          model: Revox::Models::CallCancelResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::CallExportParams} for more details.
+      #
+      # Export a list of call attempts as a CSV file.
+      #
+      # @overload export(filters:, include_metadata: nil, include_structured_output_fields: nil, request_options: {})
+      #
+      # @param filters [Revox::Models::CallExportParams::Filters]
+      #
+      # @param include_metadata [Boolean] Whether to include the metadata in the CSV file. These are the fields you (optio
+      #
+      # @param include_structured_output_fields [Boolean] Whether to include the structured output fields in the CSV file. These are gener
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallExportResponse]
+      #
+      # @see Revox::Models::CallExportParams
+      def export(params)
+        parsed, options = Revox::CallExportParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "call/export",
+          body: parsed,
+          model: Revox::Models::CallExportResponse,
+          options: options
+        )
+      end
+
+      # Pause a call's retry loop. The current in-progress attempt (if any) will finish,
+      # but no new attempts will be started until the call is resumed.
+      #
+      # @overload pause(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallPauseResponse]
+      #
+      # @see Revox::Models::CallPauseParams
+      def pause(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["call/%1$s/pause", id],
+          model: Revox::Models::CallPauseResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Returns a map of phone numbers to the number of calls and associated campaigns
+      # across the entire organization. Useful for detecting contacts that have already
+      # been reached.
+      #
+      # @overload phone_history(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallPhoneHistoryResponse]
+      #
+      # @see Revox::Models::CallPhoneHistoryParams
+      def phone_history(params = {})
+        @client.request(
+          method: :get,
+          path: "calls/phone-history",
+          model: Revox::Models::CallPhoneHistoryResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Resume a previously paused call. The retry loop will continue from where it left
+      # off.
+      #
+      # @overload resume(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallResumeResponse]
+      #
+      # @see Revox::Models::CallResumeParams
+      def resume(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["call/%1$s/resume", id],
+          model: Revox::Models::CallResumeResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # 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.
+      #
+      # @overload search(assignee_ids:, assistant_ids:, campaign_ids:, directions:, from_phone_numbers:, outcomes:, page:, page_size:, results:, statuses:, call_ids: nil, query: nil, sort_by: nil, sort_direction: nil, to_phone_number: nil, request_options: {})
+      #
+      # @param assignee_ids [Array<String>]
+      # @param assistant_ids [Array<String>]
+      # @param campaign_ids [Array<String>]
+      # @param directions [Array<Symbol, Revox::Models::CallSearchParams::Direction>]
+      # @param from_phone_numbers [Array<String>]
+      # @param outcomes [Array<Symbol, Revox::Models::CallSearchParams::Outcome>]
+      # @param page [Integer]
+      # @param page_size [Integer]
+      # @param results [Array<Symbol, Revox::Models::CallSearchParams::Result>]
+      # @param statuses [Array<Symbol, Revox::Models::CallSearchParams::Status>]
+      # @param call_ids [Array<String>]
+      # @param query [String]
+      # @param sort_by [String]
+      # @param sort_direction [Symbol, Revox::Models::CallSearchParams::SortDirection]
+      # @param to_phone_number [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CallSearchResponse]
+      #
+      # @see Revox::Models::CallSearchParams
+      def search(params)
+        parsed, options = Revox::CallSearchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "call/search",
+          body: parsed,
+          model: Revox::Models::CallSearchResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Revox::Client]

data/lib/revox/resources/campaigns.rb

@@ -6,29 +6,24 @@ module Revox
       # 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.
+      # Create a new outbound calling campaign. Every contact is materialized as a call
+      # in the `not_launched` status — nothing is dialed. Use POST
+      # /campaigns/:id/launch-calls to send them.
       #
-      # @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: {})
+      # @overload create(assistant_id:, contacts:, name:, call_retry_config: nil, from_phone_number: nil, max_concurrent_calls: 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]
@@ -65,6 +60,43 @@ module Revox
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::CampaignUpdateParams} for more details.
+      #
+      # Update a campaign's name, outbound number, retry configuration (calling hours,
+      # retry delay, max attempts) and concurrency cap. Changes are applied to the
+      # campaign's calls that have not completed yet. The assistant is fixed at
+      # creation; add contacts with POST /campaigns/:id/rows, and choose when calls go
+      # out with POST /campaigns/:id/launch-calls.
+      #
+      # @overload update(id, call_retry_config: nil, from_phone_number: nil, max_concurrent_calls: nil, name: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param call_retry_config [Revox::Models::CampaignUpdateParams::CallRetryConfig, nil] Configuration for call retry behavior including time windows, delays, and max it
+      #
+      # @param from_phone_number [String, nil] The phone number to use for outbound calls. Editable after launch; applied to th
+      #
+      # @param max_concurrent_calls [Float, nil] Maximum concurrent calls. Editable after launch.
+      #
+      # @param name [String] Campaign display name
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignUpdateResponse]
+      #
+      # @see Revox::Models::CampaignUpdateParams
+      def update(id, params = {})
+        parsed, options = Revox::CampaignUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["campaigns/%1$s", id],
+          body: parsed,
+          model: Revox::Models::CampaignUpdateResponse,
+          options: options
+        )
+      end
+
       # Retrieve all campaigns for your organization, including both active and
       # completed ones.
       #
@@ -145,8 +177,7 @@ module Revox
         )
       end
 
-      # Retrieve all contact rows for a campaign. Useful for loading draft campaign data
-      # for editing.
+      # Retrieve all contact rows for a campaign.
       #
       # @overload get_rows(id, request_options: {})
       #
@@ -165,6 +196,74 @@ module Revox
         )
       end
 
+      # Pause a running campaign so no further calls are placed. In-progress calls are
+      # allowed to finish; pending and scheduled calls are held until the campaign is
+      # resumed. Scheduled retry timers keep counting down, so a call resumed before its
+      # time fires on schedule, while one resumed after its time fires at the next
+      # available calling window.
+      #
+      # @overload pause(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignPauseResponse]
+      #
+      # @see Revox::Models::CampaignPauseParams
+      def pause(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["campaigns/%1$s/pause", id],
+          model: Revox::Models::CampaignPauseResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Resume a paused campaign. Held calls continue from where they left off; calls
+      # whose scheduled time passed during the pause are placed at the next available
+      # calling window.
+      #
+      # @overload resume(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignResumeResponse]
+      #
+      # @see Revox::Models::CampaignResumeParams
+      def resume(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["campaigns/%1$s/resume", id],
+          model: Revox::Models::CampaignResumeResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve the "Statistiques" report for a campaign: the four-tile cascade funnel
+      # (appelés → eus en ligne → réels échanges → leads chauds), two secondary tiles,
+      # the distribution of exchanges by outcome, the list of hot leads, and
+      # data-extraction coverage. All counts are over distinct E.164-normalized phone
+      # numbers, and the outcome-based categories derive exclusively from calls.outcome.
+      # Cascade percentages are null when their denominator is zero.
+      #
+      # @overload statistics(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignStatisticsResponse]
+      #
+      # @see Revox::Models::CampaignStatisticsParams
+      def statistics(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["campaigns/%1$s/statistics", id],
+          model: Revox::Models::CampaignStatisticsResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Revox::Client]

data/lib/revox/resources/phone_numbers.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class PhoneNumbers
+      # Update a phone number
+      #
+      # @overload update(id, inbound_assistant_id: nil, label: nil, request_options: {})
+      #
+      # @param id [String]
+      # @param inbound_assistant_id [String, nil]
+      # @param label [String, nil]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::PhoneNumberUpdateResponse]
+      #
+      # @see Revox::Models::PhoneNumberUpdateParams
+      def update(id, params = {})
+        parsed, options = Revox::PhoneNumberUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["phone-numbers/%1$s", id],
+          body: parsed,
+          model: Revox::Models::PhoneNumberUpdateResponse,
+          options: options
+        )
+      end
+
+      # Get phone numbers
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::PhoneNumberListResponse]
+      #
+      # @see Revox::Models::PhoneNumberListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "phone-numbers",
+          model: Revox::Models::PhoneNumberListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Delete a phone number
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::PhoneNumberDeleteResponse]
+      #
+      # @see Revox::Models::PhoneNumberDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["phone-numbers/%1$s", id],
+          model: Revox::Models::PhoneNumberDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Revox::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/revox/resources/users.rb

@@ -3,15 +3,29 @@
 module Revox
   module Resources
     class Users
-      # @return [Revox::Resources::Users::Me]
-      attr_reader :me
+      # Get the current authenticated user.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::UserRetrieveResponse]
+      #
+      # @see Revox::Models::UserRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "users/me",
+          model: Revox::Models::UserRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
 
       # @api private
       #
       # @param client [Revox::Client]
       def initialize(client:)
         @client = client
-        @me = Revox::Resources::Users::Me.new(client: client)
       end
     end
   end

data/lib/revox/resources/voices.rb

@@ -47,6 +47,56 @@ module Revox
         )
       end
 
+      # Delete a cloned voice. Only cloned voices can be deleted. Returns 409 if the
+      # voice is in use by an assistant.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The cloned voice ID to delete.
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::VoiceDeleteResponse]
+      #
+      # @see Revox::Models::VoiceDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["voices/%1$s", id],
+          model: Revox::Models::VoiceDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Clone a voice from an audio recording. Send audio as a base64-encoded string.
+      # The cloned voice will be available in GET /voices.
+      #
+      # @overload clone_(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}, nil]
+      #
+      # @return [Revox::Models::VoiceCloneResponse]
+      #
+      # @see Revox::Models::VoiceCloneParams
+      def clone_(params)
+        parsed, options = Revox::VoiceCloneParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "voices/clone",
+          body: parsed,
+          model: Revox::Models::VoiceCloneResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Revox::Models::VoicePreviewParams} for more details.
       #

data/lib/revox/version.rb

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

data/lib/revox.rb

@@ -52,6 +52,8 @@ 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_clone_params"
+require_relative "revox/models/assistant_clone_response"
 require_relative "revox/models/assistant_create_params"
 require_relative "revox/models/assistant_create_response"
 require_relative "revox/models/assistant_delete_params"
@@ -62,10 +64,24 @@ 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/auth_status_retrieve_params"
+require_relative "revox/models/auth_status_retrieve_response"
+require_relative "revox/models/call_cancel_params"
+require_relative "revox/models/call_cancel_response"
 require_relative "revox/models/call_create_params"
 require_relative "revox/models/call_create_response"
+require_relative "revox/models/call_export_params"
+require_relative "revox/models/call_export_response"
+require_relative "revox/models/call_pause_params"
+require_relative "revox/models/call_pause_response"
+require_relative "revox/models/call_phone_history_params"
+require_relative "revox/models/call_phone_history_response"
+require_relative "revox/models/call_resume_params"
+require_relative "revox/models/call_resume_response"
 require_relative "revox/models/call_retrieve_params"
 require_relative "revox/models/call_retrieve_response"
+require_relative "revox/models/call_search_params"
+require_relative "revox/models/call_search_response"
 require_relative "revox/models/campaign_cancel_params"
 require_relative "revox/models/campaign_cancel_response"
 require_relative "revox/models/campaign_create_params"
@@ -78,12 +94,28 @@ 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_pause_params"
+require_relative "revox/models/campaign_pause_response"
+require_relative "revox/models/campaign_resume_params"
+require_relative "revox/models/campaign_resume_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"
-require_relative "revox/models/users/me_update_response"
+require_relative "revox/models/campaign_statistics_params"
+require_relative "revox/models/campaign_statistics_response"
+require_relative "revox/models/campaign_update_params"
+require_relative "revox/models/campaign_update_response"
+require_relative "revox/models/phone_number_delete_params"
+require_relative "revox/models/phone_number_delete_response"
+require_relative "revox/models/phone_number_list_params"
+require_relative "revox/models/phone_number_list_response"
+require_relative "revox/models/phone_number_update_params"
+require_relative "revox/models/phone_number_update_response"
+require_relative "revox/models/user_retrieve_params"
+require_relative "revox/models/user_retrieve_response"
+require_relative "revox/models/voice_clone_params"
+require_relative "revox/models/voice_clone_response"
+require_relative "revox/models/voice_delete_params"
+require_relative "revox/models/voice_delete_response"
 require_relative "revox/models/voice_list_params"
 require_relative "revox/models/voice_list_response"
 require_relative "revox/models/voice_preview_params"
@@ -91,8 +123,9 @@ 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/auth_status"
 require_relative "revox/resources/call"
 require_relative "revox/resources/campaigns"
+require_relative "revox/resources/phone_numbers"
 require_relative "revox/resources/users"
-require_relative "revox/resources/users/me"
 require_relative "revox/resources/voices"

data/rbi/revox/client.rbi

@@ -13,9 +13,15 @@ module Revox
     sig { returns(String) }
     attr_reader :api_key
 
+    sig { returns(Revox::Resources::AuthStatus) }
+    attr_reader :auth_status
+
     sig { returns(Revox::Resources::Campaigns) }
     attr_reader :campaigns
 
+    sig { returns(Revox::Resources::PhoneNumbers) }
+    attr_reader :phone_numbers
+
     sig { returns(Revox::Resources::Assistants) }
     attr_reader :assistants
 

data/rbi/revox/models/assistant_clone_params.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Revox
+  module Models
+    class AssistantCloneParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::AssistantCloneParams, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns({ id: String, request_options: Revox::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end