elevenlabs_client 0.6.0 → 0.8.0

data/lib/elevenlabs_client/endpoints/agents_platform/phone_numbers.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class PhoneNumbers
+        def initialize(client)
+          @client = client
+        end
+
+        # POST /v1/convai/phone-numbers
+        # Import Phone Number from provider configuration (Twilio or SIP trunk)
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/phone-numbers/import
+        #
+        # @param phone_number [String] The phone number to import
+        # @param label [String] Label for the phone number
+        # @param options [Hash] Provider-specific configuration
+        # @option options [String] :sid Twilio Account SID (for Twilio provider)
+        # @option options [String] :token Twilio Auth Token (for Twilio provider)
+        # @option options [String] :provider_type Provider type ("twilio" or "sip_trunk")
+        # @option options [Hash] :inbound_trunk_config Inbound trunk configuration (for SIP trunk)
+        # @option options [Hash] :outbound_trunk_config Outbound trunk configuration (for SIP trunk)
+        # @option options [String] :livekit_stack LiveKit stack configuration
+        # @return [Hash] Created phone number with phone_number_id
+        def import(phone_number:, label:, **options)
+          endpoint = "/v1/convai/phone-numbers"
+          request_body = {
+            phone_number: phone_number,
+            label: label
+          }.merge(options)
+          
+          @client.post(endpoint, request_body)
+        end
+
+        # GET /v1/convai/phone-numbers
+        # Retrieve all Phone Numbers
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/phone-numbers/list
+        #
+        # @return [Array<Hash>] List of phone numbers with their details
+        def list
+          endpoint = "/v1/convai/phone-numbers"
+          @client.get(endpoint)
+        end
+
+        # GET /v1/convai/phone-numbers/{phone_number_id}
+        # Retrieve Phone Number details by ID
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/phone-numbers/get
+        #
+        # @param phone_number_id [String] The id of a phone number
+        # @return [Hash] Phone number details including provider info and assigned agent
+        def get(phone_number_id)
+          endpoint = "/v1/convai/phone-numbers/#{phone_number_id}"
+          @client.get(endpoint)
+        end
+
+        # PATCH /v1/convai/phone-numbers/{phone_number_id}
+        # Update assigned agent of a phone number
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/phone-numbers/update
+        #
+        # @param phone_number_id [String] The id of a phone number
+        # @param options [Hash] Update parameters
+        # @option options [String] :agent_id Agent ID to assign to the phone number
+        # @option options [Hash] :inbound_trunk_config Inbound trunk configuration
+        # @option options [Hash] :outbound_trunk_config Outbound trunk configuration
+        # @option options [String] :livekit_stack LiveKit stack configuration ("standard" or "static")
+        # @return [Hash] Updated phone number details
+        def update(phone_number_id, **options)
+          endpoint = "/v1/convai/phone-numbers/#{phone_number_id}"
+          request_body = options
+          @client.patch(endpoint, request_body)
+        end
+
+        # DELETE /v1/convai/phone-numbers/{phone_number_id}
+        # Delete Phone Number by ID
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/phone-numbers/delete
+        #
+        # @param phone_number_id [String] The id of a phone number
+        # @return [Hash] Empty response on success
+        def delete(phone_number_id)
+          endpoint = "/v1/convai/phone-numbers/#{phone_number_id}"
+          @client.delete(endpoint)
+        end
+      end
+    end
+  end
+end

data/lib/elevenlabs_client/endpoints/agents_platform/test_invocations.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class TestInvocations
+        def initialize(client)
+          @client = client
+        end
+
+        # GET /v1/convai/test-invocations/{test_invocation_id}
+        # Gets a test invocation by ID
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/test-invocations/get
+        #
+        # @param test_invocation_id [String] The id of a test invocation
+        # @return [Hash] Test invocation details including test runs and status
+        def get(test_invocation_id)
+          endpoint = "/v1/convai/test-invocations/#{test_invocation_id}"
+          @client.get(endpoint)
+        end
+
+        # POST /v1/convai/test-invocations/{test_invocation_id}/resubmit
+        # Resubmits specific test runs from a test invocation
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/test-invocations/resubmit
+        #
+        # @param test_invocation_id [String] The id of a test invocation
+        # @param test_run_ids [Array<String>] List of test run IDs to resubmit
+        # @param agent_id [String] Agent ID to resubmit tests for
+        # @param options [Hash] Optional parameters
+        # @option options [Hash] :agent_config_override Configuration overrides to use for testing
+        # @return [Hash] Resubmission response
+        def resubmit(test_invocation_id, test_run_ids:, agent_id:, **options)
+          endpoint = "/v1/convai/test-invocations/#{test_invocation_id}/resubmit"
+          request_body = {
+            test_run_ids: test_run_ids,
+            agent_id: agent_id
+          }.merge(options)
+          
+          @client.post(endpoint, request_body)
+        end
+      end
+    end
+  end
+end

