revox 0.2.0 → 0.3.0

data/lib/revox/models/user_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Users#retrieve
+    class UserRetrieveParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/revox/models/user_retrieve_response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Users#retrieve
+    class UserRetrieveResponse < Revox::Internal::Type::BaseModel
+      # @!attribute user
+      #   The current authenticated user.
+      #
+      #   @return [Revox::Models::UserRetrieveResponse::User]
+      required :user, -> { Revox::Models::UserRetrieveResponse::User }
+
+      # @!method initialize(user:)
+      #   @param user [Revox::Models::UserRetrieveResponse::User] The current authenticated user.
+
+      # @see Revox::Models::UserRetrieveResponse#user
+      class User < Revox::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The time the user was created.
+        #
+        #   @return [Object]
+        required :created_at, Revox::Internal::Type::Unknown
+
+        # @!attribute email
+        #   The email address of the user.
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute first_name
+        #   The first name of the user.
+        #
+        #   @return [String, nil]
+        required :first_name, String, nil?: true
+
+        # @!attribute has_completed_onboarding
+        #   Whether the user has completed the onboarding tutorial.
+        #
+        #   @return [Boolean]
+        required :has_completed_onboarding, Revox::Internal::Type::Boolean
+
+        # @!attribute last_name
+        #   The last name of the user.
+        #
+        #   @return [String, nil]
+        required :last_name, String, nil?: true
+
+        # @!attribute organization_id
+        #   The ID of the organization the user belongs to.
+        #
+        #   @return [String]
+        required :organization_id, String
+
+        # @!attribute updated_at
+        #   The time the user was last updated.
+        #
+        #   @return [Object]
+        required :updated_at, Revox::Internal::Type::Unknown
+
+        # @!attribute organization_country
+        #   ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the
+        #   default region when normalizing national-format phone numbers.
+        #
+        #   @return [String, nil]
+        optional :organization_country, String, nil?: true
+
+        # @!method initialize(id:, created_at:, email:, first_name:, has_completed_onboarding:, last_name:, organization_id:, updated_at:, organization_country: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::UserRetrieveResponse::User} for more details.
+        #
+        #   The current authenticated user.
+        #
+        #   @param id [String] The unique identifier of the user.
+        #
+        #   @param created_at [Object] The time the user was created.
+        #
+        #   @param email [String] The email address of the user.
+        #
+        #   @param first_name [String, nil] The first name of the user.
+        #
+        #   @param has_completed_onboarding [Boolean] Whether the user has completed the onboarding tutorial.
+        #
+        #   @param last_name [String, nil] The last name of the user.
+        #
+        #   @param organization_id [String] The ID of the organization the user belongs to.
+        #
+        #   @param updated_at [Object] The time the user was last updated.
+        #
+        #   @param organization_country [String, nil] ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the defau
+      end
+    end
+  end
+end

data/lib/revox/models/voice_clone_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Voices#clone_
+    class VoiceCloneParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute audio
+      #   Base64-encoded audio data (max ~7.5MB decoded)
+      #
+      #   @return [String]
+      required :audio, String
+
+      # @!attribute content_type
+      #   MIME type of the audio
+      #
+      #   @return [Symbol, Revox::Models::VoiceCloneParams::ContentType]
+      required :content_type, enum: -> { Revox::VoiceCloneParams::ContentType }, api_name: :contentType
+
+      # @!attribute language
+      #   Language of the voice
+      #
+      #   @return [Symbol, Revox::Models::VoiceCloneParams::Language]
+      required :language, enum: -> { Revox::VoiceCloneParams::Language }
+
+      # @!attribute name
+      #   Name for the cloned voice
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(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}]
+
+      # MIME type of the audio
+      module ContentType
+        extend Revox::Internal::Type::Enum
+
+        AUDIO_WEBM = :"audio/webm"
+        AUDIO_WAV = :"audio/wav"
+        AUDIO_MPEG = :"audio/mpeg"
+        AUDIO_OGG = :"audio/ogg"
+        AUDIO_MP4 = :"audio/mp4"
+        VIDEO_WEBM = :"video/webm"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Language of the voice
+      module Language
+        extend Revox::Internal::Type::Enum
+
+        EN = :en
+        FR = :fr
+        ES = :es
+        DE = :de
+        IT = :it
+        PT = :pt
+        RU = :ru
+        ZH = :zh
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/revox/models/voice_clone_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Voices#clone_
+    class VoiceCloneResponse < Revox::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cartesia_voice_id
+      #
+      #   @return [String]
+      required :cartesia_voice_id, String, api_name: :cartesiaVoiceId
+
+      # @!attribute created_at
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute language
+      #
+      #   @return [String]
+      required :language, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(id:, cartesia_voice_id:, created_at:, language:, name:)
+      #   @param id [String]
+      #   @param cartesia_voice_id [String]
+      #   @param created_at [String]
+      #   @param language [String]
+      #   @param name [String]
+    end
+  end
+end

data/lib/revox/models/voice_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Voices#delete
+    class VoiceDeleteParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/revox/models/voice_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Voices#delete
+    class VoiceDeleteResponse < Revox::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Revox::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/revox/models.rb

