Class: SyncteraRubySdk::WatchlistDeprecatedApi

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WatchlistDeprecatedApi

Returns a new instance of WatchlistDeprecatedApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_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/watchlist_deprecated_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_watchlist_alert(customer_id, alert_id, opts = {}) ⇒ WatchlistAlert

Retrieve watchlist monitoring alert

Parameters:

  • customer_id (String) —

    The customer's unique identifier

  • alert_id (String) —

    Unique identifier for this watchlist alert.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 27

def get_watchlist_alert(customer_id, alert_id, opts = {})
  data, _status_code, _headers = get_watchlist_alert_with_http_info(customer_id, alert_id, opts)
  data
end

#get_watchlist_alert_with_http_info(customer_id, alert_id, opts = {}) ⇒ Array<(WatchlistAlert, Integer, Hash)>

Retrieve watchlist monitoring alert

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • alert_id (String) —

    Unique identifier for this watchlist alert.

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

    the optional parameters

Returns:

  • (Array<(WatchlistAlert, Integer, Hash)>) —

    WatchlistAlert data, response status code and response headers



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
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 37

def get_watchlist_alert_with_http_info(customer_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.get_watchlist_alert ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.get_watchlist_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 WatchlistDeprecatedApi.get_watchlist_alert"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/alerts/{alert_id}'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s)).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] || 'WatchlistAlert'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.get_watchlist_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: WatchlistDeprecatedApi#get_watchlist_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_watchlist_subscription(customer_id, subscription_id, opts = {}) ⇒ WatchlistSubscription

Retrieve watchlist monitoring subscription

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • subscription_id (String) —

    Watchlist monitoring subscription ID

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 94

def get_watchlist_subscription(customer_id, subscription_id, opts = {})
  data, _status_code, _headers = get_watchlist_subscription_with_http_info(customer_id, subscription_id, opts)
  data
end

#get_watchlist_subscription_with_http_info(customer_id, subscription_id, opts = {}) ⇒ Array<(WatchlistSubscription, Integer, Hash)>

Retrieve watchlist monitoring subscription

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • subscription_id (String) —

    Watchlist monitoring subscription ID

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

    the optional parameters

Returns:

  • (Array<(WatchlistSubscription, Integer, Hash)>) —

    WatchlistSubscription data, response status code and response headers



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
150
151
152
153
154
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 104

def get_watchlist_subscription_with_http_info(customer_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.get_watchlist_subscription ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.get_watchlist_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 WatchlistDeprecatedApi.get_watchlist_subscription"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/subscriptions/{subscription_id}'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s)).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] || 'WatchlistSubscription'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.get_watchlist_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: WatchlistDeprecatedApi#get_watchlist_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_watchlist_alerts(customer_id, opts = {}) ⇒ WatchlistAlertList

List watchlist monitoring alerts for a customer

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

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

    the optional parameters

Returns:



160
161
162
163
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 160

def list_watchlist_alerts(customer_id, opts = {})
  data, _status_code, _headers = list_watchlist_alerts_with_http_info(customer_id, opts)
  data
end

#list_watchlist_alerts_with_http_info(customer_id, opts = {}) ⇒ Array<(WatchlistAlertList, Integer, Hash)>

List watchlist monitoring alerts for a customer

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

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

    the optional parameters

Returns:

  • (Array<(WatchlistAlertList, Integer, Hash)>) —

    WatchlistAlertList data, response status code and response headers



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
211
212
213
214
215
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 169

def list_watchlist_alerts_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.list_watchlist_alerts ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.list_watchlist_alerts"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/alerts'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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] || 'WatchlistAlertList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.list_watchlist_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WatchlistDeprecatedApi#list_watchlist_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_watchlist_subscriptions(customer_id, opts = {}) ⇒ WatchlistSubscriptionList

List watchlist monitoring subscriptions for a customer

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

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

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 221

def list_watchlist_subscriptions(customer_id, opts = {})
  data, _status_code, _headers = list_watchlist_subscriptions_with_http_info(customer_id, opts)
  data
end

#list_watchlist_subscriptions_with_http_info(customer_id, opts = {}) ⇒ Array<(WatchlistSubscriptionList, Integer, Hash)>

List watchlist monitoring subscriptions for a customer

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

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

    the optional parameters

Returns:

  • (Array<(WatchlistSubscriptionList, Integer, Hash)>) —

    WatchlistSubscriptionList data, response status code and response headers



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
272
273
274
275
276
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 230

def list_watchlist_subscriptions_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.list_watchlist_subscriptions ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.list_watchlist_subscriptions"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/subscriptions'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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] || 'WatchlistSubscriptionList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.list_watchlist_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WatchlistDeprecatedApi#list_watchlist_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#suppress_watchlist_entity_alert(customer_id, watchlist_suppress, opts = {}) ⇒ nil

Suppress entity alert

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • watchlist_suppress (WatchlistSuppress) —

    A watchlist suppression object

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:

  • (nil) 


284
285
286
287
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 284

def suppress_watchlist_entity_alert(customer_id, watchlist_suppress, opts = {})
  suppress_watchlist_entity_alert_with_http_info(customer_id, watchlist_suppress, opts)
  nil
end

#suppress_watchlist_entity_alert_with_http_info(customer_id, watchlist_suppress, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Suppress entity alert

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • watchlist_suppress (WatchlistSuppress) —

    A watchlist suppression object

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
346
347
348
349
350
351
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 295

def suppress_watchlist_entity_alert_with_http_info(customer_id, watchlist_suppress, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.suppress_watchlist_entity_alert ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.suppress_watchlist_entity_alert"
  end
  # verify the required parameter 'watchlist_suppress' is set
  if @api_client.config.client_side_validation && watchlist_suppress.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_suppress' when calling WatchlistDeprecatedApi.suppress_watchlist_entity_alert"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/suppressions'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_suppress)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.suppress_watchlist_entity_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WatchlistDeprecatedApi#suppress_watchlist_entity_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_watchlist_alert(customer_id, alert_id, watchlist_alert, opts = {}) ⇒ nil

Update watchlist alert

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • alert_id (String) —

    Unique identifier for this watchlist alert.

  • watchlist_alert (WatchlistAlert) —

    A watchlist body

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

    the optional parameters

Returns:

  • (nil) 


359
360
361
362
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 359

def update_watchlist_alert(customer_id, alert_id, watchlist_alert, opts = {})
  update_watchlist_alert_with_http_info(customer_id, alert_id, watchlist_alert, opts)
  nil
end

#update_watchlist_alert_with_http_info(customer_id, alert_id, watchlist_alert, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update watchlist alert

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • alert_id (String) —

    Unique identifier for this watchlist alert.

  • watchlist_alert (WatchlistAlert) —

    A watchlist body

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 370

def update_watchlist_alert_with_http_info(customer_id, alert_id, watchlist_alert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.update_watchlist_alert ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.update_watchlist_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 WatchlistDeprecatedApi.update_watchlist_alert"
  end
  # verify the required parameter 'watchlist_alert' is set
  if @api_client.config.client_side_validation && watchlist_alert.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_alert' when calling WatchlistDeprecatedApi.update_watchlist_alert"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/alerts/{alert_id}'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s)).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(watchlist_alert)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.update_watchlist_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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WatchlistDeprecatedApi#update_watchlist_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_watchlist_subscription(customer_id, subscription_id, watchlist_subscription, opts = {}) ⇒ WatchlistSubscription

Update watchlist monitoring subscription

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • subscription_id (String) —

    Watchlist monitoring subscription ID

  • watchlist_subscription (WatchlistSubscription) —

    Watchlist monitoring subscription to be updated. The only field that matters is &#x60;status&#x60;; all other fields are ignored.

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

    the optional parameters

Returns:



437
438
439
440
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 437

def update_watchlist_subscription(customer_id, subscription_id, watchlist_subscription, opts = {})
  data, _status_code, _headers = update_watchlist_subscription_with_http_info(customer_id, subscription_id, watchlist_subscription, opts)
  data
end

#update_watchlist_subscription_with_http_info(customer_id, subscription_id, watchlist_subscription, opts = {}) ⇒ Array<(WatchlistSubscription, Integer, Hash)>

Update watchlist monitoring subscription

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • subscription_id (String) —

    Watchlist monitoring subscription ID

  • watchlist_subscription (WatchlistSubscription) —

    Watchlist monitoring subscription to be updated. The only field that matters is &#x60;status&#x60;; all other fields are ignored.

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

    the optional parameters

Returns:

  • (Array<(WatchlistSubscription, Integer, Hash)>) —

    WatchlistSubscription data, response status code and response headers



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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 448

def update_watchlist_subscription_with_http_info(customer_id, subscription_id, watchlist_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.update_watchlist_subscription ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.update_watchlist_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 WatchlistDeprecatedApi.update_watchlist_subscription"
  end
  # verify the required parameter 'watchlist_subscription' is set
  if @api_client.config.client_side_validation && watchlist_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_subscription' when calling WatchlistDeprecatedApi.update_watchlist_subscription"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/subscriptions/{subscription_id}'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s)).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'])
  # 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(watchlist_subscription)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistSubscription'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.update_watchlist_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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WatchlistDeprecatedApi#update_watchlist_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_subscribe(customer_id, watchlist_subscription, opts = {}) ⇒ WatchlistSubscription

Subscribe a customer to watchlist monitoring

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • watchlist_subscription (WatchlistSubscription) —

    A watchlist subscription

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:



515
516
517
518
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 515

def watchlist_subscribe(customer_id, watchlist_subscription, opts = {})
  data, _status_code, _headers = watchlist_subscribe_with_http_info(customer_id, watchlist_subscription, opts)
  data
end

#watchlist_subscribe_with_http_info(customer_id, watchlist_subscription, opts = {}) ⇒ Array<(WatchlistSubscription, Integer, Hash)>

Subscribe a customer to watchlist monitoring

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • watchlist_subscription (WatchlistSubscription) —

    A watchlist subscription

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:

  • (Array<(WatchlistSubscription, Integer, Hash)>) —

    WatchlistSubscription data, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/synctera_ruby_sdk/api/watchlist_deprecated_api.rb', line 526

def watchlist_subscribe_with_http_info(customer_id, watchlist_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WatchlistDeprecatedApi.watchlist_subscribe ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling WatchlistDeprecatedApi.watchlist_subscribe"
  end
  # verify the required parameter 'watchlist_subscription' is set
  if @api_client.config.client_side_validation && watchlist_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_subscription' when calling WatchlistDeprecatedApi.watchlist_subscribe"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/watchlists/subscriptions'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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'])
  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_subscription)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistSubscription'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WatchlistDeprecatedApi.watchlist_subscribe",
    :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: WatchlistDeprecatedApi#watchlist_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end