data/lib/elevenlabs_client/endpoints/agents_platform/tests.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class Tests
+        def initialize(client)
+          @client = client
+        end
+
+        # GET /v1/convai/agent-testing
+        # Lists all agent response tests with pagination support and optional search filtering
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agent-testing/list
+        #
+        # @param options [Hash] Query parameters
+        # @option options [String] :cursor Used for fetching next page
+        # @option options [Integer] :page_size How many tests to return at maximum (1-100, default: 30)
+        # @option options [String] :search Search query to filter tests by name
+        # @return [Hash] List of tests with pagination info
+        def list(**options)
+          endpoint = "/v1/convai/agent-testing"
+          query_params = options.compact
+          
+          if query_params.any?
+            query_string = URI.encode_www_form(query_params)
+            endpoint = "#{endpoint}?#{query_string}"
+          end
+          
+          @client.get(endpoint)
+        end
+
+        # GET /v1/convai/agent-testing/{test_id}
+        # Gets an agent response test by ID
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agent-testing/get
+        #
+        # @param test_id [String] The id of a chat response test
+        # @return [Hash] Complete test details including chat history and evaluation criteria
+        def get(test_id)
+          endpoint = "/v1/convai/agent-testing/#{test_id}"
+          @client.get(endpoint)
+        end
+
+        # POST /v1/convai/agent-testing/create
+        # Creates a new agent response test
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agent-testing/create
+        #
+        # @param name [String] Name of the test
+        # @param chat_history [Array<Hash>] List of chat messages for the test
+        # @param success_condition [String] Prompt that evaluates whether the agent's response is successful
+        # @param success_examples [Array<Hash>] Non-empty list of example responses that should be considered successful
+        # @param failure_examples [Array<Hash>] Non-empty list of example responses that should be considered failures
+        # @param options [Hash] Optional parameters
+        # @option options [Hash] :tool_call_parameters How to evaluate the agent's tool call (if any)
+        # @option options [Hash] :dynamic_variables Dynamic variables to replace in the agent config during testing
+        # @option options [String] :type Test type ("llm" or "tool")
+        # @return [Hash] Created test with ID
+        def create(name:, chat_history:, success_condition:, success_examples:, failure_examples:, **options)
+          endpoint = "/v1/convai/agent-testing/create"
+          request_body = {
+            name: name,
+            chat_history: chat_history,
+            success_condition: success_condition,
+            success_examples: success_examples,
+            failure_examples: failure_examples
+          }.merge(options)
+          
+          @client.post(endpoint, request_body)
+        end
+
+        # PUT /v1/convai/agent-testing/{test_id}
+        # Updates an agent response test by ID
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agent-testing/update
+        #
+        # @param test_id [String] The id of a chat response test
+        # @param name [String] Name of the test
+        # @param chat_history [Array<Hash>] List of chat messages for the test
+        # @param success_condition [String] Prompt that evaluates whether the agent's response is successful
+        # @param success_examples [Array<Hash>] Non-empty list of example responses that should be considered successful
+        # @param failure_examples [Array<Hash>] Non-empty list of example responses that should be considered failures
+        # @param options [Hash] Optional parameters
+        # @option options [Hash] :tool_call_parameters How to evaluate the agent's tool call (if any)
+        # @option options [Hash] :dynamic_variables Dynamic variables to replace in the agent config during testing
+        # @option options [String] :type Test type ("llm" or "tool")
+        # @return [Hash] Updated test details
+        def update(test_id, name:, chat_history:, success_condition:, success_examples:, failure_examples:, **options)
+          endpoint = "/v1/convai/agent-testing/#{test_id}"
+          request_body = {
+            name: name,
+            chat_history: chat_history,
+            success_condition: success_condition,
+            success_examples: success_examples,
+            failure_examples: failure_examples
+          }.merge(options)
+          
+          @client.patch(endpoint, request_body)
+        end
+
+        # DELETE /v1/convai/agent-testing/{test_id}
+        # Deletes an agent response test by ID
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agent-testing/delete
+        #
+        # @param test_id [String] The id of a chat response test
+        # @return [Hash] Empty response on success
+        def delete(test_id)
+          endpoint = "/v1/convai/agent-testing/#{test_id}"
+          @client.delete(endpoint)
+        end
+
+        # POST /v1/convai/agent-testing/summaries
+        # Gets multiple agent response tests by their IDs
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agent-testing/summaries
+        #
+        # @param test_ids [Array<String>] List of test IDs to fetch (no duplicates allowed)
+        # @return [Hash] Dictionary mapping test IDs to their summary information
+        def get_summaries(test_ids)
+          endpoint = "/v1/convai/agent-testing/summaries"
+          request_body = { test_ids: test_ids }
+          @client.post(endpoint, request_body)
+        end
+
+        # POST /v1/convai/agents/{agent_id}/run-tests
+        # Run selected tests on the agent with provided configuration
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agent-testing/run-tests
+        #
+        # @param agent_id [String] The id of an agent
+        # @param tests [Array<Hash>] List of tests to run on the agent
+        # @param options [Hash] Optional parameters
+        # @option options [Hash] :agent_config_override Configuration overrides to use for testing
+        # @return [Hash] Test run results with status and responses
+        def run_on_agent(agent_id, tests:, **options)
+          endpoint = "/v1/convai/agents/#{agent_id}/run-tests"
+          request_body = { tests: tests }.merge(options)
+          @client.post(endpoint, request_body)
+        end
+      end
+    end
+  end
+end