@@ -39,6 +39,8 @@ module Revox
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  AssistantCloneParams = Revox::Models::AssistantCloneParams
+
   AssistantCreateParams = Revox::Models::AssistantCreateParams
 
   AssistantDeleteParams = Revox::Models::AssistantDeleteParams
@@ -49,10 +51,24 @@ module Revox
 
   AssistantUpdateParams = Revox::Models::AssistantUpdateParams
 
+  AuthStatusRetrieveParams = Revox::Models::AuthStatusRetrieveParams
+
+  CallCancelParams = Revox::Models::CallCancelParams
+
   CallCreateParams = Revox::Models::CallCreateParams
 
+  CallExportParams = Revox::Models::CallExportParams
+
+  CallPauseParams = Revox::Models::CallPauseParams
+
+  CallPhoneHistoryParams = Revox::Models::CallPhoneHistoryParams
+
+  CallResumeParams = Revox::Models::CallResumeParams
+
   CallRetrieveParams = Revox::Models::CallRetrieveParams
 
+  CallSearchParams = Revox::Models::CallSearchParams
+
   CampaignCancelParams = Revox::Models::CampaignCancelParams
 
   CampaignCreateParams = Revox::Models::CampaignCreateParams
@@ -63,11 +79,31 @@ module Revox
 
   CampaignGetRowsParams = Revox::Models::CampaignGetRowsParams
 
+  CampaignLaunchParams = Revox::Models::CampaignLaunchParams
+
   CampaignListParams = Revox::Models::CampaignListParams
 
+  CampaignPauseParams = Revox::Models::CampaignPauseParams
+
+  CampaignResumeParams = Revox::Models::CampaignResumeParams
+
   CampaignRetrieveParams = Revox::Models::CampaignRetrieveParams
 
-  Users = Revox::Models::Users
+  CampaignStatisticsParams = Revox::Models::CampaignStatisticsParams
+
+  CampaignUpdateParams = Revox::Models::CampaignUpdateParams
+
+  PhoneNumberDeleteParams = Revox::Models::PhoneNumberDeleteParams
+
+  PhoneNumberListParams = Revox::Models::PhoneNumberListParams
+
+  PhoneNumberUpdateParams = Revox::Models::PhoneNumberUpdateParams
+
+  UserRetrieveParams = Revox::Models::UserRetrieveParams
+
+  VoiceCloneParams = Revox::Models::VoiceCloneParams
+
+  VoiceDeleteParams = Revox::Models::VoiceDeleteParams
 
   VoiceListParams = Revox::Models::VoiceListParams
 

data/lib/revox/resources/assistants.rb

@@ -301,6 +301,27 @@ module Revox
         )
       end
 
+      # Create a full copy of an existing assistant, including every configuration field
+      # and FAQ items. The new assistant has the same configuration as the source, with
+      # the name suffixed by "(Copy)" and a freshly generated API key.
+      #
+      # @overload clone_(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AssistantCloneResponse]
+      #
+      # @see Revox::Models::AssistantCloneParams
+      def clone_(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["assistants/%1$s/clone", id],
+          model: Revox::Models::AssistantCloneResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Revox::Client]

data/lib/revox/resources/auth_status.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Revox
+  module Resources
+    class AuthStatus
+      # Check if your API key is still valid.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::AuthStatusRetrieveResponse]
+      #
+      # @see Revox::Models::AuthStatusRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "auth-status",
+          model: Revox::Models::AuthStatusRetrieveResponse,
+          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

@@ -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

@@ -65,6 +65,49 @@ module Revox
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Revox::Models::CampaignUpdateParams} for more details.
+      #
+      # Update editable fields on a campaign. Draft campaigns support updating all
+      # fields including assistant, contacts, and settings. Non-draft campaigns only
+      # support renaming.
+      #
+      # @overload update(id, assistant_id: nil, call_retry_config: nil, contacts: nil, from_phone_number: nil, max_concurrent_calls: nil, name: nil, scheduled_at: nil, type: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param assistant_id [String] The ID of the assistant to use (draft only)
+      #
+      # @param call_retry_config [Revox::Models::CampaignUpdateParams::CallRetryConfig, nil] Configuration for call retry behavior including time windows, delays, and max it
+      #
+      # @param contacts [Array<Revox::Models::CampaignUpdateParams::Contact>] Replace contact list (draft only)
+      #
+      # @param from_phone_number [String, nil] The phone number to use for outbound calls (draft only)
+      #
+      # @param max_concurrent_calls [Float, nil] Maximum concurrent calls (draft only)
+      #
+      # @param name [String] Campaign display name
+      #
+      # @param scheduled_at [Time, Object, nil] Scheduled start time (draft only)
+      #
+      # @param type [Symbol, Revox::Models::CampaignUpdateParams::Type] Campaign type (draft only)
+      #
+      # @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.
       #
@@ -165,6 +208,94 @@ module Revox
         )
       end
 
+      # Launch a previously saved draft campaign. This starts all calls immediately (or
+      # queues them if scheduled_at is set). The campaign must be in draft status.
+      #
+      # @overload launch(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Revox::Models::CampaignLaunchResponse]
+      #
+      # @see Revox::Models::CampaignLaunchParams
+      def launch(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["campaigns/%1$s/launch", id],
+          model: Revox::Models::CampaignLaunchResponse,
+          options: params[:request_options]
+        )
+      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]