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.



19
20
21
 
# File 'lib/SematextCloud/api/alerts_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/SematextCloud/api/alerts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_alert_using_post(dto, opts = {}) ⇒ GenericApiResponse

Create alert rule

Parameters:

  • dto —

    dto

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 26

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

#create_alert_using_post_with_http_info(dto, opts = {}) ⇒ Array<(GenericApiResponse, Fixnum, Hash)>

Create alert rule

Parameters:

  • dto —

    dto

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

    the optional parameters

Returns:

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

    GenericApiResponse data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(dto)
  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 => 'GenericApiResponse')
  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 = {}) ⇒ GenericApiResponse

Delete alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:



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

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<(GenericApiResponse, Fixnum, Hash)>

Delete alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:

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

    GenericApiResponse data, response status code and response headers



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

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 = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'GenericApiResponse')
  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 = {}) ⇒ GenericApiResponse

Disable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:



130
131
132
133
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 130

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<(GenericApiResponse, Fixnum, Hash)>

Disable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:

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

    GenericApiResponse data, response status code and response headers



139
140
141
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
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 139

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 = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'GenericApiResponse')
  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 = {}) ⇒ GenericApiResponse

Enable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:



182
183
184
185
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 182

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<(GenericApiResponse, Fixnum, Hash)>

Enable alert rule

Parameters:

  • updateable_alert_id —

    updateableAlertId

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

    the optional parameters

Returns:

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

    GenericApiResponse data, response status code and response headers



191
192
193
194
195
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
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 191

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 = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'GenericApiResponse')
  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 = {}) ⇒ GenericApiResponse

Get alert rules for an app

Parameters:

  • app_id —

    appId

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

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 234

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<(GenericApiResponse, Fixnum, Hash)>

Get alert rules for an app

Parameters:

  • app_id —

    appId

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

    the optional parameters

Returns:

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

    GenericApiResponse data, response status code and response headers



243
244
245
246
247
248
249
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
 
# File 'lib/SematextCloud/api/alerts_api.rb', line 243

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 = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'GenericApiResponse')
  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