data/lib/elevenlabs_client/endpoints/agents_platform/tools.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class Tools
+        def initialize(client)
+          @client = client
+        end
+
+        # GET /v1/convai/tools
+        # Get all available tools in the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/tools/list
+        #
+        # @return [Hash] List of tools with their configurations and metadata
+        def list
+          endpoint = "/v1/convai/tools"
+          @client.get(endpoint)
+        end
+
+        # GET /v1/convai/tools/{tool_id}
+        # Get tool that is available in the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/tools/get
+        #
+        # @param tool_id [String] ID of the requested tool
+        # @return [Hash] Tool configuration and metadata
+        def get(tool_id)
+          endpoint = "/v1/convai/tools/#{tool_id}"
+          @client.get(endpoint)
+        end
+
+        # POST /v1/convai/tools
+        # Add a new tool to the available tools in the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/tools/create
+        #
+        # @param tool_config [Hash] Configuration for the tool
+        # @option tool_config [String] :name Required name of the tool
+        # @option tool_config [String] :description Required description of the tool
+        # @option tool_config [Hash] :api_schema Required API schema configuration
+        # @option tool_config [Integer] :response_timeout_secs Optional response timeout (default: 20)
+        # @option tool_config [Boolean] :disable_interruptions Optional disable interruptions (default: false)
+        # @option tool_config [Boolean] :force_pre_tool_speech Optional force pre-tool speech (default: false)
+        # @option tool_config [Array<Hash>] :assignments Optional variable assignments
+        # @option tool_config [Hash] :dynamic_variables Optional dynamic variables
+        # @return [Hash] Created tool with ID and configuration
+        def create(tool_config:)
+          endpoint = "/v1/convai/tools"
+          request_body = { tool_config: tool_config }
+          @client.post(endpoint, request_body)
+        end
+
+        # PATCH /v1/convai/tools/{tool_id}
+        # Update tool that is available in the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/tools/update
+        #
+        # @param tool_id [String] ID of the requested tool
+        # @param tool_config [Hash] Updated configuration for the tool
+        # @option tool_config [String] :name Optional updated name of the tool
+        # @option tool_config [String] :description Optional updated description of the tool
+        # @option tool_config [Hash] :api_schema Optional updated API schema configuration
+        # @option tool_config [Integer] :response_timeout_secs Optional response timeout
+        # @option tool_config [Boolean] :disable_interruptions Optional disable interruptions
+        # @option tool_config [Boolean] :force_pre_tool_speech Optional force pre-tool speech
+        # @option tool_config [Array<Hash>] :assignments Optional variable assignments
+        # @option tool_config [Hash] :dynamic_variables Optional dynamic variables
+        # @return [Hash] Updated tool configuration and metadata
+        def update(tool_id, tool_config:)
+          endpoint = "/v1/convai/tools/#{tool_id}"
+          request_body = { tool_config: tool_config }
+          @client.patch(endpoint, request_body)
+        end
+
+        # DELETE /v1/convai/tools/{tool_id}
+        # Delete tool from the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/tools/delete
+        #
+        # @param tool_id [String] ID of the requested tool
+        # @return [Hash] Empty response on success
+        def delete(tool_id)
+          endpoint = "/v1/convai/tools/#{tool_id}"
+          @client.delete(endpoint)
+        end
+
+        # GET /v1/convai/tools/{tool_id}/dependent-agents
+        # Get a list of agents depending on this tool
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/tools/dependent-agents
+        #
+        # @param tool_id [String] ID of the requested tool
+        # @param options [Hash] Query parameters
+        # @option options [String] :cursor Used for fetching next page
+        # @option options [Integer] :page_size How many agents to return at maximum (1-100, default: 30)
+        # @return [Hash] List of dependent agents with pagination info
+        def get_dependent_agents(tool_id, **options)
+          endpoint = "/v1/convai/tools/#{tool_id}/dependent-agents"
+          query_params = options.compact
+          
+          if query_params.any?
+            query_string = URI.encode_www_form(query_params)
+            endpoint = "#{endpoint}?#{query_string}"
+          end
+          
+          @client.get(endpoint)
+        end
+      end
+    end
+  end
+end

data/lib/elevenlabs_client/endpoints/agents_platform/widgets.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class Widgets
+        def initialize(client)
+          @client = client
+        end
+
+        # GET /v1/convai/agents/{agent_id}/widget
+        # Retrieve the widget configuration for an agent
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/get-widget
+        #
+        # @param agent_id [String] The id of an agent
+        # @param options [Hash] Optional parameters
+        # @option options [String] :conversation_signature An expiring token that enables a websocket conversation to start
+        # @return [Hash] Widget configuration including styling, behavior, and text content
+        def get(agent_id, **options)
+          endpoint = "/v1/convai/agents/#{agent_id}/widget"
+          query_params = options.compact
+
+          if query_params.any?
+            query_string = URI.encode_www_form(query_params)
+            endpoint = "#{endpoint}?#{query_string}"
+          end
+
+          @client.get(endpoint)
+        end
+
+        # POST /v1/convai/agents/{agent_id}/avatar
+        # Sets the avatar for an agent displayed in the widget
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/create-avatar
+        #
+        # @param agent_id [String] The id of an agent
+        # @param avatar_file_io [IO] The avatar file to upload (e.g., `File.open("avatar.png", "rb")`)
+        # @param filename [String] The name of the file, including extension
+        # @return [Hash] JSON response containing agent_id and avatar_url
+        def create_avatar(agent_id, avatar_file_io:, filename:)
+          endpoint = "/v1/convai/agents/#{agent_id}/avatar"
+          
+          # Prepare multipart form data
+          payload = {
+            "avatar_file" => @client.file_part(avatar_file_io, filename)
+          }
+
+          @client.post_multipart(endpoint, payload)
+        end
+      end
+    end
+  end
+end

