Class: PlatformAPI::EnterpriseAccountMember

Inherits:

Object

• Object
• PlatformAPI::EnterpriseAccountMember

Defined in:

lib/platform-api/client.rb

Overview

Enterprise account members are users with access to an enterprise account.

Instance Method Summary

• #create(enterprise_account_id_or_enterprise_account_name, body = {}) ⇒ Object

  Create a member in an enterprise account.

• #delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id) ⇒ Object

  delete a member in an enterprise account.

• #initialize(client) ⇒ EnterpriseAccountMember constructor

  A new instance of EnterpriseAccountMember.

• #list(enterprise_account_id_or_enterprise_account_name) ⇒ Object

  List members in an enterprise account.

• #update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body = {}) ⇒ Object

  Update a member in an enterprise account.

Constructor Details

#initialize(client) ⇒ EnterpriseAccountMember

Returns a new instance of EnterpriseAccountMember.

# File 'lib/platform-api/client.rb', line 1858

def initialize(client)
  @client = client
end

Instance Method Details

#create(enterprise_account_id_or_enterprise_account_name, body = {}) ⇒ Object

Create a member in an enterprise account.

Parameters:

• enterprise_account_id_or_enterprise_account_name: —

  unique identifier of the enterprise account or unique name of the enterprise account

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 1873

def create(enterprise_account_id_or_enterprise_account_name, body = {})
  @client.enterprise_account_member.create(enterprise_account_id_or_enterprise_account_name, body)
end

#delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id) ⇒ Object

delete a member in an enterprise account.

Parameters:

• enterprise_account_id_or_enterprise_account_name: —

  unique identifier of the enterprise account or unique name of the enterprise account

• account_email_or_account_id: —

  unique email address of account or unique identifier of an account

# File 'lib/platform-api/client.rb', line 1890

def delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id)
  @client.enterprise_account_member.delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id)
end

#list(enterprise_account_id_or_enterprise_account_name) ⇒ Object

List members in an enterprise account.

Parameters:

• enterprise_account_id_or_enterprise_account_name: —

  unique identifier of the enterprise account or unique name of the enterprise account

# File 'lib/platform-api/client.rb', line 1865

def list(enterprise_account_id_or_enterprise_account_name)
  @client.enterprise_account_member.list(enterprise_account_id_or_enterprise_account_name)
end

#update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body = {}) ⇒ Object

Update a member in an enterprise account.

Parameters:

• enterprise_account_id_or_enterprise_account_name: —

  unique identifier of the enterprise account or unique name of the enterprise account

• account_email_or_account_id: —

  unique email address of account or unique identifier of an account

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 1882

def update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body = {})
  @client.enterprise_account_member.update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body)
end