Synctera 'Watchlist' endpoints.
Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do
not edit by hand — re-run mix generate (or python3 scripts/generate.py)
to regenerate.
Summary
Functions
Retrieve watchlist monitoring alert
Like get_watchlist_alert/4 but returns the value directly and raises on error.
Retrieve watchlist monitoring subscription
Like get_watchlist_subscription/4 but returns the value directly and raises on error.
List watchlist monitoring alerts for a customer
Like list_watchlist_alerts/3 but returns the value directly and raises on error.
List watchlist monitoring subscriptions for a customer
Like list_watchlist_subscriptions/3 but returns the value directly and raises on error.
Suppress entity alert
Like suppress_watchlist_entity_alert/3 but returns the value directly and raises on error.
Update watchlist alert
Like update_watchlist_alert/4 but returns the value directly and raises on error.
Update watchlist monitoring subscription
Like update_watchlist_subscription/4 but returns the value directly and raises on error.
Subscribe a customer to watchlist monitoring
Like watchlist_subscribe/3 but returns the value directly and raises on error.
Functions
@spec get_watchlist_alert(Synctera.Client.t(), String.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Retrieve watchlist monitoring alert
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec get_watchlist_alert!(Synctera.Client.t(), String.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like get_watchlist_alert/4 but returns the value directly and raises on error.
@spec get_watchlist_subscription( Synctera.Client.t(), String.t(), String.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Retrieve watchlist monitoring subscription
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec get_watchlist_subscription!( Synctera.Client.t(), String.t(), String.t(), keyword() ) :: Synctera.JSON.json()
Like get_watchlist_subscription/4 but returns the value directly and raises on error.
@spec list_watchlist_alerts(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List watchlist monitoring alerts for a customer
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_watchlist_alerts!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like list_watchlist_alerts/3 but returns the value directly and raises on error.
@spec list_watchlist_subscriptions(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List watchlist monitoring subscriptions for a customer
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_watchlist_subscriptions!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like list_watchlist_subscriptions/3 but returns the value directly and raises on error.
@spec suppress_watchlist_entity_alert(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Suppress entity alert
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec suppress_watchlist_entity_alert!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like suppress_watchlist_entity_alert/3 but returns the value directly and raises on error.
@spec update_watchlist_alert(Synctera.Client.t(), String.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Update watchlist alert
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec update_watchlist_alert!(Synctera.Client.t(), String.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like update_watchlist_alert/4 but returns the value directly and raises on error.
@spec update_watchlist_subscription( Synctera.Client.t(), String.t(), String.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Update watchlist monitoring subscription
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec update_watchlist_subscription!( Synctera.Client.t(), String.t(), String.t(), keyword() ) :: Synctera.JSON.json()
Like update_watchlist_subscription/4 but returns the value directly and raises on error.
@spec watchlist_subscribe(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Subscribe a customer to watchlist monitoring
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec watchlist_subscribe!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like watchlist_subscribe/3 but returns the value directly and raises on error.