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.



933
934
935
 
# File 'lib/platform-api/client.rb', line 933

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



940
941
942
 
# File 'lib/platform-api/client.rb', line 940

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



947
948
949
 
# File 'lib/platform-api/client.rb', line 947

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



954
955
956
 
# File 'lib/platform-api/client.rb', line 954

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

#list ⇒ Object

List OAuth clients



959
960
961
 
# File 'lib/platform-api/client.rb', line 959

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



967
968
969
 
# File 'lib/platform-api/client.rb', line 967

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