Class: PlatformAPI::Account

Inherits:

Object

• Object
• PlatformAPI::Account

Defined in:

lib/platform-api/client.rb

Overview

An account represents an individual signed up to use the Heroku platform.

Instance Method Summary

• #change_email(account_email_or_account_id, body) ⇒ Object

  Change Email for account.

• #change_password(account_email_or_account_id, body) ⇒ Object

  Change Password for account.

• #delete(account_email_or_account_id) ⇒ Object

  Delete account.

• #info(account_email_or_account_id) ⇒ Object

  Info for account.

• #initialize(client) ⇒ Account constructor

  A new instance of Account.

• #update(account_email_or_account_id, body) ⇒ Object

  Update account.

Constructor Details

#initialize(client) ⇒ Account

Returns a new instance of Account.

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

def initialize(client)
  @client = client
end

Instance Method Details

#change_email(account_email_or_account_id, body) ⇒ Object

Change Email for account.

Parameters:

• 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 1681

def change_email(account_email_or_account_id, body)
  @client.account.change_email(account_email_or_account_id, body)
end

#change_password(account_email_or_account_id, body) ⇒ Object

Change Password for account.

Parameters:

• 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 1689

def change_password(account_email_or_account_id, body)
  @client.account.change_password(account_email_or_account_id, body)
end

#delete(account_email_or_account_id) ⇒ Object

Delete account. Note that this action cannot be undone.

Parameters:

• account_email_or_account_id: —

  unique email address of account or unique identifier of an account

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

def delete(account_email_or_account_id)
  @client.account.delete(account_email_or_account_id)
end

#info(account_email_or_account_id) ⇒ Object

Info for account.

Parameters:

• account_email_or_account_id: —

  unique email address of account or unique identifier of an account

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

def info(account_email_or_account_id)
  @client.account.info(account_email_or_account_id)
end

#update(account_email_or_account_id, body) ⇒ Object

Update account.

Parameters:

• 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 1673

def update(account_email_or_account_id, body)
  @client.account.update(account_email_or_account_id, body)
end