Class: PlatformAPI::OrganizationAppCollaborator

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

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OrganizationAppCollaborator

Returns a new instance of OrganizationAppCollaborator.


1694
1695
1696
# File 'lib/platform-api/client.rb', line 1694

def initialize(client)
  @client = client
end

Instance Method Details

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

Create a new collaborator on an organization app. Use this endpoint instead of the /apps/{app_id_or_name}/collaborator endpoint when you want the collaborator to be granted permissions according to their role in the organization.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • body:

    the object to pass as the request payload


1702
1703
1704
# File 'lib/platform-api/client.rb', line 1702

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

#delete(app_name, collaborator_email) ⇒ Object

Delete an existing collaborator from an organization app.

Parameters:

  • app_name:

    unique name of app

  • collaborator_email:

    invited email address of collaborator


1710
1711
1712
# File 'lib/platform-api/client.rb', line 1710

def delete(app_name, collaborator_email)
  @client.organization_app_collaborator.delete(app_name, collaborator_email)
end

#info(app_name, collaborator_email) ⇒ Object

Info for a collaborator on an organization app.

Parameters:

  • app_name:

    unique name of app

  • collaborator_email:

    invited email address of collaborator


1718
1719
1720
# File 'lib/platform-api/client.rb', line 1718

def info(app_name, collaborator_email)
  @client.organization_app_collaborator.info(app_name, collaborator_email)
end

#list(app_name) ⇒ Object

List collaborators on an organization app.

Parameters:

  • app_name:

    unique name of app


1733
1734
1735
# File 'lib/platform-api/client.rb', line 1733

def list(app_name)
  @client.organization_app_collaborator.list(app_name)
end

#update(app_name, collaborator_email) ⇒ Object

Update an existing collaborator from an organization app.

Parameters:

  • app_name:

    unique name of app

  • collaborator_email:

    invited email address of collaborator


1726
1727
1728
# File 'lib/platform-api/client.rb', line 1726

def update(app_name, collaborator_email)
  @client.organization_app_collaborator.update(app_name, collaborator_email)
end