Class: OpsgenieSdk::NotificationRuleApi
- Inherits:
-
Object
- Object
- OpsgenieSdk::NotificationRuleApi
- Defined in:
- lib/opsgenie_sdk/api/notification_rule_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#change_notification_rule_order(identifier, rule_id, body, opts = {}) ⇒ SuccessResponse
Change order of Notification Rule Changes order of a notification rule with given notification rule id.
-
#change_notification_rule_order_with_http_info(identifier, rule_id, body, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Change order of Notification Rule Changes order of a notification rule with given notification rule id.
-
#create_notification_rule(identifier, body, opts = {}) ⇒ CreateNotificationRuleResponse
Create Notification Rule Creates a new notification rule.
-
#create_notification_rule_with_http_info(identifier, body, opts = {}) ⇒ Array<(CreateNotificationRuleResponse, Fixnum, Hash)>
Create Notification Rule Creates a new notification rule.
-
#delete_notification_rule(identifier, rule_id, opts = {}) ⇒ SuccessResponse
Delete Notification Rule Deletes a notification rule with given notification rule id.
-
#delete_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Delete Notification Rule Deletes a notification rule with given notification rule id.
-
#disable_notification_rule(identifier, rule_id, opts = {}) ⇒ SuccessResponse
Disable Notification Rule Disables a notification rule with given notification rule id.
-
#disable_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Disable Notification Rule Disables a notification rule with given notification rule id.
-
#enable_notification_rule(identifier, rule_id, opts = {}) ⇒ SuccessResponse
Enable Notification Rule Enables a notification rule with given notification rule id.
-
#enable_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Enable Notification Rule Enables a notification rule with given notification rule id.
-
#get_notification_rule(identifier, rule_id, opts = {}) ⇒ GetNotificationRuleResponse
Get Notification Rule Returns notification rule with given id.
-
#get_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(GetNotificationRuleResponse, Fixnum, Hash)>
Get Notification Rule Returns notification rule with given id.
-
#initialize(api_client = ApiClient.default) ⇒ NotificationRuleApi
constructor
A new instance of NotificationRuleApi.
-
#list_notification_rules(identifier, opts = {}) ⇒ ListNotificationRulesResponse
List Notification Rules Returns list of notification rules.
-
#list_notification_rules_with_http_info(identifier, opts = {}) ⇒ Array<(ListNotificationRulesResponse, Fixnum, Hash)>
List Notification Rules Returns list of notification rules.
-
#update_notification_rule(identifier, rule_id, body, opts = {}) ⇒ UpdateNotificationRuleResponse
Update Notification Rule (Partial) Updates the notification rule with given notification rule id.
-
#update_notification_rule_with_http_info(identifier, rule_id, body, opts = {}) ⇒ Array<(UpdateNotificationRuleResponse, Fixnum, Hash)>
Update Notification Rule (Partial) Updates the notification rule with given notification rule id.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ NotificationRuleApi
Returns a new instance of NotificationRuleApi.
19 20 21 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#change_notification_rule_order(identifier, rule_id, body, opts = {}) ⇒ SuccessResponse
Change order of Notification Rule Changes order of a notification rule with given notification rule id
29 30 31 32 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 29 def change_notification_rule_order(identifier, rule_id, body, opts = {}) data, _status_code, _headers = change_notification_rule_order_with_http_info(identifier, rule_id, body, opts) data end |
#change_notification_rule_order_with_http_info(identifier, rule_id, body, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Change order of Notification Rule Changes order of a notification rule with given notification rule id
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 41 def change_notification_rule_order_with_http_info(identifier, rule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.change_notification_rule_order ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.change_notification_rule_order" end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling NotificationRuleApi.change_notification_rule_order" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling NotificationRuleApi.change_notification_rule_order" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules/{ruleId}/change-order'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#change_notification_rule_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_notification_rule(identifier, body, opts = {}) ⇒ CreateNotificationRuleResponse
Create Notification Rule Creates a new notification rule
92 93 94 95 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 92 def create_notification_rule(identifier, body, opts = {}) data, _status_code, _headers = create_notification_rule_with_http_info(identifier, body, opts) data end |
#create_notification_rule_with_http_info(identifier, body, opts = {}) ⇒ Array<(CreateNotificationRuleResponse, Fixnum, Hash)>
Create Notification Rule Creates a new notification rule
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 103 def create_notification_rule_with_http_info(identifier, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.create_notification_rule ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.create_notification_rule" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling NotificationRuleApi.create_notification_rule" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules'.sub('{' + 'identifier' + '}', identifier.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateNotificationRuleResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#create_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_notification_rule(identifier, rule_id, opts = {}) ⇒ SuccessResponse
Delete Notification Rule Deletes a notification rule with given notification rule id
150 151 152 153 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 150 def delete_notification_rule(identifier, rule_id, opts = {}) data, _status_code, _headers = delete_notification_rule_with_http_info(identifier, rule_id, opts) data end |
#delete_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Delete Notification Rule Deletes a notification rule with given notification rule id
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 161 def delete_notification_rule_with_http_info(identifier, rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.delete_notification_rule ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.delete_notification_rule" end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling NotificationRuleApi.delete_notification_rule" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules/{ruleId}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#delete_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#disable_notification_rule(identifier, rule_id, opts = {}) ⇒ SuccessResponse
Disable Notification Rule Disables a notification rule with given notification rule id
208 209 210 211 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 208 def disable_notification_rule(identifier, rule_id, opts = {}) data, _status_code, _headers = disable_notification_rule_with_http_info(identifier, rule_id, opts) data end |
#disable_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Disable Notification Rule Disables a notification rule with given notification rule id
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 219 def disable_notification_rule_with_http_info(identifier, rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.disable_notification_rule ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.disable_notification_rule" end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling NotificationRuleApi.disable_notification_rule" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules/{ruleId}/disable'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#disable_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#enable_notification_rule(identifier, rule_id, opts = {}) ⇒ SuccessResponse
Enable Notification Rule Enables a notification rule with given notification rule id
266 267 268 269 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 266 def enable_notification_rule(identifier, rule_id, opts = {}) data, _status_code, _headers = enable_notification_rule_with_http_info(identifier, rule_id, opts) data end |
#enable_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>
Enable Notification Rule Enables a notification rule with given notification rule id
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 277 def enable_notification_rule_with_http_info(identifier, rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.enable_notification_rule ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.enable_notification_rule" end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling NotificationRuleApi.enable_notification_rule" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules/{ruleId}/enable'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#enable_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_notification_rule(identifier, rule_id, opts = {}) ⇒ GetNotificationRuleResponse
Get Notification Rule Returns notification rule with given id
324 325 326 327 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 324 def get_notification_rule(identifier, rule_id, opts = {}) data, _status_code, _headers = get_notification_rule_with_http_info(identifier, rule_id, opts) data end |
#get_notification_rule_with_http_info(identifier, rule_id, opts = {}) ⇒ Array<(GetNotificationRuleResponse, Fixnum, Hash)>
Get Notification Rule Returns notification rule with given id
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 335 def get_notification_rule_with_http_info(identifier, rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.get_notification_rule ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.get_notification_rule" end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling NotificationRuleApi.get_notification_rule" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules/{ruleId}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetNotificationRuleResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#get_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_notification_rules(identifier, opts = {}) ⇒ ListNotificationRulesResponse
List Notification Rules Returns list of notification rules
381 382 383 384 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 381 def list_notification_rules(identifier, opts = {}) data, _status_code, _headers = list_notification_rules_with_http_info(identifier, opts) data end |
#list_notification_rules_with_http_info(identifier, opts = {}) ⇒ Array<(ListNotificationRulesResponse, Fixnum, Hash)>
List Notification Rules Returns list of notification rules
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 391 def list_notification_rules_with_http_info(identifier, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.list_notification_rules ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.list_notification_rules" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules'.sub('{' + 'identifier' + '}', identifier.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ListNotificationRulesResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#list_notification_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_notification_rule(identifier, rule_id, body, opts = {}) ⇒ UpdateNotificationRuleResponse
Update Notification Rule (Partial) Updates the notification rule with given notification rule id
435 436 437 438 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 435 def update_notification_rule(identifier, rule_id, body, opts = {}) data, _status_code, _headers = update_notification_rule_with_http_info(identifier, rule_id, body, opts) data end |
#update_notification_rule_with_http_info(identifier, rule_id, body, opts = {}) ⇒ Array<(UpdateNotificationRuleResponse, Fixnum, Hash)>
Update Notification Rule (Partial) Updates the notification rule with given notification rule id
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 |
# File 'lib/opsgenie_sdk/api/notification_rule_api.rb', line 447 def update_notification_rule_with_http_info(identifier, rule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NotificationRuleApi.update_notification_rule ...' end # verify the required parameter 'identifier' is set if @api_client.config.client_side_validation && identifier.nil? fail ArgumentError, "Missing the required parameter 'identifier' when calling NotificationRuleApi.update_notification_rule" end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling NotificationRuleApi.update_notification_rule" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling NotificationRuleApi.update_notification_rule" end # resource path local_var_path = '/v2/users/{identifier}/notification-rules/{ruleId}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UpdateNotificationRuleResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: NotificationRuleApi#update_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |