Class: OpsgenieSdk::ForwardingRuleApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ForwardingRuleApi

Returns a new instance of ForwardingRuleApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_forwarding_rule(body, opts = {}) ⇒ CreateForwardingRuleResponse

Create Forwarding Rule Creates a new forwarding rule

Parameters:

  • body —

    Request payload to created forwarding rule

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 27

def create_forwarding_rule(body, opts = {})
  data, _status_code, _headers = create_forwarding_rule_with_http_info(body, opts)
  data
end

#create_forwarding_rule_with_http_info(body, opts = {}) ⇒ Array<(CreateForwardingRuleResponse, Fixnum, Hash)>

Create Forwarding Rule Creates a new forwarding rule

Parameters:

  • body —

    Request payload to created forwarding rule

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

    the optional parameters

Returns:



37
38
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
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 37

def create_forwarding_rule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardingRuleApi.create_forwarding_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 ForwardingRuleApi.create_forwarding_rule"
  end
  # resource path
  local_var_path = '/v2/forwarding-rules'

  # 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 => 'CreateForwardingRuleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ForwardingRuleApi#create_forwarding_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_forwarding_rule(identifier, opts = {}) ⇒ SuccessResponse

Delete Forwarding Rule Deletes forwarding rule with given identifier

Parameters:

  • identifier —

    Identifier of the forwarding rule which could be forwarding rule &#39;id&#39; or &#39;alias&#39;

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;alias&#39; (default to id)

Returns:



80
81
82
83
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 80

def delete_forwarding_rule(identifier, opts = {})
  data, _status_code, _headers = delete_forwarding_rule_with_http_info(identifier, opts)
  data
end

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

Delete Forwarding Rule Deletes forwarding rule with given identifier

Parameters:

  • identifier —

    Identifier of the forwarding rule which could be forwarding rule &#39;id&#39; or &#39;alias&#39;

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;alias&#39;

Returns:

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

    SuccessResponse data, response status code and response headers



91
92
93
94
95
96
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
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 91

def delete_forwarding_rule_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardingRuleApi.delete_forwarding_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 ForwardingRuleApi.delete_forwarding_rule"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'alias'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, alias'
  end
  # resource path
  local_var_path = '/v2/forwarding-rules/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].nil?

  # 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: ForwardingRuleApi#delete_forwarding_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_forwarding_rule(identifier, opts = {}) ⇒ GetForwardingRuleResponse

Get Forwarding Rule Returns forwarding rule with given id or alias

Parameters:

  • identifier —

    Identifier of the forwarding rule which could be forwarding rule &#39;id&#39; or &#39;alias&#39;

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;alias&#39; (default to id)

Returns:



138
139
140
141
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 138

def get_forwarding_rule(identifier, opts = {})
  data, _status_code, _headers = get_forwarding_rule_with_http_info(identifier, opts)
  data
end

#get_forwarding_rule_with_http_info(identifier, opts = {}) ⇒ Array<(GetForwardingRuleResponse, Fixnum, Hash)>

Get Forwarding Rule Returns forwarding rule with given id or alias

Parameters:

  • identifier —

    Identifier of the forwarding rule which could be forwarding rule &#39;id&#39; or &#39;alias&#39;

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;alias&#39;

Returns:

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

    GetForwardingRuleResponse data, response status code and response headers



149
150
151
152
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/forwarding_rule_api.rb', line 149

def get_forwarding_rule_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardingRuleApi.get_forwarding_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 ForwardingRuleApi.get_forwarding_rule"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'alias'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, alias'
  end
  # resource path
  local_var_path = '/v2/forwarding-rules/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].nil?

  # 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 => 'GetForwardingRuleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ForwardingRuleApi#get_forwarding_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_forwarding_rules(opts = {}) ⇒ ListForwardingRulesResponse

List Forwarding Rules Returns list of forwarding rules

Parameters:

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

    the optional parameters

Returns:



194
195
196
197
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 194

def list_forwarding_rules(opts = {})
  data, _status_code, _headers = list_forwarding_rules_with_http_info(opts)
  data
end

#list_forwarding_rules_with_http_info(opts = {}) ⇒ Array<(ListForwardingRulesResponse, Fixnum, Hash)>

List Forwarding Rules Returns list of forwarding rules

Parameters:

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

    the optional parameters

Returns:



203
204
205
206
207
208
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
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 203

def list_forwarding_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardingRuleApi.list_forwarding_rules ...'
  end
  # resource path
  local_var_path = '/v2/forwarding-rules'

  # 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 => 'ListForwardingRulesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ForwardingRuleApi#list_forwarding_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update Forwarding Rule Update forwarding rule with given rule id or alias

Parameters:

  • identifier —

    Identifier of the forwarding rule which could be forwarding rule &#39;id&#39; or &#39;alias&#39;

  • body —

    Request payload of update forwarding rule action

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;alias&#39; (default to id)

Returns:



243
244
245
246
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 243

def update_forwarding_rule(identifier, body, opts = {})
  data, _status_code, _headers = update_forwarding_rule_with_http_info(identifier, body, opts)
  data
end

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

Update Forwarding Rule Update forwarding rule with given rule id or alias

Parameters:

  • identifier —

    Identifier of the forwarding rule which could be forwarding rule &#39;id&#39; or &#39;alias&#39;

  • body —

    Request payload of update forwarding rule action

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier that is provided as an in-line parameter. Possible values are &#39;id&#39; or &#39;alias&#39;

Returns:

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

    SuccessResponse data, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/opsgenie_sdk/api/forwarding_rule_api.rb', line 255

def update_forwarding_rule_with_http_info(identifier, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardingRuleApi.update_forwarding_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 ForwardingRuleApi.update_forwarding_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 ForwardingRuleApi.update_forwarding_rule"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'alias'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, alias'
  end
  # resource path
  local_var_path = '/v2/forwarding-rules/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].nil?

  # 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(: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: ForwardingRuleApi#update_forwarding_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end