Class: SyncteraRubySdk::MonitoringApi
- Inherits:
-
Object
- Object
- SyncteraRubySdk::MonitoringApi
- Defined in:
- lib/synctera_ruby_sdk/api/monitoring_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_subscription(monitoring_subscription, opts = {}) ⇒ MonitoringSubscription
Subscribe a customer or business to monitoring This endpoint is rarely needed.
-
#create_subscription_with_http_info(monitoring_subscription, opts = {}) ⇒ Array<(MonitoringSubscription, Integer, Hash)>
Subscribe a customer or business to monitoring This endpoint is rarely needed.
-
#delete_subscription(subscription_id, opts = {}) ⇒ DeleteResponse
Delete monitoring subscription.
-
#delete_subscription_with_http_info(subscription_id, opts = {}) ⇒ Array<(DeleteResponse, Integer, Hash)>
Delete monitoring subscription.
-
#get_alert(alert_id, opts = {}) ⇒ MonitoringAlert
Retrieve a monitoring alert.
-
#get_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(MonitoringAlert, Integer, Hash)>
Retrieve a monitoring alert.
-
#get_subscription(subscription_id, opts = {}) ⇒ MonitoringSubscription
Retrieve monitoring subscription.
-
#get_subscription_with_http_info(subscription_id, opts = {}) ⇒ Array<(MonitoringSubscription, Integer, Hash)>
Retrieve monitoring subscription.
-
#initialize(api_client = ApiClient.default) ⇒ MonitoringApi
constructor
A new instance of MonitoringApi.
-
#list_alerts(opts = {}) ⇒ MonitoringAlertList
List monitoring alerts.
-
#list_alerts_with_http_info(opts = {}) ⇒ Array<(MonitoringAlertList, Integer, Hash)>
List monitoring alerts.
-
#list_subscriptions(opts = {}) ⇒ MonitoringSubscriptionList
List monitoring subscriptions.
-
#list_subscriptions_with_http_info(opts = {}) ⇒ Array<(MonitoringSubscriptionList, Integer, Hash)>
List monitoring subscriptions.
-
#update_alert(alert_id, monitoring_alert, opts = {}) ⇒ nil
Update a monitoring alert.
-
#update_alert_with_http_info(alert_id, monitoring_alert, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update a monitoring alert.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ MonitoringApi
Returns a new instance of MonitoringApi.
19 20 21 |
# File 'lib/synctera_ruby_sdk/api/monitoring_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/synctera_ruby_sdk/api/monitoring_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_subscription(monitoring_subscription, opts = {}) ⇒ MonitoringSubscription
Subscribe a customer or business to monitoring This endpoint is rarely needed. Since August 2022, watchlist monitoring is automatically enabled for all businesses and customers who are verified (KYC/KYB) through Synctera’s platform.
27 28 29 30 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 27 def create_subscription(monitoring_subscription, opts = {}) data, _status_code, _headers = create_subscription_with_http_info(monitoring_subscription, opts) data end |
#create_subscription_with_http_info(monitoring_subscription, opts = {}) ⇒ Array<(MonitoringSubscription, Integer, Hash)>
Subscribe a customer or business to monitoring This endpoint is rarely needed. Since August 2022, watchlist monitoring is automatically enabled for all businesses and customers who are verified (KYC/KYB) through Synctera's platform.
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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 37 def create_subscription_with_http_info(monitoring_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitoringApi.create_subscription ...' end # verify the required parameter 'monitoring_subscription' is set if @api_client.config.client_side_validation && monitoring_subscription.nil? fail ArgumentError, "Missing the required parameter 'monitoring_subscription' when calling MonitoringApi.create_subscription" end # resource path local_var_path = '/monitoring/subscriptions' # 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', 'application/problem+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(monitoring_subscription) # return_type return_type = opts[:debug_return_type] || 'MonitoringSubscription' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"MonitoringApi.create_subscription", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MonitoringApi#create_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_subscription(subscription_id, opts = {}) ⇒ DeleteResponse
Delete monitoring subscription
94 95 96 97 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 94 def delete_subscription(subscription_id, opts = {}) data, _status_code, _headers = delete_subscription_with_http_info(subscription_id, opts) data end |
#delete_subscription_with_http_info(subscription_id, opts = {}) ⇒ Array<(DeleteResponse, Integer, Hash)>
Delete monitoring subscription
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 144 145 146 147 148 149 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 103 def delete_subscription_with_http_info(subscription_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitoringApi.delete_subscription ...' end # verify the required parameter 'subscription_id' is set if @api_client.config.client_side_validation && subscription_id.nil? fail ArgumentError, "Missing the required parameter 'subscription_id' when calling MonitoringApi.delete_subscription" end # resource path local_var_path = '/monitoring/subscriptions/{subscription_id}'.sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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', 'application/problem+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DeleteResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"MonitoringApi.delete_subscription", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MonitoringApi#delete_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_alert(alert_id, opts = {}) ⇒ MonitoringAlert
Retrieve a monitoring alert
155 156 157 158 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 155 def get_alert(alert_id, opts = {}) data, _status_code, _headers = get_alert_with_http_info(alert_id, opts) data end |
#get_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(MonitoringAlert, Integer, Hash)>
Retrieve a monitoring alert
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 202 203 204 205 206 207 208 209 210 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 164 def get_alert_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitoringApi.get_alert ...' end # verify the required parameter 'alert_id' is set if @api_client.config.client_side_validation && alert_id.nil? fail ArgumentError, "Missing the required parameter 'alert_id' when calling MonitoringApi.get_alert" end # resource path local_var_path = '/monitoring/alerts/{alert_id}'.sub('{' + 'alert_id' + '}', CGI.escape(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', 'application/problem+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MonitoringAlert' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"MonitoringApi.get_alert", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MonitoringApi#get_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_subscription(subscription_id, opts = {}) ⇒ MonitoringSubscription
Retrieve monitoring subscription
216 217 218 219 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 216 def get_subscription(subscription_id, opts = {}) data, _status_code, _headers = get_subscription_with_http_info(subscription_id, opts) data end |
#get_subscription_with_http_info(subscription_id, opts = {}) ⇒ Array<(MonitoringSubscription, Integer, Hash)>
Retrieve monitoring subscription
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 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 225 def get_subscription_with_http_info(subscription_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitoringApi.get_subscription ...' end # verify the required parameter 'subscription_id' is set if @api_client.config.client_side_validation && subscription_id.nil? fail ArgumentError, "Missing the required parameter 'subscription_id' when calling MonitoringApi.get_subscription" end # resource path local_var_path = '/monitoring/subscriptions/{subscription_id}'.sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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', 'application/problem+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MonitoringSubscription' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"MonitoringApi.get_subscription", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MonitoringApi#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_alerts(opts = {}) ⇒ MonitoringAlertList
List monitoring alerts
281 282 283 284 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 281 def list_alerts(opts = {}) data, _status_code, _headers = list_alerts_with_http_info(opts) data end |
#list_alerts_with_http_info(opts = {}) ⇒ Array<(MonitoringAlertList, Integer, Hash)>
List monitoring alerts
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 294 def list_alerts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitoringApi.list_alerts ...' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MonitoringApi.list_alerts, must be greater than or equal to 1.' end # resource path local_var_path = '/monitoring/alerts' # query parameters query_params = opts[:query_params] || {} query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :csv) if !opts[:'id'].nil? query_params[:'person_id'] = @api_client.build_collection_param(opts[:'person_id'], :csv) if !opts[:'person_id'].nil? query_params[:'business_id'] = @api_client.build_collection_param(opts[:'business_id'], :csv) if !opts[:'business_id'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MonitoringAlertList' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"MonitoringApi.list_alerts", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MonitoringApi#list_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_subscriptions(opts = {}) ⇒ MonitoringSubscriptionList
List monitoring subscriptions
355 356 357 358 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 355 def list_subscriptions(opts = {}) data, _status_code, _headers = list_subscriptions_with_http_info(opts) data end |
#list_subscriptions_with_http_info(opts = {}) ⇒ Array<(MonitoringSubscriptionList, Integer, Hash)>
List monitoring subscriptions
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 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 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 368 def list_subscriptions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitoringApi.list_subscriptions ...' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MonitoringApi.list_subscriptions, must be greater than or equal to 1.' end # resource path local_var_path = '/monitoring/subscriptions' # query parameters query_params = opts[:query_params] || {} query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :csv) if !opts[:'id'].nil? query_params[:'person_id'] = @api_client.build_collection_param(opts[:'person_id'], :csv) if !opts[:'person_id'].nil? query_params[:'business_id'] = @api_client.build_collection_param(opts[:'business_id'], :csv) if !opts[:'business_id'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MonitoringSubscriptionList' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"MonitoringApi.list_subscriptions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MonitoringApi#list_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_alert(alert_id, monitoring_alert, opts = {}) ⇒ nil
Update a monitoring alert
426 427 428 429 |
# File 'lib/synctera_ruby_sdk/api/monitoring_api.rb', line 426 def update_alert(alert_id, monitoring_alert, opts = {}) update_alert_with_http_info(alert_id, monitoring_alert, opts) nil end |
#update_alert_with_http_info(alert_id, monitoring_alert, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update a monitoring alert
436 437 438 439 440 441 442 443 444 445 446 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/synctera_ruby_sdk/api/monitoring_api.rb', line 436 def update_alert_with_http_info(alert_id, monitoring_alert, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitoringApi.update_alert ...' end # verify the required parameter 'alert_id' is set if @api_client.config.client_side_validation && alert_id.nil? fail ArgumentError, "Missing the required parameter 'alert_id' when calling MonitoringApi.update_alert" end # verify the required parameter 'monitoring_alert' is set if @api_client.config.client_side_validation && monitoring_alert.nil? fail ArgumentError, "Missing the required parameter 'monitoring_alert' when calling MonitoringApi.update_alert" end # resource path local_var_path = '/monitoring/alerts/{alert_id}'.sub('{' + 'alert_id' + '}', CGI.escape(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/problem+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(monitoring_alert) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"MonitoringApi.update_alert", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MonitoringApi#update_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |