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

• #delete ⇒ Object

  Delete account.

• #delete_by_user(account_email_or_account_id_or_account_self) ⇒ Object
• #info ⇒ Object

  Info for account.

• #info_by_user(account_email_or_account_id_or_account_self) ⇒ Object
• #initialize(client) ⇒ Account constructor

  A new instance of Account.

• #update(body = {}) ⇒ Object
• #update_by_user(account_email_or_account_id_or_account_self, body = {}) ⇒ Object

Constructor Details

#initialize(client) ⇒ Account

Returns a new instance of Account.

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

def initialize(client)
  @client = client
end

Instance Method Details

#delete ⇒ Object

Delete account. Note that this action cannot be undone. Note: This endpoint requires the HTTP_HEROKU_PASSWORD or HTTP_HEROKU_PASSWORD_BASE64 header be set correctly for the user account.

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

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

#delete_by_user(account_email_or_account_id_or_account_self) ⇒ Object

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

def delete_by_user(account_email_or_account_id_or_account_self)
  @client.account.delete_by_user(account_email_or_account_id_or_account_self)
end

#info ⇒ Object

Info for account.

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

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

#info_by_user(account_email_or_account_id_or_account_self) ⇒ Object

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

def info_by_user(account_email_or_account_id_or_account_self)
  @client.account.info_by_user(account_email_or_account_id_or_account_self)
end

#update(body = {}) ⇒ Object

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

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

#update_by_user(account_email_or_account_id_or_account_self, body = {}) ⇒ Object

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

def update_by_user(account_email_or_account_id_or_account_self, body = {})
  @client.account.update_by_user(account_email_or_account_id_or_account_self, body)
end