Synctera::MonitoringApi

All URIs are relative to https://api-sandbox.synctera.com/v0

Method	HTTP request	Description
create_subscription	POST /monitoring/subscriptions	Subscribe a customer or business to monitoring
delete_subscription	DELETE /monitoring/subscriptions/{subscription_id}	Delete monitoring subscription
get_alert	GET /monitoring/alerts/{alert_id}	Retrieve a monitoring alert
get_subscription	GET /monitoring/subscriptions/{subscription_id}	Retrieve monitoring subscription
list_alerts	GET /monitoring/alerts	List monitoring alerts
list_subscriptions	GET /monitoring/subscriptions	List monitoring subscriptions
update_alert	PATCH /monitoring/alerts/{alert_id}	Update a monitoring alert

create_subscription

create_subscription(monitoring_subscription)

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.

Examples

require 'time'
require 'synctera'
# setup authorization
Synctera.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Synctera::MonitoringApi.new
monitoring_subscription = Synctera::MonitoringSubscription.new # MonitoringSubscription | The monitoring subscription.

begin
  # Subscribe a customer or business to monitoring
  result = api_instance.create_subscription(monitoring_subscription)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->create_subscription: #{e}"
end

Using the create_subscription_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_subscription_with_http_info(monitoring_subscription)

begin
  # Subscribe a customer or business to monitoring
  data, status_code, headers = api_instance.create_subscription_with_http_info(monitoring_subscription)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MonitoringSubscription>
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->create_subscription_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
monitoring_subscription	MonitoringSubscription	The monitoring subscription.

Return type

MonitoringSubscription

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

delete_subscription

delete_subscription(subscription_id)

Delete monitoring subscription

Examples

require 'time'
require 'synctera'
# setup authorization
Synctera.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Synctera::MonitoringApi.new
subscription_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for monitoring subscription.

begin
  # Delete monitoring subscription
  result = api_instance.delete_subscription(subscription_id)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->delete_subscription: #{e}"
end

Using the delete_subscription_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_subscription_with_http_info(subscription_id)

begin
  # Delete monitoring subscription
  data, status_code, headers = api_instance.delete_subscription_with_http_info(subscription_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteResponse>
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->delete_subscription_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	Unique identifier for monitoring subscription.

Return type

DeleteResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

get_alert

get_alert(alert_id)

Retrieve a monitoring alert

Examples

require 'time'
require 'synctera'
# setup authorization
Synctera.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Synctera::MonitoringApi.new
alert_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for this monitoring alert.

begin
  # Retrieve a monitoring alert
  result = api_instance.get_alert(alert_id)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->get_alert: #{e}"
end

Using the get_alert_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_alert_with_http_info(alert_id)

begin
  # Retrieve a monitoring alert
  data, status_code, headers = api_instance.get_alert_with_http_info(alert_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MonitoringAlert>
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->get_alert_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
alert_id	String	Unique identifier for this monitoring alert.

Return type

MonitoringAlert

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

get_subscription

get_subscription(subscription_id)

Retrieve monitoring subscription

Examples

require 'time'
require 'synctera'
# setup authorization
Synctera.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Synctera::MonitoringApi.new
subscription_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for monitoring subscription.

begin
  # Retrieve monitoring subscription
  result = api_instance.get_subscription(subscription_id)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->get_subscription: #{e}"
end

Using the get_subscription_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_subscription_with_http_info(subscription_id)

begin
  # Retrieve monitoring subscription
  data, status_code, headers = api_instance.get_subscription_with_http_info(subscription_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MonitoringSubscription>
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->get_subscription_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	Unique identifier for monitoring subscription.

Return type

MonitoringSubscription

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

list_alerts

list_alerts(opts)

List monitoring alerts

Examples

require 'time'
require 'synctera'
# setup authorization
Synctera.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Synctera::MonitoringApi.new
opts = {
  id: ['inner_example'], # Array<String> | Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list. 
  business_id: ['inner_example'], # Array<String> | Unique identifier for the business. Multiple IDs can be provided as a comma-separated list. 
  page_token: 'a8937a0d', # String | 
  person_id: ['inner_example'], # Array<String> | Unique identifier for the person. Multiple IDs can be provided as a comma-separated list. 
  limit: 100 # Integer | 
}

begin
  # List monitoring alerts
  result = api_instance.list_alerts(opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->list_alerts: #{e}"
end

Using the list_alerts_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_alerts_with_http_info(opts)

begin
  # List monitoring alerts
  data, status_code, headers = api_instance.list_alerts_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MonitoringAlertList>
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->list_alerts_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Array<String>	Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.	[optional]
business_id	Array<String>	Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.	[optional]
page_token	String		[optional]
person_id	Array<String>	Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.	[optional]
limit	Integer		[optional][default to 100]

Return type

MonitoringAlertList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

list_subscriptions

list_subscriptions(opts)

List monitoring subscriptions

Examples

require 'time'
require 'synctera'
# setup authorization
Synctera.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Synctera::MonitoringApi.new
opts = {
  id: ['inner_example'], # Array<String> | Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list. 
  business_id: ['inner_example'], # Array<String> | Unique identifier for the business. Multiple IDs can be provided as a comma-separated list. 
  page_token: 'a8937a0d', # String | 
  person_id: ['inner_example'], # Array<String> | Unique identifier for the person. Multiple IDs can be provided as a comma-separated list. 
  limit: 100 # Integer | 
}

begin
  # List monitoring subscriptions
  result = api_instance.list_subscriptions(opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->list_subscriptions: #{e}"
end

Using the list_subscriptions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_subscriptions_with_http_info(opts)

begin
  # List monitoring subscriptions
  data, status_code, headers = api_instance.list_subscriptions_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MonitoringSubscriptionList>
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->list_subscriptions_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Array<String>	Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.	[optional]
business_id	Array<String>	Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.	[optional]
page_token	String		[optional]
person_id	Array<String>	Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.	[optional]
limit	Integer		[optional][default to 100]

Return type

MonitoringSubscriptionList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

update_alert

update_alert(alert_id, monitoring_alert)

Update a monitoring alert

Examples

require 'time'
require 'synctera'
# setup authorization
Synctera.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Synctera::MonitoringApi.new
alert_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for this monitoring alert.
monitoring_alert = Synctera::MonitoringAlert.new # MonitoringAlert | Monitoring alert to update.

begin
  # Update a monitoring alert
  api_instance.update_alert(alert_id, monitoring_alert)
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->update_alert: #{e}"
end

Using the update_alert_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> update_alert_with_http_info(alert_id, monitoring_alert)

begin
  # Update a monitoring alert
  data, status_code, headers = api_instance.update_alert_with_http_info(alert_id, monitoring_alert)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Synctera::ApiError => e
  puts "Error when calling MonitoringApi->update_alert_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
alert_id	String	Unique identifier for this monitoring alert.
monitoring_alert	MonitoringAlert	Monitoring alert to update.

Return type

nil (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/problem+json

Files

MonitoringApi.md

Latest commit

History

MonitoringApi.md

File metadata and controls

Synctera::MonitoringApi

create_subscription

Examples

Using the create_subscription_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_subscription

Examples

Using the delete_subscription_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_alert

Examples

Using the get_alert_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_subscription

Examples

Using the get_subscription_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

list_alerts

Examples

Using the list_alerts_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

list_subscriptions

Examples

Using the list_subscriptions_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

update_alert

Examples

Using the update_alert_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers