elevenlabs_client 0.7.0 → 0.8.0

data/lib/elevenlabs_client/endpoints/admin/service_account_api_keys.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Admin
+    class ServiceAccountApiKeys
+        def initialize(client)
+          @client = client
+        end
+
+        # GET /v1/service-accounts/{service_account_user_id}/api-keys
+        # Get all API keys for a service account
+        # Documentation: https://elevenlabs.io/docs/api-reference/service-accounts/api-keys/list
+        #
+        # @param service_account_user_id [String] The service account user ID
+        # @return [Hash] JSON response containing list of API keys
+        def list(service_account_user_id)
+          endpoint = "/v1/service-accounts/#{service_account_user_id}/api-keys"
+          @client.get(endpoint)
+        end
+
+        # POST /v1/service-accounts/{service_account_user_id}/api-keys
+        # Create a new API key for a service account
+        # Documentation: https://elevenlabs.io/docs/api-reference/service-accounts/api-keys/create
+        #
+        # @param service_account_user_id [String] The service account user ID
+        # @param name [String] The name of the API key
+        # @param permissions [Array<String>, String] The permissions for the API key or "all"
+        # @param options [Hash] Optional parameters
+        # @option options [Integer, nil] :character_limit Monthly character limit for the API key
+        # @return [Hash] JSON response containing the new API key
+        def create(service_account_user_id, name:, permissions:, **options)
+          endpoint = "/v1/service-accounts/#{service_account_user_id}/api-keys"
+          request_body = {
+            name: name,
+            permissions: permissions
+          }.merge(options)
+
+          @client.post(endpoint, request_body)
+        end
+
+        # PATCH /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}
+        # Update an existing API key for a service account
+        # Documentation: https://elevenlabs.io/docs/api-reference/service-accounts/api-keys/update
+        #
+        # @param service_account_user_id [String] The service account user ID
+        # @param api_key_id [String] The API key ID
+        # @param is_enabled [Boolean] Whether to enable or disable the API key
+        # @param name [String] The name of the API key
+        # @param permissions [Array<String>, String] The permissions for the API key or "all"
+        # @param options [Hash] Optional parameters
+        # @option options [Integer, nil] :character_limit Monthly character limit for the API key
+        # @return [Hash] JSON response with update confirmation
+        def update(service_account_user_id, api_key_id, is_enabled:, name:, permissions:, **options)
+          endpoint = "/v1/service-accounts/#{service_account_user_id}/api-keys/#{api_key_id}"
+          request_body = {
+            is_enabled: is_enabled,
+            name: name,
+            permissions: permissions
+          }.merge(options)
+
+          @client.patch(endpoint, request_body)
+        end
+
+        # DELETE /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}
+        # Delete an existing API key for a service account
+        # Documentation: https://elevenlabs.io/docs/api-reference/service-accounts/api-keys/delete
+        #
+        # @param service_account_user_id [String] The service account user ID
+        # @param api_key_id [String] The API key ID
+        # @return [Hash] JSON response with deletion confirmation
+        def delete(service_account_user_id, api_key_id)
+          endpoint = "/v1/service-accounts/#{service_account_user_id}/api-keys/#{api_key_id}"
+          @client.delete(endpoint)
+        end
+    end
+  end
+end

data/lib/elevenlabs_client/endpoints/admin/user.rb

@@ -20,6 +20,18 @@ module ElevenlabsClient
       alias_method :user, :get_user
       alias_method :info, :get_user
 
+      # GET /v1/user/subscription
+      # Gets extended information about the user's subscription
+      # Documentation: https://elevenlabs.io/docs/api-reference/user/get-user-subscription
+      #
+      # @return [Hash] The JSON response containing subscription info
+      def get_subscription
+        endpoint = "/v1/user/subscription"
+        @client.get(endpoint)
+      end
+
+      alias_method :subscription, :get_subscription
+
       private
 
       attr_reader :client

data/lib/elevenlabs_client/endpoints/admin/workspace_groups.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Admin
+    class WorkspaceGroups
+      def initialize(client)
+        @client = client
+      end
+
+      # GET /v1/workspace/groups/search
+      # Searches for user groups in the workspace by name
+      # @param name [String] Group name to search
+      # @return [Array<Hash>] List of matching groups
+      def search(name:)
+        raise ArgumentError, "name is required" if name.nil? || name.to_s.strip.empty?
+
+        @client.get("/v1/workspace/groups/search", { name: name })
+      end
+
+      # POST /v1/workspace/groups/:group_id/members
+      # Adds a member to the specified group
+      # @param group_id [String] The group ID
+      # @param email [String] The member email to add
+      # @return [Hash] { "status" => "ok" }
+      def add_member(group_id:, email:)
+        validate_group_and_email!(group_id, email)
+
+        endpoint = "/v1/workspace/groups/#{group_id}/members"
+        @client.post(endpoint, { email: email })
+      end
+
+      # POST /v1/workspace/groups/:group_id/members/remove
+      # Removes a member from the specified group
+      # @param group_id [String] The group ID
+      # @param email [String] The member email to remove
+      # @return [Hash] { "status" => "ok" }
+      def remove_member(group_id:, email:)
+        validate_group_and_email!(group_id, email)
+
+        endpoint = "/v1/workspace/groups/#{group_id}/members/remove"
+        @client.post(endpoint, { email: email })
+      end
+
+      private
+
+      attr_reader :client
+
+      def validate_group_and_email!(group_id, email)
+        raise ArgumentError, "group_id is required" if group_id.nil? || group_id.to_s.strip.empty?
+        raise ArgumentError, "email is required" if email.nil? || email.to_s.strip.empty?
+      end
+    end
+  end
+end
+
+

data/lib/elevenlabs_client/endpoints/admin/workspace_invites.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Admin
+    class WorkspaceInvites
+      def initialize(client)
+        @client = client
+      end
+
+      # POST /v1/workspace/invites/add
+      # Invite a single user
+      # @param email [String]
+      # @param group_ids [Array<String>, nil]
+      # @param workspace_permission [String, nil]
+      def invite(email:, group_ids: nil, workspace_permission: nil)
+        validate_email!(email)
+        body = { email: email }
+        body[:group_ids] = group_ids if group_ids
+        body[:workspace_permission] = workspace_permission if workspace_permission
+        @client.post("/v1/workspace/invites/add", body)
+      end
+
+      # POST /v1/workspace/invites/add-bulk
+      # Invite multiple users
+      # @param emails [Array<String>]
+      # @param group_ids [Array<String>, nil]
+      def invite_bulk(emails:, group_ids: nil)
+        raise ArgumentError, "emails must be a non-empty Array" unless emails.is_a?(Array) && !emails.empty?
+        body = { emails: emails }
+        body[:group_ids] = group_ids if group_ids
+        @client.post("/v1/workspace/invites/add-bulk", body)
+      end
+
+      # DELETE /v1/workspace/invites (with body)
+      # Delete an invitation by email
+      def delete_invite(email:)
+        validate_email!(email)
+        @client.delete_with_body("/v1/workspace/invites", { email: email })
+      end
+
+      private
+
+      attr_reader :client
+
+      def validate_email!(email)
+        raise ArgumentError, "email is required" if email.nil? || email.to_s.strip.empty?
+      end
+    end
+  end
+end
+
+

data/lib/elevenlabs_client/endpoints/admin/workspace_members.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Admin
+    class WorkspaceMembers
+      def initialize(client)
+        @client = client
+      end
+
+      # POST /v1/workspace/members
+      # Updates attributes of a workspace member
+      # Required: email
+      # Optional: is_locked, workspace_role
+      def update_member(email:, is_locked: nil, workspace_role: nil)
+        raise ArgumentError, "email is required" if email.nil? || email.to_s.strip.empty?
+        body = { email: email }
+        body[:is_locked] = is_locked unless is_locked.nil?
+        body[:workspace_role] = workspace_role if workspace_role
+        @client.post("/v1/workspace/members", body)
+      end
+
+      alias_method :update, :update_member
+
+      private
+
+      attr_reader :client
+    end
+  end
+end
+
+

