OpsGenie REST API

v0.1.1

OpsGenie REST API

OpsGenie REST API v0.1.1 OpsGenieRESTAPI.Api.Team

API calls for all endpoints tagged Team.

Link to this section Summary

Functions

create_team(connection, body, opts \\ [])

Create Team Creates a new team

delete_team(connection, identifier, opts \\ [])

Delete Team Delete team with given id or name

get_team(connection, identifier, opts \\ [])

Get Team Returns team with given 'id' or 'name'

list_team_logs(connection, identifier, opts \\ [])

List Team Logs Return logs of a team given with identifier

list_teams(connection, opts \\ [])

List Teams Return list of teams

update_team(connection, identifier, opts \\ [])

Update Team (Partial) Update team with given id

Link to this section Functions

Link to this function create_team(connection, body, opts \\ []) 
create_team(
  Tesla.Env.client(),
  OpsGenieRESTAPI.Model.CreateTeamPayload.t(),
  keyword()
) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Create Team Creates a new team

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (CreateTeamPayload): Request payload of created team
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function delete_team(connection, identifier, opts \\ []) 
delete_team(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Delete Team Delete team with given id or name

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team

  • opts (KeywordList): [optional] Optional parameters

    • :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

Link to this function get_team(connection, identifier, opts \\ []) 
get_team(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.GetTeamResponse.t()} | {:error, Tesla.Env.t()}

Get Team Returns team with given 'id' or 'name'

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team

  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Returns

{:ok, %OpsGenieRESTAPI.Model.GetTeamResponse{}} on success {:error, info} on failure

Link to this function list_team_logs(connection, identifier, opts \\ []) 
list_team_logs(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.ListTeamLogsResponse.t()}
  | {:error, Tesla.Env.t()}

List Team Logs Return logs of a team given with identifier

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team

  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'
    • :limit (integer()): Maximum number of items to provide in the result. Must be a positive integer value.
    • :order (String.t): Sorting order of the result set
    • :offset (String.t): Key which will be used in pagination

Returns

{:ok, %OpsGenieRESTAPI.Model.ListTeamLogsResponse{}} on success {:error, info} on failure

Link to this function list_teams(connection, opts \\ []) 
list_teams(Tesla.Env.client(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.ListTeamsResponse.t()} | {:error, Tesla.Env.t()}

List Teams Return list of teams

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.ListTeamsResponse{}} on success {:error, info} on failure

Link to this function update_team(connection, identifier, opts \\ []) 
update_team(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Update Team (Partial) Update team with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team

  • opts (KeywordList): [optional] Optional parameters

    • :body (UpdateTeamPayload): Request payload of update team action

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure