OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.NotificationRule

API calls for all endpoints tagged NotificationRule.

Link to this section Summary

Functions

Change order of Notification Rule Changes order of a notification rule with given notification rule id

Create Notification Rule Creates a new notification rule

Delete Notification Rule Deletes a notification rule with given notification rule id

Disable Notification Rule Disables a notification rule with given notification rule id

Enable Notification Rule Enables a notification rule with given notification rule id

Get Notification Rule Returns notification rule with given id

List Notification Rules Returns list of notification rules

Update Notification Rule (Partial) Updates the notification rule with given notification rule id

Link to this section Functions

Link to this function change_notification_rule_order(connection, identifier, rule_id, body, opts \\ [])

Change order of Notification Rule Changes order of a notification rule with given notification rule id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • body (ChangeNotificationRuleOrderPayload): Request payload of change order of notification rule
  • opts (KeywordList): [optional] Optional parameters

Returns

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

Link to this function create_notification_rule(connection, identifier, body, opts \\ [])

Create Notification Rule Creates a new notification rule

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • body (CreateNotificationRulePayload): Request payload of create notification rule
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Delete Notification Rule Deletes a notification rule with given notification rule id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Disable Notification Rule Disables a notification rule with given notification rule id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Enable Notification Rule Enables a notification rule with given notification rule id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

Link to this function get_notification_rule(connection, identifier, rule_id, opts \\ [])

Get Notification Rule Returns notification rule with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

List Notification Rules Returns list of notification rules

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • opts (KeywordList): [optional] Optional parameters

Returns

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

Link to this function update_notification_rule(connection, identifier, rule_id, body, opts \\ [])

Update Notification Rule (Partial) Updates the notification rule with given notification rule id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • body (UpdateNotificationRulePayload): Request payload of update notification rule
  • opts (KeywordList): [optional] Optional parameters

Returns

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