Class: PlatformAPI::Account

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

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Account

Returns a new instance of Account.



826
827
828
# File 'lib/platform-api/client.rb', line 826

def initialize(client)
  @client = client
end

Instance Method Details

#deleteObject

Delete account. Note that this action cannot be undone.



843
844
845
# File 'lib/platform-api/client.rb', line 843

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

#delete_by_user(account_email_or_account_id_or_account_self) ⇒ Object

Delete account. Note that this action cannot be undone.

Parameters:

  • account_email_or_account_id_or_account_self:

    unique email address of account or unique identifier of an account or Implicit reference to currently authorized user



865
866
867
# File 'lib/platform-api/client.rb', line 865

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

#infoObject

Info for account.



831
832
833
# File 'lib/platform-api/client.rb', line 831

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

#info_by_user(account_email_or_account_id_or_account_self) ⇒ Object

Info for account.

Parameters:

  • account_email_or_account_id_or_account_self:

    unique email address of account or unique identifier of an account or Implicit reference to currently authorized user



850
851
852
# File 'lib/platform-api/client.rb', line 850

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

#update(body = {}) ⇒ Object

Update account.

Parameters:

  • body:

    the object to pass as the request payload



838
839
840
# File 'lib/platform-api/client.rb', line 838

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

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

Update account.

Parameters:

  • account_email_or_account_id_or_account_self:

    unique email address of account or unique identifier of an account or Implicit reference to currently authorized user

  • body:

    the object to pass as the request payload



858
859
860
# File 'lib/platform-api/client.rb', line 858

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