=begin #Synctera API #
Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company's banking needs and are designed to be easy to understand and implement.
We're continuously growing this library and what you see here is just the start, but if you need something specific or have a question, contact us.
The version of the OpenAPI document: 0.60.0 Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.5.0 =end require 'cgi' module SyncteraRubySdk class MonitoringApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # 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. # @param monitoring_subscription [MonitoringSubscription] The monitoring subscription. # @param [Hash] opts the optional parameters # @return [MonitoringSubscription] def create_subscription(monitoring_subscription, opts = {}) data, _status_code, _headers = create_subscription_with_http_info(monitoring_subscription, opts) data end # 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. # @param monitoring_subscription [MonitoringSubscription] The monitoring subscription. # @param [Hash] opts the optional parameters # @return [Array<(MonitoringSubscription, Integer, Hash)>] MonitoringSubscription data, response status code and response headers 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'] new_options = 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, new_options) 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 monitoring subscription # @param subscription_id [String] Unique identifier for monitoring subscription. # @param [Hash] opts the optional parameters # @return [DeleteResponse] def delete_subscription(subscription_id, opts = {}) data, _status_code, _headers = delete_subscription_with_http_info(subscription_id, opts) data end # Delete monitoring subscription # @param subscription_id [String] Unique identifier for monitoring subscription. # @param [Hash] opts the optional parameters # @return [Array<(DeleteResponse, Integer, Hash)>] DeleteResponse data, response status code and response headers 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'] new_options = 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, new_options) 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 # Retrieve a monitoring alert # @param alert_id [String] Unique identifier for this monitoring alert. # @param [Hash] opts the optional parameters # @return [MonitoringAlert] def get_alert(alert_id, opts = {}) data, _status_code, _headers = get_alert_with_http_info(alert_id, opts) data end # Retrieve a monitoring alert # @param alert_id [String] Unique identifier for this monitoring alert. # @param [Hash] opts the optional parameters # @return [Array<(MonitoringAlert, Integer, Hash)>] MonitoringAlert data, response status code and response headers 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'] new_options = 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, new_options) 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 # Retrieve monitoring subscription # @param subscription_id [String] Unique identifier for monitoring subscription. # @param [Hash] opts the optional parameters # @return [MonitoringSubscription] def get_subscription(subscription_id, opts = {}) data, _status_code, _headers = get_subscription_with_http_info(subscription_id, opts) data end # Retrieve monitoring subscription # @param subscription_id [String] Unique identifier for monitoring subscription. # @param [Hash] opts the optional parameters # @return [Array<(MonitoringSubscription, Integer, Hash)>] MonitoringSubscription data, response status code and response headers 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'] new_options = 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, new_options) 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 monitoring alerts # @param [Hash] opts the optional parameters # @option opts [Array