Class: SematextCloud::AlertsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/SematextCloud/api/alerts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AlertsApi

Returns a new instance of AlertsApi.



16
17
18
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_alert_using_post(body, opts = {}) ⇒ AlertRuleResponse

Create alert rule

Parameters:

  • body —

    dto

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 23

def create_alert_using_post(body, opts = {})
  data, _status_code, _headers = create_alert_using_post_with_http_info(body, opts)
  data
end

#create_alert_using_post_with_http_info(body, opts = {}) ⇒ Array<(AlertRuleResponse, Integer, Hash)>

Create alert rule

Parameters:

  • body —

    dto

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

    the optional parameters

Returns:

  • (Array<(AlertRuleResponse, Integer, Hash)>) —

    AlertRuleResponse data, response status code and response headers



32
33
34
35
36
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
74
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 32

def create_alert_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.create_alert_using_post ...'
  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 AlertsApi.create_alert_using_post"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'AlertRuleResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#create_alert_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alert_rule_using_delete(updateable_alert_id, opts = {}) ⇒ GenericMapBasedApiResponse

Delete alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 79

def delete_alert_rule_using_delete(updateable_alert_id, opts = {})
  data, _status_code, _headers = delete_alert_rule_using_delete_with_http_info(updateable_alert_id, opts)
  data
end

#delete_alert_rule_using_delete_with_http_info(updateable_alert_id, opts = {}) ⇒ Array<(GenericMapBasedApiResponse, Integer, Hash)>

Delete alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:

  • (Array<(GenericMapBasedApiResponse, Integer, Hash)>) —

    GenericMapBasedApiResponse data, response status code and response headers



88
89
90
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
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 88

def delete_alert_rule_using_delete_with_http_info(updateable_alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.delete_alert_rule_using_delete ...'
  end
  # verify the required parameter 'updateable_alert_id' is set
  if @api_client.config.client_side_validation && updateable_alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'updateable_alert_id' when calling AlertsApi.delete_alert_rule_using_delete"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts/{updateableAlertId}'.sub('{' + 'updateableAlertId' + '}', updateable_alert_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#delete_alert_rule_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#disable_alert_rule_using_put(updateable_alert_id, opts = {}) ⇒ GenericMapBasedApiResponse

Disable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:



133
134
135
136
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 133

def disable_alert_rule_using_put(updateable_alert_id, opts = {})
  data, _status_code, _headers = disable_alert_rule_using_put_with_http_info(updateable_alert_id, opts)
  data
end

#disable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {}) ⇒ Array<(GenericMapBasedApiResponse, Integer, Hash)>

Disable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:

  • (Array<(GenericMapBasedApiResponse, Integer, Hash)>) —

    GenericMapBasedApiResponse data, response status code and response headers



142
143
144
145
146
147
148
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
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 142

def disable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.disable_alert_rule_using_put ...'
  end
  # verify the required parameter 'updateable_alert_id' is set
  if @api_client.config.client_side_validation && updateable_alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'updateable_alert_id' when calling AlertsApi.disable_alert_rule_using_put"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts/{updateableAlertId}/disable'.sub('{' + 'updateableAlertId' + '}', updateable_alert_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#disable_alert_rule_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#enable_alert_rule_using_put(updateable_alert_id, opts = {}) ⇒ GenericMapBasedApiResponse

Enable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:



187
188
189
190
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 187

def enable_alert_rule_using_put(updateable_alert_id, opts = {})
  data, _status_code, _headers = enable_alert_rule_using_put_with_http_info(updateable_alert_id, opts)
  data
end

#enable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {}) ⇒ Array<(GenericMapBasedApiResponse, Integer, Hash)>

Enable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:

  • (Array<(GenericMapBasedApiResponse, Integer, Hash)>) —

    GenericMapBasedApiResponse data, response status code and response headers



196
197
198
199
200
201
202
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
236
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 196

def enable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.enable_alert_rule_using_put ...'
  end
  # verify the required parameter 'updateable_alert_id' is set
  if @api_client.config.client_side_validation && updateable_alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'updateable_alert_id' when calling AlertsApi.enable_alert_rule_using_put"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts/{updateableAlertId}/enable'.sub('{' + 'updateableAlertId' + '}', updateable_alert_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#enable_alert_rule_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alert_rules_for_app_using_get(app_id, opts = {}) ⇒ AlertRulesResponse

Get alert rules for an app

Parameters:

  • app_id —

    appId

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

    the optional parameters

Returns:



241
242
243
244
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 241

def get_alert_rules_for_app_using_get(app_id, opts = {})
  data, _status_code, _headers = get_alert_rules_for_app_using_get_with_http_info(app_id, opts)
  data
end

#get_alert_rules_for_app_using_get_with_http_info(app_id, opts = {}) ⇒ Array<(AlertRulesResponse, Integer, Hash)>

Get alert rules for an app

Parameters:

  • app_id —

    appId

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

    the optional parameters

Returns:

  • (Array<(AlertRulesResponse, Integer, Hash)>) —

    AlertRulesResponse data, response status code and response headers



250
251
252
253
254
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
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 250

def get_alert_rules_for_app_using_get_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.get_alert_rules_for_app_using_get ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AlertsApi.get_alert_rules_for_app_using_get"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/{appId}/alerts'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'AlertRulesResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#get_alert_rules_for_app_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end