data/lib/elevenlabs_client/endpoints/admin/workspace_resources.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Admin
+    class WorkspaceResources
+      def initialize(client)
+        @client = client
+      end
+
+      # GET /v1/workspace/resources/:resource_id
+      # params: resource_type (required)
+      def get_resource(resource_id:, resource_type:)
+        raise ArgumentError, "resource_id is required" if resource_id.nil? || resource_id.to_s.strip.empty?
+        raise ArgumentError, "resource_type is required" if resource_type.nil? || resource_type.to_s.strip.empty?
+        @client.get("/v1/workspace/resources/#{resource_id}", { resource_type: resource_type })
+      end
+
+      # POST /v1/workspace/resources/:resource_id/share
+      # body: role (required), resource_type (required), optional: user_email, group_id, workspace_api_key_id
+      def share(resource_id:, role:, resource_type:, user_email: nil, group_id: nil, workspace_api_key_id: nil)
+        validate_resource!(resource_id, resource_type)
+        raise ArgumentError, "role is required" if role.nil? || role.to_s.strip.empty?
+        body = { role: role, resource_type: resource_type }
+        body[:user_email] = user_email if user_email
+        body[:group_id] = group_id if group_id
+        body[:workspace_api_key_id] = workspace_api_key_id if workspace_api_key_id
+        @client.post("/v1/workspace/resources/#{resource_id}/share", body)
+      end
+
+      # POST /v1/workspace/resources/:resource_id/unshare
+      # body: resource_type (required), optional: user_email, group_id, workspace_api_key_id
+      def unshare(resource_id:, resource_type:, user_email: nil, group_id: nil, workspace_api_key_id: nil)
+        validate_resource!(resource_id, resource_type)
+        body = { resource_type: resource_type }
+        body[:user_email] = user_email if user_email
+        body[:group_id] = group_id if group_id
+        body[:workspace_api_key_id] = workspace_api_key_id if workspace_api_key_id
+        @client.post("/v1/workspace/resources/#{resource_id}/unshare", body)
+      end
+
+      private
+
+      attr_reader :client
+
+      def validate_resource!(resource_id, resource_type)
+        raise ArgumentError, "resource_id is required" if resource_id.nil? || resource_id.to_s.strip.empty?
+        raise ArgumentError, "resource_type is required" if resource_type.nil? || resource_type.to_s.strip.empty?
+      end
+    end
+  end
+end
+
+

