Class: PlatformAPI::TeamAppCollaborator
- Inherits:
-
Object
- Object
- PlatformAPI::TeamAppCollaborator
- Defined in:
- lib/platform-api/client.rb
Overview
A team collaborator represents an account that has been given access to a team app on Heroku.
Instance Method Summary collapse
-
#create(app_id_or_app_name, body = {}) ⇒ Object
Create a new collaborator on a team app.
-
#delete(app_name, collaborator_email) ⇒ Object
Delete an existing collaborator from a team app.
-
#info(app_name, collaborator_email) ⇒ Object
Info for a collaborator on a team app.
-
#initialize(client) ⇒ TeamAppCollaborator
constructor
A new instance of TeamAppCollaborator.
-
#list(app_name) ⇒ Object
List collaborators on a team app.
-
#update(app_name, collaborator_email, body = {}) ⇒ Object
Update an existing collaborator from a team app.
Constructor Details
#initialize(client) ⇒ TeamAppCollaborator
Returns a new instance of TeamAppCollaborator.
3069 3070 3071 |
# File 'lib/platform-api/client.rb', line 3069 def initialize(client) @client = client end |
Instance Method Details
#create(app_id_or_app_name, body = {}) ⇒ Object
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 according to their role in the team.
3077 3078 3079 |
# File 'lib/platform-api/client.rb', line 3077 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) ⇒ Object
Delete an existing collaborator from a team app.
3085 3086 3087 |
# File 'lib/platform-api/client.rb', line 3085 def delete(app_name, collaborator_email) @client.team_app_collaborator.delete(app_name, collaborator_email) end |
#info(app_name, collaborator_email) ⇒ Object
Info for a collaborator on a team app.
3093 3094 3095 |
# File 'lib/platform-api/client.rb', line 3093 def info(app_name, collaborator_email) @client.team_app_collaborator.info(app_name, collaborator_email) end |
#list(app_name) ⇒ Object
List collaborators on a team app.
3109 3110 3111 |
# File 'lib/platform-api/client.rb', line 3109 def list(app_name) @client.team_app_collaborator.list(app_name) end |
#update(app_name, collaborator_email, body = {}) ⇒ Object
Update an existing collaborator from a team app.
3102 3103 3104 |
# File 'lib/platform-api/client.rb', line 3102 def update(app_name, collaborator_email, body = {}) @client.team_app_collaborator.update(app_name, collaborator_email, body) end |