Class: ElevenlabsClient::Admin::WorkspaceInvites

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WorkspaceInvites

Returns a new instance of WorkspaceInvites.



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

def initialize(client)
  @client = client
end

Instance Method Details

#delete_invite(email:) ⇒ Object

DELETE /v1/workspace/invites (with body) Delete an invitation by email



36
37
38
39
 
# File 'lib/elevenlabs_client/endpoints/admin/workspace_invites.rb', line 36

def delete_invite(email:)
  validate_email!(email)
  @client.delete_with_body("/v1/workspace/invites", { email: email })
end

#invite(email:, group_ids: nil, workspace_permission: nil) ⇒ Object

POST /v1/workspace/invites/add Invite a single user

Parameters:

  • email (String)
  • group_ids (Array<String>, nil) (defaults to: nil)
  • workspace_permission (String, nil) (defaults to: nil) 


15
16
17
18
19
20
21
 
# File 'lib/elevenlabs_client/endpoints/admin/workspace_invites.rb', line 15

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

#invite_bulk(emails:, group_ids: nil) ⇒ Object

POST /v1/workspace/invites/add-bulk Invite multiple users

Parameters:

  • emails (Array<String>)
  • group_ids (Array<String>, nil) (defaults to: nil)

Raises:

  • (ArgumentError) 


27
28
29
30
31
32
 
# File 'lib/elevenlabs_client/endpoints/admin/workspace_invites.rb', line 27

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