revox 0.2.0 → 0.3.0

data/rbi/revox/models/user_retrieve_params.rbi

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

data/rbi/revox/models/user_retrieve_response.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Revox
+  module Models
+    class UserRetrieveResponse < Revox::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Revox::Models::UserRetrieveResponse, Revox::Internal::AnyHash)
+        end
+
+      # The current authenticated user.
+      sig { returns(Revox::Models::UserRetrieveResponse::User) }
+      attr_reader :user
+
+      sig do
+        params(user: Revox::Models::UserRetrieveResponse::User::OrHash).void
+      end
+      attr_writer :user
+
+      sig do
+        params(user: Revox::Models::UserRetrieveResponse::User::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # The current authenticated user.
+        user:
+      )
+      end
+
+      sig do
+        override.returns({ user: Revox::Models::UserRetrieveResponse::User })
+      end
+      def to_hash
+      end
+
+      class User < Revox::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Revox::Models::UserRetrieveResponse::User,
+              Revox::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The time the user was created.
+        sig { returns(T.anything) }
+        attr_accessor :created_at
+
+        # The email address of the user.
+        sig { returns(String) }
+        attr_accessor :email
+
+        # The first name of the user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :first_name
+
+        # Whether the user has completed the onboarding tutorial.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_completed_onboarding
+
+        # The last name of the user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :last_name
+
+        # The ID of the organization the user belongs to.
+        sig { returns(String) }
+        attr_accessor :organization_id
+
+        # The time the user was last updated.
+        sig { returns(T.anything) }
+        attr_accessor :updated_at
+
+        # ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the
+        # default region when normalizing national-format phone numbers.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :organization_country
+
+        # The current authenticated user.
+        sig do
+          params(
+            id: String,
+            created_at: T.anything,
+            email: String,
+            first_name: T.nilable(String),
+            has_completed_onboarding: T::Boolean,
+            last_name: T.nilable(String),
+            organization_id: String,
+            updated_at: T.anything,
+            organization_country: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier of the user.
+          id:,
+          # The time the user was created.
+          created_at:,
+          # The email address of the user.
+          email:,
+          # The first name of the user.
+          first_name:,
+          # Whether the user has completed the onboarding tutorial.
+          has_completed_onboarding:,
+          # The last name of the user.
+          last_name:,
+          # The ID of the organization the user belongs to.
+          organization_id:,
+          # The time the user was last updated.
+          updated_at:,
+          # ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the
+          # default region when normalizing national-format phone numbers.
+          organization_country: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: T.anything,
+              email: String,
+              first_name: T.nilable(String),
+              has_completed_onboarding: T::Boolean,
+              last_name: T.nilable(String),
+              organization_id: String,
+              updated_at: T.anything,
+              organization_country: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_clone_params.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceCloneParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::VoiceCloneParams, Revox::Internal::AnyHash)
+        end
+
+      # Base64-encoded audio data (max ~7.5MB decoded)
+      sig { returns(String) }
+      attr_accessor :audio
+
+      # MIME type of the audio
+      sig { returns(Revox::VoiceCloneParams::ContentType::OrSymbol) }
+      attr_accessor :content_type
+
+      # Language of the voice
+      sig { returns(Revox::VoiceCloneParams::Language::OrSymbol) }
+      attr_accessor :language
+
+      # Name for the cloned voice
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          audio: String,
+          content_type: Revox::VoiceCloneParams::ContentType::OrSymbol,
+          language: Revox::VoiceCloneParams::Language::OrSymbol,
+          name: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Base64-encoded audio data (max ~7.5MB decoded)
+        audio:,
+        # MIME type of the audio
+        content_type:,
+        # Language of the voice
+        language:,
+        # Name for the cloned voice
+        name:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            audio: String,
+            content_type: Revox::VoiceCloneParams::ContentType::OrSymbol,
+            language: Revox::VoiceCloneParams::Language::OrSymbol,
+            name: String,
+            request_options: Revox::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # MIME type of the audio
+      module ContentType
+        extend Revox::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Revox::VoiceCloneParams::ContentType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUDIO_WEBM =
+          T.let(
+            :"audio/webm",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_WAV =
+          T.let(
+            :"audio/wav",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_MPEG =
+          T.let(
+            :"audio/mpeg",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_OGG =
+          T.let(
+            :"audio/ogg",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        AUDIO_MP4 =
+          T.let(
+            :"audio/mp4",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+        VIDEO_WEBM =
+          T.let(
+            :"video/webm",
+            Revox::VoiceCloneParams::ContentType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Revox::VoiceCloneParams::ContentType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Language of the voice
+      module Language
+        extend Revox::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Revox::VoiceCloneParams::Language) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EN = T.let(:en, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        FR = T.let(:fr, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        ES = T.let(:es, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        DE = T.let(:de, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        IT = T.let(:it, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        PT = T.let(:pt, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        RU = T.let(:ru, Revox::VoiceCloneParams::Language::TaggedSymbol)
+        ZH = T.let(:zh, Revox::VoiceCloneParams::Language::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Revox::VoiceCloneParams::Language::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_clone_response.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceCloneResponse < Revox::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Revox::Models::VoiceCloneResponse, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :cartesia_voice_id
+
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :language
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          id: String,
+          cartesia_voice_id: String,
+          created_at: String,
+          language: String,
+          name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, cartesia_voice_id:, created_at:, language:, name:)
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            cartesia_voice_id: String,
+            created_at: String,
+            language: String,
+            name: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/revox/models/voice_delete_params.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceDeleteParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::VoiceDeleteParams, 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

data/rbi/revox/models/voice_delete_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Revox
+  module Models
+    class VoiceDeleteResponse < Revox::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Revox::Models::VoiceDeleteResponse, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig { params(success: T::Boolean).returns(T.attached_class) }
+      def self.new(success:)
+      end
+
+      sig { override.returns({ success: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/revox/models.rbi

@@ -1,6 +1,8 @@
 # typed: strong
 
 module Revox
+  AssistantCloneParams = Revox::Models::AssistantCloneParams
+
   AssistantCreateParams = Revox::Models::AssistantCreateParams
 
   AssistantDeleteParams = Revox::Models::AssistantDeleteParams
@@ -11,10 +13,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
@@ -25,11 +41,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/rbi/revox/resources/assistants.rbi

@@ -492,6 +492,18 @@ module Revox
       def delete(id, request_options: {})
       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.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::AssistantCloneResponse)
+      end
+      def clone_(id, request_options: {})
+      end
+
       # @api private
       sig { params(client: Revox::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/revox/resources/auth_status.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Revox
+  module Resources
+    class AuthStatus
+      # Check if your API key is still valid.
+      sig do
+        params(request_options: Revox::RequestOptions::OrHash).returns(
+          Revox::Models::AuthStatusRetrieveResponse
+        )
+      end
+      def retrieve(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/call.rbi

@@ -68,6 +68,113 @@ module Revox
       )
       end
 
+      # Cancel a running or scheduled call.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallCancelResponse)
+      end
+      def cancel(id, request_options: {})
+      end
+
+      # Export a list of call attempts as a CSV file.
+      sig do
+        params(
+          filters: Revox::CallExportParams::Filters::OrHash,
+          include_metadata: T::Boolean,
+          include_structured_output_fields: T::Boolean,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallExportResponse)
+      end
+      def export(
+        filters:,
+        # Whether to include the metadata in the CSV file. These are the fields you
+        # (optionally) attached when placing the call.
+        include_metadata: nil,
+        # Whether to include the structured output fields in the CSV file. These are
+        # generated by our AI agent during call analysis phase.
+        include_structured_output_fields: nil,
+        request_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.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallPauseResponse)
+      end
+      def pause(id, 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.
+      sig do
+        params(request_options: Revox::RequestOptions::OrHash).returns(
+          Revox::Models::CallPhoneHistoryResponse
+        )
+      end
+      def phone_history(request_options: {})
+      end
+
+      # Resume a previously paused call. The retry loop will continue from where it left
+      # off.
+      sig do
+        params(
+          id: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallResumeResponse)
+      end
+      def resume(id, 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.
+      sig do
+        params(
+          assignee_ids: T::Array[String],
+          assistant_ids: T::Array[String],
+          campaign_ids: T::Array[String],
+          directions: T::Array[Revox::CallSearchParams::Direction::OrSymbol],
+          from_phone_numbers: T::Array[String],
+          outcomes: T::Array[Revox::CallSearchParams::Outcome::OrSymbol],
+          page: Integer,
+          page_size: Integer,
+          results: T::Array[Revox::CallSearchParams::Result::OrSymbol],
+          statuses: T::Array[Revox::CallSearchParams::Status::OrSymbol],
+          call_ids: T::Array[String],
+          query: String,
+          sort_by: String,
+          sort_direction: Revox::CallSearchParams::SortDirection::OrSymbol,
+          to_phone_number: String,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(Revox::Models::CallSearchResponse)
+      end
+      def 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: {}
+      )
+      end
+
       # @api private
       sig { params(client: Revox::Client).returns(T.attached_class) }
       def self.new(client:)