class PlatformAPI::Collaborator
A collaborator represents an account that has been given access to an app on Heroku.
Public Class Methods
# File lib/platform-api/client.rb, line 1586 def initialize(client) @client = client end
Public Instance Methods
Create a new collaborator.
@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload
# 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 an existing collaborator.
@param app_id_or_app_name: unique identifier of app or unique name of app @param collaborator_email_or_collaborator_id: invited email address of collaborator or unique identifier of collaborator
# 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 for existing collaborator.
@param app_id_or_app_name: unique identifier of app or unique name of app @param collaborator_email_or_collaborator_id: invited email address of collaborator or unique identifier of collaborator
# 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 existing collaborators.
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 1617 def list(app_id_or_app_name) @client.collaborator.list(app_id_or_app_name) end