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.



992
993
994
 
# File 'lib/platform-api/client.rb', line 992

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 privileges 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



1000
1001
1002
 
# File 'lib/platform-api/client.rb', line 1000

def create(app_id_or_app_name, body)
  @client.organization_app_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 from an organization app.

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



1008
1009
1010
 
# File 'lib/platform-api/client.rb', line 1008

def delete(app_id_or_app_name, collaborator_email_or_collaborator_id)
  @client.organization_app_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 a collaborator on an organization app.

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



1016
1017
1018
 
# File 'lib/platform-api/client.rb', line 1016

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

#list(app_id_or_app_name) ⇒ Object

List collaborators on an organization app.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1023
1024
1025
 
# File 'lib/platform-api/client.rb', line 1023

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