Class: PlatformAPI::Collaborator

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

Overview

A collaborator represents an account that has been given access to an app on Heroku.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Collaborator

Returns a new instance of Collaborator.



1586
1587
1588
# File 'lib/platform-api/client.rb', line 1586

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body = {}) ⇒ Object

Create a new collaborator.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • body:

    the object to pass as the request payload



1594
1595
1596
# File 'lib/platform-api/client.rb', line 1594

def create(app_id_or_app_name, body = {})
  @client.collaborator.create(app_id_or_app_name, body)
end

#delete(app_id_or_app_name, collaborator_email_or_collaborator_id) ⇒ Object

Delete an existing collaborator.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • collaborator_email_or_collaborator_id:

    invited email address of collaborator or unique identifier of collaborator



1602
1603
1604
# File 'lib/platform-api/client.rb', line 1602

def delete(app_id_or_app_name, collaborator_email_or_collaborator_id)
  @client.collaborator.delete(app_id_or_app_name, collaborator_email_or_collaborator_id)
end

#info(app_id_or_app_name, collaborator_email_or_collaborator_id) ⇒ Object

Info for existing collaborator.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • collaborator_email_or_collaborator_id:

    invited email address of collaborator or unique identifier of collaborator



1610
1611
1612
# File 'lib/platform-api/client.rb', line 1610

def info(app_id_or_app_name, collaborator_email_or_collaborator_id)
  @client.collaborator.info(app_id_or_app_name, collaborator_email_or_collaborator_id)
end

#list(app_id_or_app_name) ⇒ Object

List existing collaborators.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app



1617
1618
1619
# File 'lib/platform-api/client.rb', line 1617

def list(app_id_or_app_name)
  @client.collaborator.list(app_id_or_app_name)
end