data/lib/elevenlabs_client/endpoints/agents_platform/workspace.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class Workspace
+        def initialize(client)
+          @client = client
+        end
+
+        # GET /v1/convai/settings
+        # Retrieve Convai settings for the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/get-settings
+        #
+        # @return [Hash] JSON response containing workspace settings
+        def get_settings
+          @client.get("/v1/convai/settings")
+        end
+
+        # PATCH /v1/convai/settings
+        # Update Convai settings for the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/update-settings
+        #
+        # @param options [Hash] Settings to update
+        # @option options [Hash] :conversation_initiation_client_data_webhook Webhook configuration
+        # @option options [Hash] :webhooks Webhook settings
+        # @option options [Boolean] :can_use_mcp_servers Whether workspace can use MCP servers
+        # @option options [Integer] :rag_retention_period_days RAG retention period (<=30)
+        # @option options [String] :default_livekit_stack Default LiveKit stack ("standard" or "static")
+        # @return [Hash] JSON response containing updated settings
+        def update_settings(**options)
+          body = options.compact
+          @client.patch("/v1/convai/settings", body)
+        end
+
+        # GET /v1/convai/secrets
+        # Get all workspace secrets for the user
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/get-secrets
+        #
+        # @return [Hash] JSON response containing list of secrets
+        def get_secrets
+          @client.get("/v1/convai/secrets")
+        end
+
+        # POST /v1/convai/secrets
+        # Create a new secret for the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/create-secret
+        #
+        # @param name [String] Name of the secret
+        # @param value [String] Value of the secret
+        # @param type [String] Type of secret (defaults to "new")
+        # @return [Hash] JSON response containing created secret info
+        def create_secret(name:, value:, type: "new")
+          raise ArgumentError, "name is required" if name.nil? || name.to_s.strip.empty?
+          raise ArgumentError, "value is required" if value.nil? || value.to_s.strip.empty?
+
+          body = {
+            type: type,
+            name: name,
+            value: value
+          }
+
+          @client.post("/v1/convai/secrets", body)
+        end
+
+        # PATCH /v1/convai/secrets/:secret_id
+        # Update an existing secret for the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/update-secret
+        #
+        # @param secret_id [String] ID of the secret to update
+        # @param name [String] New name for the secret
+        # @param value [String] New value for the secret
+        # @param type [String] Type of operation (defaults to "update")
+        # @return [Hash] JSON response containing updated secret info
+        def update_secret(secret_id, name:, value:, type: "update")
+          raise ArgumentError, "secret_id is required" if secret_id.nil? || secret_id.to_s.strip.empty?
+          raise ArgumentError, "name is required" if name.nil? || name.to_s.strip.empty?
+          raise ArgumentError, "value is required" if value.nil? || value.to_s.strip.empty?
+
+          body = {
+            type: type,
+            name: name,
+            value: value
+          }
+
+          @client.patch("/v1/convai/secrets/#{secret_id}", body)
+        end
+
+        # DELETE /v1/convai/secrets/:secret_id
+        # Delete a workspace secret if it's not in use
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/delete-secret
+        #
+        # @param secret_id [String] ID of the secret to delete
+        # @return [Hash] JSON response with deletion confirmation
+        def delete_secret(secret_id)
+          raise ArgumentError, "secret_id is required" if secret_id.nil? || secret_id.to_s.strip.empty?
+
+          @client.delete("/v1/convai/secrets/#{secret_id}")
+        end
+
+        # GET /v1/convai/settings/dashboard
+        # Retrieve Convai dashboard settings for the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/get-dashboard-settings
+        #
+        # @return [Hash] JSON response containing dashboard settings
+        def get_dashboard_settings
+          @client.get("/v1/convai/settings/dashboard")
+        end
+
+        # PATCH /v1/convai/settings/dashboard
+        # Update Convai dashboard settings for the workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/conversational-ai/workspace/update-dashboard-settings
+        #
+        # @param charts [Array] Array of chart configurations
+        # @return [Hash] JSON response containing updated dashboard settings
+        def update_dashboard_settings(charts: nil)
+          body = {}
+          body[:charts] = charts if charts
+
+          @client.patch("/v1/convai/settings/dashboard", body)
+        end
+
+        # Convenience method aliases
+        alias_method :settings, :get_settings
+        alias_method :secrets, :get_secrets
+        alias_method :dashboard_settings, :get_dashboard_settings
+      end
+    end
+  end
+end

data/lib/elevenlabs_client/errors.rb

@@ -9,4 +9,8 @@ module ElevenlabsClient
   class NotFoundError < Error; end
   class BadRequestError < Error; end
   class UnprocessableEntityError < Error; end
+  class ForbiddenError < Error; end
+  class ServiceUnavailableError < Error; end
+  class TimeoutError < Error; end
+  class PaymentRequiredError < Error; end
 end