Class: PlatformAPI::OauthClient

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

Overview

OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform. For more information please refer to the Heroku OAuth documentation.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OauthClient

Returns a new instance of OauthClient.



817
818
819
 
# File 'lib/platform-api/client.rb', line 817

def initialize(client)
  @client = client
end

Instance Method Details

#create(body) ⇒ Object

Create a new OAuth client.

Parameters:

  • body: —

    the object to pass as the request payload



824
825
826
 
# File 'lib/platform-api/client.rb', line 824

def create(body)
  @client.oauth_client.create(body)
end

#delete(oauth_client_id) ⇒ Object

Delete OAuth client.

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client



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

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

#info(oauth_client_id) ⇒ Object

Info for an OAuth client

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client



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

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

#list ⇒ Object

List OAuth clients



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

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

#update(oauth_client_id, body) ⇒ Object

Update OAuth client

Parameters:

  • oauth_client_id: —

    unique identifier of this OAuth client

  • body: —

    the object to pass as the request payload



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

def update(oauth_client_id, body)
  @client.oauth_client.update(oauth_client_id, body)
end