OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.TeamRole
API calls for all endpoints tagged TeamRole
.
Link to this section Summary
Functions
Create Team Role Creates a new team role
Delete Team Role Deletes a team role using team role 'id' or 'name'
Get Team Role Returns team role with given 'id' or 'name'
List Team Roles Returns list of team roles
Update Team Role (Partial) Updates the team role using team role 'id' or 'name'
Link to this section Functions
create_team_role( Tesla.Env.client(), String.t(), OpsGenieRESTAPI.Model.CreateTeamRolePayload.t(), keyword() ) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Create Team Role Creates a new team role
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the team
- body (CreateTeamRolePayload): Request payload of created team role
opts (KeywordList): [optional] Optional parameters
- :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure
delete_team_role(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Delete Team Role Deletes a team role using team role 'id' or 'name'
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the team
- team_role_identifier (String.t): Identifier of team role which could be team role 'id' or 'name'
opts (KeywordList): [optional] Optional parameters
- :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'
- :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure
get_team_role(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.GetTeamRoleResponse.t()} | {:error, Tesla.Env.t()}
Get Team Role Returns team role with given 'id' or 'name'
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the team
- team_role_identifier (String.t): Identifier of team role which could be team role 'id' or 'name'
opts (KeywordList): [optional] Optional parameters
- :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'
- :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'
Returns
{:ok, %OpsGenieRESTAPI.Model.GetTeamRoleResponse{}} on success {:error, info} on failure
list_team_roles(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.ListTeamRoleResponse.t()} | {:error, Tesla.Env.t()}
List Team Roles Returns list of team roles
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the team
opts (KeywordList): [optional] Optional parameters
- :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'
Returns
{:ok, %OpsGenieRESTAPI.Model.ListTeamRoleResponse{}} on success {:error, info} on failure
update_team_role(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Update Team Role (Partial) Updates the team role using team role 'id' or 'name'
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the team
- team_role_identifier (String.t): Identifier of team role which could be team role 'id' or 'name'
opts (KeywordList): [optional] Optional parameters
- :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'
- :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'
- :body (UpdateTeamRolePayload): Request payload of update team role
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure