class PlatformAPI::TeamAppCollaborator

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

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 3123
def initialize(client)
  @client = client
end

Public Instance Methods

create(app_id_or_app_name, body = {}) click to toggle source

Create a new collaborator on a team app. Use this endpoint instead of the `/apps/{app_id_or_name}/collaborator` endpoint when you want the collaborator to be granted [permissions] (devcenter.heroku.com/articles/org-users-access#roles-and-permissions) according to their role in the team.

@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 3131
def create(app_id_or_app_name, body = {})
  @client.team_app_collaborator.create(app_id_or_app_name, body)
end
delete(app_name, collaborator_email) click to toggle source

Delete an existing collaborator from a team app.

@param app_name: unique name of app @param collaborator_email: invited email address of collaborator

# File lib/platform-api/client.rb, line 3139
def delete(app_name, collaborator_email)
  @client.team_app_collaborator.delete(app_name, collaborator_email)
end
info(app_name, collaborator_email) click to toggle source

Info for a collaborator on a team app.

@param app_name: unique name of app @param collaborator_email: invited email address of collaborator

# File lib/platform-api/client.rb, line 3147
def info(app_name, collaborator_email)
  @client.team_app_collaborator.info(app_name, collaborator_email)
end
list(app_name) click to toggle source

List collaborators on a team app.

@param app_name: unique name of app

# File lib/platform-api/client.rb, line 3163
def list(app_name)
  @client.team_app_collaborator.list(app_name)
end
update(app_name, collaborator_email, body = {}) click to toggle source

Update an existing collaborator from a team app.

@param app_name: unique name of app @param collaborator_email: invited email address of collaborator @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 3156
def update(app_name, collaborator_email, body = {})
  @client.team_app_collaborator.update(app_name, collaborator_email, body)
end