data/lib/elevenlabs_client/endpoints/admin/workspace_webhooks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Admin
+    class WorkspaceWebhooks
+        def initialize(client)
+          @client = client
+        end
+
+        # GET /v1/workspace/webhooks
+        # List all webhooks for a workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/workspace/webhooks/list
+        #
+        # @param options [Hash] Optional parameters
+        # @option options [Boolean] :include_usages Whether to include active usages of the webhook (admin only)
+        # @return [Hash] JSON response containing list of webhooks
+        def list(**options)
+          endpoint = "/v1/workspace/webhooks"
+          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

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

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class Agents
+        def initialize(client)
+          @client = client
+        end
+
+        # POST /v1/convai/agents/create
+        # Create an agent from a config object
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/create
+        #
+        # @param options [Hash] Agent creation parameters
+        # @option options [Hash] :conversation_config Required conversation configuration for an agent
+        # @option options [Hash] :platform_settings Optional platform settings for the agent
+        # @option options [String] :name Optional name to make the agent easier to find
+        # @option options [Array<String>] :tags Optional tags to help classify and filter the agent
+        # @return [Hash] JSON response containing agent_id
+        def create(**options)
+          endpoint = "/v1/convai/agents/create"
+          request_body = options
+          @client.post(endpoint, request_body)
+        end
+
+        # GET /v1/convai/agents/{agent_id}
+        # Retrieve config for an agent
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/get
+        #
+        # @param agent_id [String] The id of an agent
+        # @return [Hash] Agent configuration and metadata
+        def get(agent_id)
+          endpoint = "/v1/convai/agents/#{agent_id}"
+          @client.get(endpoint)
+        end
+
+        # GET /v1/convai/agents
+        # Returns a list of your agents and their metadata
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/list
+        #
+        # @param options [Hash] Query parameters
+        # @option options [Integer] :page_size How many agents to return at maximum (1-100, default: 30)
+        # @option options [String] :search Search by agents name
+        # @option options [String] :sort_direction The direction to sort the results ("asc" or "desc")
+        # @option options [String] :sort_by The field to sort the results by ("name" or "created_at")
+        # @option options [String] :cursor Used for fetching next page
+        # @return [Hash] List of agents with pagination info
+        def list(**options)
+          endpoint = "/v1/convai/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
+
+        # PATCH /v1/convai/agents/{agent_id}
+        # Patches an Agent settings
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/update
+        #
+        # @param agent_id [String] The id of an agent
+        # @param options [Hash] Agent update parameters
+        # @option options [Hash] :conversation_config Optional conversation configuration for an agent
+        # @option options [Hash] :platform_settings Optional platform settings for the agent
+        # @option options [String] :name Optional name to make the agent easier to find
+        # @option options [Array<String>] :tags Optional tags to help classify and filter the agent
+        # @return [Hash] Updated agent configuration and metadata
+        def update(agent_id, **options)
+          endpoint = "/v1/convai/agents/#{agent_id}"
+          request_body = options.compact
+          @client.patch(endpoint, request_body)
+        end
+
+        # DELETE /v1/convai/agents/{agent_id}
+        # Delete an agent
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/delete
+        #
+        # @param agent_id [String] The id of an agent
+        # @return [Hash] Empty response on success
+        def delete(agent_id)
+          endpoint = "/v1/convai/agents/#{agent_id}"
+          @client.delete(endpoint)
+        end
+
+        # POST /v1/convai/agents/{agent_id}/duplicate
+        # Create a new agent by duplicating an existing one
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/duplicate
+        #
+        # @param agent_id [String] The id of an agent to duplicate
+        # @param options [Hash] Duplication parameters
+        # @option options [String] :name Optional name to make the agent easier to find
+        # @return [Hash] JSON response containing new agent_id
+        def duplicate(agent_id, **options)
+          endpoint = "/v1/convai/agents/#{agent_id}/duplicate"
+          request_body = options.compact
+          @client.post(endpoint, request_body)
+        end
+
+        # GET /v1/convai/agents/{agent_id}/link
+        # Get the current link used to share the agent with others
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/link
+        #
+        # @param agent_id [String] The id of an agent
+        # @return [Hash] Agent link information including token data
+        def link(agent_id)
+          endpoint = "/v1/convai/agents/#{agent_id}/link"
+          @client.get(endpoint)
+        end
+
+        # POST /v1/convai/agents/{agent_id}/simulate-conversation
+        # Run a conversation between the agent and a simulated user
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/simulate-conversation
+        #
+        # @param agent_id [String] The id of an agent
+        # @param options [Hash] Simulation parameters
+        # @option options [Hash] :simulation_specification Required specification detailing how the conversation should be simulated
+        # @option options [Array<Hash>] :extra_evaluation_criteria Optional list of evaluation criteria to test
+        # @option options [Integer] :new_turns_limit Optional maximum number of new turns to generate (default: 10000)
+        # @return [Hash] Simulated conversation and analysis
+        def simulate_conversation(agent_id, **options)
+          endpoint = "/v1/convai/agents/#{agent_id}/simulate-conversation"
+          request_body = options
+          @client.post(endpoint, request_body)
+        end
+
+        # POST /v1/convai/agents/{agent_id}/simulate-conversation/stream
+        # Run a conversation between the agent and a simulated user and stream back the response
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/simulate-conversation-stream
+        #
+        # @param agent_id [String] The id of an agent
+        # @param options [Hash] Simulation parameters
+        # @option options [Hash] :simulation_specification Required specification detailing how the conversation should be simulated
+        # @option options [Array<Hash>] :extra_evaluation_criteria Optional list of evaluation criteria to test
+        # @option options [Integer] :new_turns_limit Optional maximum number of new turns to generate (default: 10000)
+        # @param block [Proc] Block to handle streaming response chunks
+        # @return [Enumerator] Streaming response enumerator if no block given
+        def simulate_conversation_stream(agent_id, **options, &block)
+          endpoint = "/v1/convai/agents/#{agent_id}/simulate-conversation/stream"
+          request_body = options
+          @client.post_streaming(endpoint, request_body, &block)
+        end
+
+        # POST /v1/convai/agent/{agent_id}/llm-usage/calculate
+        # Calculates expected number of LLM tokens needed for the specified agent
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/agents/calculate-llm-usage
+        #
+        # @param agent_id [String] The id of an agent
+        # @param options [Hash] Calculation parameters
+        # @option options [Integer] :prompt_length Optional length of the prompt in characters
+        # @option options [Integer] :number_of_pages Optional pages of content in pdf documents OR urls in agent's Knowledge Base
+        # @option options [Boolean] :rag_enabled Optional whether RAG is enabled
+        # @return [Hash] LLM usage pricing information
+        def calculate_llm_usage(agent_id, **options)
+          endpoint = "/v1/convai/agent/#{agent_id}/llm-usage/calculate"
+          request_body = options.compact
+          @client.post(endpoint, request_body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ElevenlabsClient
+  module Endpoints
+    module AgentsPlatform
+      class BatchCalling
+        def initialize(client)
+          @client = client
+        end
+
+        # POST /v1/convai/batch-calling/submit
+        # Submit a batch call request to schedule calls for multiple recipients
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/batch-calling/submit
+        #
+        # @param call_name [String] Name for the batch call job
+        # @param agent_id [String] The agent ID to use for all calls
+        # @param agent_phone_number_id [String] The phone number ID to call from
+        # @param scheduled_time_unix [Integer] Unix timestamp for when to schedule the calls
+        # @param recipients [Array<Hash>] Array of recipient objects with phone numbers
+        # @return [Hash] JSON response containing batch call job details
+        def submit(call_name:, agent_id:, agent_phone_number_id:, scheduled_time_unix:, recipients:)
+          endpoint = "/v1/convai/batch-calling/submit"
+          request_body = {
+            call_name: call_name,
+            agent_id: agent_id,
+            agent_phone_number_id: agent_phone_number_id,
+            scheduled_time_unix: scheduled_time_unix,
+            recipients: recipients
+          }
+          
+          @client.post(endpoint, request_body)
+        end
+
+        # GET /v1/convai/batch-calling/workspace
+        # Get all batch calls for the current workspace
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/batch-calling/list
+        #
+        # @param options [Hash] Optional parameters
+        # @option options [Integer] :limit Maximum number of results to return (default: 100)
+        # @option options [String] :last_doc Last document ID for pagination
+        # @return [Hash] JSON response containing batch calls list with pagination info
+        def list(**options)
+          endpoint = "/v1/convai/batch-calling/workspace"
+          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/batch-calling/{batch_id}
+        # Get detailed information about a batch call including all recipients
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/batch-calling/get
+        #
+        # @param batch_id [String] The ID of the batch call job
+        # @return [Hash] JSON response containing detailed batch call information including recipients
+        def get(batch_id)
+          endpoint = "/v1/convai/batch-calling/#{batch_id}"
+          @client.get(endpoint)
+        end
+
+        # POST /v1/convai/batch-calling/{batch_id}/cancel
+        # Cancel a running batch call and set all recipients to cancelled status
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/batch-calling/cancel
+        #
+        # @param batch_id [String] The ID of the batch call job to cancel
+        # @return [Hash] JSON response containing updated batch call information
+        def cancel(batch_id)
+          endpoint = "/v1/convai/batch-calling/#{batch_id}/cancel"
+          @client.post(endpoint, {})
+        end
+
+        # POST /v1/convai/batch-calling/{batch_id}/retry
+        # Retry a batch call, calling failed and no-response recipients again
+        # Documentation: https://elevenlabs.io/docs/api-reference/convai/batch-calling/retry
+        #
+        # @param batch_id [String] The ID of the batch call job to retry
+        # @return [Hash] JSON response containing updated batch call information
+        def retry(batch_id)
+          endpoint = "/v1/convai/batch-calling/#{batch_id}/retry"
+          @client.post(endpoint, {})
+        end
+      end
+    end
+  end
+end