Class: OpsgenieSdk::ServiceIncidentRuleApi

Inherits:
Object
  • Object
show all
Defined in:
lib/opsgenie_sdk/api/service_incident_rule_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServiceIncidentRuleApi

Returns a new instance of ServiceIncidentRuleApi.



19
20
21
 
# File 'lib/opsgenie_sdk/api/service_incident_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/service_incident_rule_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_service_incident_rule(identifier, body, opts = {}) ⇒ SuccessResponse

Create Service Incident Rule Creates a new service incident rule

Parameters:

  • identifier —

    Identifier of the service

  • body —

    Request payload of CreateServiceIncidentRulePayload

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 28

def create_service_incident_rule(identifier, body, opts = {})
  data, _status_code, _headers = create_service_incident_rule_with_http_info(identifier, body, opts)
  data
end

#create_service_incident_rule_with_http_info(identifier, body, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Create Service Incident Rule Creates a new service incident rule

Parameters:

  • identifier —

    Identifier of the service

  • body —

    Request payload of CreateServiceIncidentRulePayload

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SuccessResponse, Fixnum, Hash)>) —

    SuccessResponse data, response status code and response headers



39
40
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
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 39

def create_service_incident_rule_with_http_info(identifier, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceIncidentRuleApi.create_service_incident_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 ServiceIncidentRuleApi.create_service_incident_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 ServiceIncidentRuleApi.create_service_incident_rule"
  end
  # resource path
  local_var_path = '/v1/services/{identifier}/incident-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 => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceIncidentRuleApi#create_service_incident_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_service_incident_rule(identifier, id, opts = {}) ⇒ SuccessResponse

Delete service incident rule Delete incident rule of the service

Parameters:

  • identifier —

    Identifier of the service

  • id —

    Id of the service incident rule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



86
87
88
89
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 86

def delete_service_incident_rule(identifier, id, opts = {})
  data, _status_code, _headers = delete_service_incident_rule_with_http_info(identifier, id, opts)
  data
end

#delete_service_incident_rule_with_http_info(identifier, id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Delete service incident rule Delete incident rule of the service

Parameters:

  • identifier —

    Identifier of the service

  • id —

    Id of the service incident rule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SuccessResponse, Fixnum, Hash)>) —

    SuccessResponse data, response status code and response headers



97
98
99
100
101
102
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
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 97

def delete_service_incident_rule_with_http_info(identifier, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceIncidentRuleApi.delete_service_incident_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 ServiceIncidentRuleApi.delete_service_incident_rule"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ServiceIncidentRuleApi.delete_service_incident_rule"
  end
  # resource path
  local_var_path = '/v1/services/{identifier}/routing-rules/{id}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'id' + '}', 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: ServiceIncidentRuleApi#delete_service_incident_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_service_routing_rules(identifier, opts = {}) ⇒ ListServiceIncidentRulesResponse

List Service Incident Rules Returns list of service incident rules

Parameters:

  • identifier —

    Identifier of the service

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ListServiceIncidentRulesResponse) 


143
144
145
146
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 143

def list_service_routing_rules(identifier, opts = {})
  data, _status_code, _headers = list_service_routing_rules_with_http_info(identifier, opts)
  data
end

#list_service_routing_rules_with_http_info(identifier, opts = {}) ⇒ Array<(ListServiceIncidentRulesResponse, Fixnum, Hash)>

List Service Incident Rules Returns list of service incident rules

Parameters:

  • identifier —

    Identifier of the service

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ListServiceIncidentRulesResponse, Fixnum, Hash)>) —

    ListServiceIncidentRulesResponse data, response status code and response headers



153
154
155
156
157
158
159
160
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
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 153

def list_service_routing_rules_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceIncidentRuleApi.list_service_routing_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 ServiceIncidentRuleApi.list_service_routing_rules"
  end
  # resource path
  local_var_path = '/v1/services/{identifier}/incident-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 => 'ListServiceIncidentRulesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceIncidentRuleApi#list_service_routing_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_service_incident_rule(identifier, id, opts = {}) ⇒ SuccessResponse

Update service incident rule Update incident rule of the service

Parameters:

  • identifier —

    Identifier of the service

  • id —

    Id of the service incident rule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (UpdateServiceIncidentRulePayload) —

    Request payload of update Service Incident Rule action

Returns:



197
198
199
200
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 197

def update_service_incident_rule(identifier, id, opts = {})
  data, _status_code, _headers = update_service_incident_rule_with_http_info(identifier, id, opts)
  data
end

#update_service_incident_rule_with_http_info(identifier, id, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Update service incident rule Update incident rule of the service

Parameters:

  • identifier —

    Identifier of the service

  • id —

    Id of the service incident rule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (UpdateServiceIncidentRulePayload) —

    Request payload of update Service Incident Rule action

Returns:

  • (Array<(SuccessResponse, Fixnum, Hash)>) —

    SuccessResponse data, response status code and response headers



209
210
211
212
213
214
215
216
217
218
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
 
# File 'lib/opsgenie_sdk/api/service_incident_rule_api.rb', line 209

def update_service_incident_rule_with_http_info(identifier, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceIncidentRuleApi.update_service_incident_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 ServiceIncidentRuleApi.update_service_incident_rule"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ServiceIncidentRuleApi.update_service_incident_rule"
  end
  # resource path
  local_var_path = '/v1/services/{identifier}/routing-rules/{id}'.sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'id' + '}', 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(opts[:'body'])
  auth_names = ['GenieKey']
  data, status_code, headers = @api_client.call_api(:PUT, 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: ServiceIncidentRuleApi#update_service_incident_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end