Class: PlatformAPI::EnterpriseAccountMember

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ EnterpriseAccountMember

Returns a new instance of EnterpriseAccountMember.



1807
1808
1809
# File 'lib/platform-api/client.rb', line 1807

def initialize(client)
  @client = client
end

Instance Method Details

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

Create a member in an enterprise account.

Parameters:

  • enterprise_account_id:

    unique identifier of the enterprise account

  • body:

    the object to pass as the request payload



1822
1823
1824
# File 'lib/platform-api/client.rb', line 1822

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

#delete(enterprise_account_id, account_email_or_account_id) ⇒ Object

delete a member in an enterprise account.

Parameters:

  • enterprise_account_id:

    unique identifier of the enterprise account

  • account_email_or_account_id:

    unique email address of account or unique identifier of an account



1839
1840
1841
# File 'lib/platform-api/client.rb', line 1839

def delete(, )
  @client..delete(, )
end

#list(enterprise_account_id) ⇒ Object

List members in an enterprise account.

Parameters:

  • enterprise_account_id:

    unique identifier of the enterprise account



1814
1815
1816
# File 'lib/platform-api/client.rb', line 1814

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

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

Update a member in an enterprise account.

Parameters:

  • enterprise_account_id:

    unique identifier 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



1831
1832
1833
# File 'lib/platform-api/client.rb', line 1831

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