Class: ElevenlabsClient::Admin::WorkspaceGroups

Inherits:
Object
  • Object
show all
Defined in:
lib/elevenlabs_client/endpoints/admin/workspace_groups.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WorkspaceGroups

Returns a new instance of WorkspaceGroups.



6
7
8
 
# File 'lib/elevenlabs_client/endpoints/admin/workspace_groups.rb', line 6

def initialize(client)
  @client = client
end

Instance Method Details

#add_member(group_id:, email:) ⇒ Hash

POST /v1/workspace/groups/:group_id/members Adds a member to the specified group

Parameters:

  • group_id (String) —

    The group ID

  • email (String) —

    The member email to add

Returns:

  • (Hash) —

    { "status" => "ok" }



25
26
27
28
29
30
 
# File 'lib/elevenlabs_client/endpoints/admin/workspace_groups.rb', line 25

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

#remove_member(group_id:, email:) ⇒ Hash

POST /v1/workspace/groups/:group_id/members/remove Removes a member from the specified group

Parameters:

  • group_id (String) —

    The group ID

  • email (String) —

    The member email to remove

Returns:

  • (Hash) —

    { "status" => "ok" }



37
38
39
40
41
42
 
# File 'lib/elevenlabs_client/endpoints/admin/workspace_groups.rb', line 37

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

#search(name:) ⇒ Array<Hash>

GET /v1/workspace/groups/search Searches for user groups in the workspace by name

Parameters:

  • name (String) —

    Group name to search

Returns:

  • (Array<Hash>) —

    List of matching groups

Raises:

  • (ArgumentError) 


14
15
16
17
18
 
# File 'lib/elevenlabs_client/endpoints/admin/workspace_groups.rb', line 14

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