Class: PlatformAPI::OrganizationAppCollaborator
- Inherits:
-
Object
- Object
- PlatformAPI::OrganizationAppCollaborator
- Defined in:
- lib/platform-api/client.rb
Overview
Deprecated: An organization collaborator represents an account that has been given access to an organization app on Heroku.
Instance Method Summary collapse
-
#create(app_id_or_app_name, body = {}) ⇒ Object
Create a new collaborator on an organization app.
-
#delete(app_name, collaborator_email) ⇒ Object
Delete an existing collaborator from an organization app.
-
#info(app_name, collaborator_email) ⇒ Object
Info for a collaborator on an organization app.
-
#initialize(client) ⇒ OrganizationAppCollaborator
constructor
A new instance of OrganizationAppCollaborator.
-
#list(app_name) ⇒ Object
List collaborators on an organization app.
-
#update(app_name, collaborator_email, body = {}) ⇒ Object
Update an existing collaborator from an organization app.
Constructor Details
#initialize(client) ⇒ OrganizationAppCollaborator
Returns a new instance of OrganizationAppCollaborator.
2078 2079 2080 |
# File 'lib/platform-api/client.rb', line 2078 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.
2086 2087 2088 |
# File 'lib/platform-api/client.rb', line 2086 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.
2094 2095 2096 |
# File 'lib/platform-api/client.rb', line 2094 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.
2102 2103 2104 |
# File 'lib/platform-api/client.rb', line 2102 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.
2118 2119 2120 |
# File 'lib/platform-api/client.rb', line 2118 def list(app_name) @client.organization_app_collaborator.list(app_name) end |
#update(app_name, collaborator_email, body = {}) ⇒ Object
Update an existing collaborator from an organization app.
2111 2112 2113 |
# File 'lib/platform-api/client.rb', line 2111 def update(app_name, collaborator_email, body = {}) @client.organization_app_collaborator.update(app_name, collaborator_email, body) end |