Class: NucleusApi::UtilsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/utils_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UtilsApi

Returns a new instance of UtilsApi.



19
20
21
 
# File 'lib/nucleus_api/api/utils_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/nucleus_api/api/utils_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_application_using_post(application, opts = {}) ⇒ Application

Create an application Create an application

Parameters:

  • application —

    application

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nucleus_api/api/utils_api.rb', line 27

def create_application_using_post(application, opts = {})
  data, _status_code, _headers = create_application_using_post_with_http_info(application, opts)
  data
end

#create_application_using_post_with_http_info(application, opts = {}) ⇒ Array<(Application, Fixnum, Hash)>

Create an application Create an application

Parameters:

  • application —

    application

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

    the optional parameters

Returns:

  • (Array<(Application, Fixnum, Hash)>) —

    Application 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
 
# File 'lib/nucleus_api/api/utils_api.rb', line 37

def create_application_using_post_with_http_info(application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_application_using_post ...'
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling UtilsApi.create_application_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/application'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(application)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Application')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_application_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_audit_log_using_post(audit_log, opts = {}) ⇒ AuditLog

Create a audit log Create a new audit log.

Parameters:

  • audit_log —

    auditLog

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/nucleus_api/api/utils_api.rb', line 81

def create_audit_log_using_post(audit_log, opts = {})
  data, _status_code, _headers = create_audit_log_using_post_with_http_info(audit_log, opts)
  data
end

#create_audit_log_using_post_with_http_info(audit_log, opts = {}) ⇒ Array<(AuditLog, Fixnum, Hash)>

Create a audit log Create a new audit log.

Parameters:

  • audit_log —

    auditLog

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

    the optional parameters

Returns:

  • (Array<(AuditLog, Fixnum, Hash)>) —

    AuditLog data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
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
 
# File 'lib/nucleus_api/api/utils_api.rb', line 91

def create_audit_log_using_post_with_http_info(audit_log, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_audit_log_using_post ...'
  end
  # verify the required parameter 'audit_log' is set
  if @api_client.config.client_side_validation && audit_log.nil?
    fail ArgumentError, "Missing the required parameter 'audit_log' when calling UtilsApi.create_audit_log_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/audit_log'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(audit_log)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuditLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_audit_log_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_feature_track_using_post(feature_track, opts = {}) ⇒ FeatureTrack

Create a Feature Track Create a new feature track.

Parameters:

  • feature_track —

    featureTrack

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/nucleus_api/api/utils_api.rb', line 135

def create_feature_track_using_post(feature_track, opts = {})
  data, _status_code, _headers = create_feature_track_using_post_with_http_info(feature_track, opts)
  data
end

#create_feature_track_using_post_with_http_info(feature_track, opts = {}) ⇒ Array<(FeatureTrack, Fixnum, Hash)>

Create a Feature Track Create a new feature track.

Parameters:

  • feature_track —

    featureTrack

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

    the optional parameters

Returns:

  • (Array<(FeatureTrack, Fixnum, Hash)>) —

    FeatureTrack data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/nucleus_api/api/utils_api.rb', line 145

def create_feature_track_using_post_with_http_info(feature_track, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_feature_track_using_post ...'
  end
  # verify the required parameter 'feature_track' is set
  if @api_client.config.client_side_validation && feature_track.nil?
    fail ArgumentError, "Missing the required parameter 'feature_track' when calling UtilsApi.create_feature_track_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature_track'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(feature_track)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FeatureTrack')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_feature_track_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_feature_using_post(feature, opts = {}) ⇒ Feature

Create a Feature Create a new feature.

Parameters:

  • feature —

    feature

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/nucleus_api/api/utils_api.rb', line 189

def create_feature_using_post(feature, opts = {})
  data, _status_code, _headers = create_feature_using_post_with_http_info(feature, opts)
  data
end

#create_feature_using_post_with_http_info(feature, opts = {}) ⇒ Array<(Feature, Fixnum, Hash)>

Create a Feature Create a new feature.

Parameters:

  • feature —

    feature

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

    the optional parameters

Returns:

  • (Array<(Feature, Fixnum, Hash)>) —

    Feature data, response status code and response headers



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/nucleus_api/api/utils_api.rb', line 199

def create_feature_using_post_with_http_info(feature, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_feature_using_post ...'
  end
  # verify the required parameter 'feature' is set
  if @api_client.config.client_side_validation && feature.nil?
    fail ArgumentError, "Missing the required parameter 'feature' when calling UtilsApi.create_feature_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(feature)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Feature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_feature_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_notification_client_using_post(notification_client, opts = {}) ⇒ NotificationClient

Create a Notification Client Create a new Notification Client.

Parameters:

  • notification_client —

    notificationClient

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/nucleus_api/api/utils_api.rb', line 243

def create_notification_client_using_post(notification_client, opts = {})
  data, _status_code, _headers = create_notification_client_using_post_with_http_info(notification_client, opts)
  data
end

#create_notification_client_using_post_with_http_info(notification_client, opts = {}) ⇒ Array<(NotificationClient, Fixnum, Hash)>

Create a Notification Client Create a new Notification Client.

Parameters:

  • notification_client —

    notificationClient

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

    the optional parameters

Returns:

  • (Array<(NotificationClient, Fixnum, Hash)>) —

    NotificationClient data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/nucleus_api/api/utils_api.rb', line 253

def create_notification_client_using_post_with_http_info(notification_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_notification_client_using_post ...'
  end
  # verify the required parameter 'notification_client' is set
  if @api_client.config.client_side_validation && notification_client.nil?
    fail ArgumentError, "Missing the required parameter 'notification_client' when calling UtilsApi.create_notification_client_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_client'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(notification_client)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotificationClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_notification_client_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_notification_setting_using_post(notification_setting, opts = {}) ⇒ NotificationSetting

Create a Notification Setting Create a new Notification Setting.

Parameters:

  • notification_setting —

    notificationSetting

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/nucleus_api/api/utils_api.rb', line 297

def create_notification_setting_using_post(notification_setting, opts = {})
  data, _status_code, _headers = create_notification_setting_using_post_with_http_info(notification_setting, opts)
  data
end

#create_notification_setting_using_post_with_http_info(notification_setting, opts = {}) ⇒ Array<(NotificationSetting, Fixnum, Hash)>

Create a Notification Setting Create a new Notification Setting.

Parameters:

  • notification_setting —

    notificationSetting

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

    the optional parameters

Returns:

  • (Array<(NotificationSetting, Fixnum, Hash)>) —

    NotificationSetting data, response status code and response headers



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/nucleus_api/api/utils_api.rb', line 307

def create_notification_setting_using_post_with_http_info(notification_setting, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_notification_setting_using_post ...'
  end
  # verify the required parameter 'notification_setting' is set
  if @api_client.config.client_side_validation && notification_setting.nil?
    fail ArgumentError, "Missing the required parameter 'notification_setting' when calling UtilsApi.create_notification_setting_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_setting'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(notification_setting)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotificationSetting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_notification_setting_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_notification_using_post(notification, opts = {}) ⇒ Notification

Create a Notification Create a new Notification.

Parameters:

  • notification —

    notification

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

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/nucleus_api/api/utils_api.rb', line 351

def create_notification_using_post(notification, opts = {})
  data, _status_code, _headers = create_notification_using_post_with_http_info(notification, opts)
  data
end

#create_notification_using_post_with_http_info(notification, opts = {}) ⇒ Array<(Notification, Fixnum, Hash)>

Create a Notification Create a new Notification.

Parameters:

  • notification —

    notification

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

    the optional parameters

Returns:

  • (Array<(Notification, Fixnum, Hash)>) —

    Notification data, response status code and response headers



361
362
363
364
365
366
367
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
 
# File 'lib/nucleus_api/api/utils_api.rb', line 361

def create_notification_using_post_with_http_info(notification, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_notification_using_post ...'
  end
  # verify the required parameter 'notification' is set
  if @api_client.config.client_side_validation && notification.nil?
    fail ArgumentError, "Missing the required parameter 'notification' when calling UtilsApi.create_notification_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(notification)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Notification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_notification_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_reason_code_using_post(reason_code_request, opts = {}) ⇒ ReasonCode

Create a reason code Create a new reason code for your firm.

Parameters:

  • reason_code_request —

    reasonCodeRequest

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

    the optional parameters

Returns:



405
406
407
408
 
# File 'lib/nucleus_api/api/utils_api.rb', line 405

def create_reason_code_using_post(reason_code_request, opts = {})
  data, _status_code, _headers = create_reason_code_using_post_with_http_info(reason_code_request, opts)
  data
end

#create_reason_code_using_post_with_http_info(reason_code_request, opts = {}) ⇒ Array<(ReasonCode, Fixnum, Hash)>

Create a reason code Create a new reason code for your firm.

Parameters:

  • reason_code_request —

    reasonCodeRequest

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

    the optional parameters

Returns:

  • (Array<(ReasonCode, Fixnum, Hash)>) —

    ReasonCode data, response status code and response headers



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/nucleus_api/api/utils_api.rb', line 415

def create_reason_code_using_post_with_http_info(reason_code_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_reason_code_using_post ...'
  end
  # verify the required parameter 'reason_code_request' is set
  if @api_client.config.client_side_validation && reason_code_request.nil?
    fail ArgumentError, "Missing the required parameter 'reason_code_request' when calling UtilsApi.create_reason_code_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/reason_code'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(reason_code_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReasonCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_reason_code_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_stage_using_post(stage_request, opts = {}) ⇒ Stage

Create an account stage Create a new account stage

Parameters:

  • stage_request —

    stageRequest

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

    the optional parameters

Returns:



459
460
461
462
 
# File 'lib/nucleus_api/api/utils_api.rb', line 459

def create_stage_using_post(stage_request, opts = {})
  data, _status_code, _headers = create_stage_using_post_with_http_info(stage_request, opts)
  data
end

#create_stage_using_post_with_http_info(stage_request, opts = {}) ⇒ Array<(Stage, Fixnum, Hash)>

Create an account stage Create a new account stage

Parameters:

  • stage_request —

    stageRequest

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

    the optional parameters

Returns:

  • (Array<(Stage, Fixnum, Hash)>) —

    Stage data, response status code and response headers



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/nucleus_api/api/utils_api.rb', line 469

def create_stage_using_post_with_http_info(stage_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_stage_using_post ...'
  end
  # verify the required parameter 'stage_request' is set
  if @api_client.config.client_side_validation && stage_request.nil?
    fail ArgumentError, "Missing the required parameter 'stage_request' when calling UtilsApi.create_stage_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/stage'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stage_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Stage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_stage_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_transaction_code_using_post(transaction_request, opts = {}) ⇒ TransactionCode

Create a transaction code Create a new transaction code for your firm.

Parameters:

  • transaction_request —

    transactionRequest

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

    the optional parameters

Returns:

  • (TransactionCode) 


513
514
515
516
 
# File 'lib/nucleus_api/api/utils_api.rb', line 513

def create_transaction_code_using_post(transaction_request, opts = {})
  data, _status_code, _headers = create_transaction_code_using_post_with_http_info(transaction_request, opts)
  data
end

#create_transaction_code_using_post_with_http_info(transaction_request, opts = {}) ⇒ Array<(TransactionCode, Fixnum, Hash)>

Create a transaction code Create a new transaction code for your firm.

Parameters:

  • transaction_request —

    transactionRequest

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

    the optional parameters

Returns:

  • (Array<(TransactionCode, Fixnum, Hash)>) —

    TransactionCode data, response status code and response headers



523
524
525
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
 
# File 'lib/nucleus_api/api/utils_api.rb', line 523

def create_transaction_code_using_post_with_http_info(transaction_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_transaction_code_using_post ...'
  end
  # verify the required parameter 'transaction_request' is set
  if @api_client.config.client_side_validation && transaction_request.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_request' when calling UtilsApi.create_transaction_code_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/transaction_code'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(transaction_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TransactionCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_transaction_code_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_application_using_delete(application_id, opts = {}) ⇒ nil

Delete an Application Permanently delete an Application.

Parameters:

  • application_id —

    UUID application_id

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

    the optional parameters

Returns:

  • (nil) 


567
568
569
570
 
# File 'lib/nucleus_api/api/utils_api.rb', line 567

def delete_application_using_delete(application_id, opts = {})
  delete_application_using_delete_with_http_info(application_id, opts)
  nil
end

#delete_application_using_delete_with_http_info(application_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an Application Permanently delete an Application.

Parameters:

  • application_id —

    UUID application_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/nucleus_api/api/utils_api.rb', line 577

def delete_application_using_delete_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_application_using_delete ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling UtilsApi.delete_application_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/application/{application_id}'.sub('{' + 'application_id' + '}', application_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_application_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_feature_track_using_delete(feature_track_id, opts = {}) ⇒ nil

Delete a Feature Track Permanently delete a feature track registered with your firm.

Parameters:

  • feature_track_id —

    UUID feature_track_id

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

    the optional parameters

Returns:

  • (nil) 


618
619
620
621
 
# File 'lib/nucleus_api/api/utils_api.rb', line 618

def delete_feature_track_using_delete(feature_track_id, opts = {})
  delete_feature_track_using_delete_with_http_info(feature_track_id, opts)
  nil
end

#delete_feature_track_using_delete_with_http_info(feature_track_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Feature Track Permanently delete a feature track registered with your firm.

Parameters:

  • feature_track_id —

    UUID feature_track_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/nucleus_api/api/utils_api.rb', line 628

def delete_feature_track_using_delete_with_http_info(feature_track_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_feature_track_using_delete ...'
  end
  # verify the required parameter 'feature_track_id' is set
  if @api_client.config.client_side_validation && feature_track_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_track_id' when calling UtilsApi.delete_feature_track_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature_track/{feature_track_id}'.sub('{' + 'feature_track_id' + '}', feature_track_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_feature_track_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_feature_using_delete(feature_id, opts = {}) ⇒ nil

Delete a Feature Permanently delete a feature registered with your firm.

Parameters:

  • feature_id —

    UUID feature_id

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

    the optional parameters

Returns:

  • (nil) 


669
670
671
672
 
# File 'lib/nucleus_api/api/utils_api.rb', line 669

def delete_feature_using_delete(feature_id, opts = {})
  delete_feature_using_delete_with_http_info(feature_id, opts)
  nil
end

#delete_feature_using_delete_with_http_info(feature_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Feature Permanently delete a feature registered with your firm.

Parameters:

  • feature_id —

    UUID feature_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/nucleus_api/api/utils_api.rb', line 679

def delete_feature_using_delete_with_http_info(feature_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_feature_using_delete ...'
  end
  # verify the required parameter 'feature_id' is set
  if @api_client.config.client_side_validation && feature_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_id' when calling UtilsApi.delete_feature_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature/{feature_id}'.sub('{' + 'feature_id' + '}', feature_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_feature_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_notification_client_using_delete(notification_client_id, opts = {}) ⇒ nil

Delete a Notification Client Permanently Delete Notification Client.

Parameters:

  • notification_client_id —

    notification_client_id

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

    the optional parameters

Returns:

  • (nil) 


720
721
722
723
 
# File 'lib/nucleus_api/api/utils_api.rb', line 720

def delete_notification_client_using_delete(notification_client_id, opts = {})
  delete_notification_client_using_delete_with_http_info(notification_client_id, opts)
  nil
end

#delete_notification_client_using_delete_with_http_info(notification_client_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Notification Client Permanently Delete Notification Client.

Parameters:

  • notification_client_id —

    notification_client_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/nucleus_api/api/utils_api.rb', line 730

def delete_notification_client_using_delete_with_http_info(notification_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_notification_client_using_delete ...'
  end
  # verify the required parameter 'notification_client_id' is set
  if @api_client.config.client_side_validation && notification_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_client_id' when calling UtilsApi.delete_notification_client_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_client/{notification_client_id}'.sub('{' + 'notification_client_id' + '}', notification_client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_notification_client_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_notification_setting_using_delete(notification_setting_id, opts = {}) ⇒ nil

Delete a Notification Setting Permanently Delete Notification Setting.

Parameters:

  • notification_setting_id —

    notification_setting_id

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

    the optional parameters

Returns:

  • (nil) 


771
772
773
774
 
# File 'lib/nucleus_api/api/utils_api.rb', line 771

def delete_notification_setting_using_delete(notification_setting_id, opts = {})
  delete_notification_setting_using_delete_with_http_info(notification_setting_id, opts)
  nil
end

#delete_notification_setting_using_delete_with_http_info(notification_setting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Notification Setting Permanently Delete Notification Setting.

Parameters:

  • notification_setting_id —

    notification_setting_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/nucleus_api/api/utils_api.rb', line 781

def delete_notification_setting_using_delete_with_http_info(notification_setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_notification_setting_using_delete ...'
  end
  # verify the required parameter 'notification_setting_id' is set
  if @api_client.config.client_side_validation && notification_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_setting_id' when calling UtilsApi.delete_notification_setting_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_setting/{notification_setting_id}'.sub('{' + 'notification_setting_id' + '}', notification_setting_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_notification_setting_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_notification_using_delete(notification_id, opts = {}) ⇒ nil

Delete a Notification Permanently Delete a Notification.

Parameters:

  • notification_id —

    UUID notification_id

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

    the optional parameters

Returns:

  • (nil) 


822
823
824
825
 
# File 'lib/nucleus_api/api/utils_api.rb', line 822

def delete_notification_using_delete(notification_id, opts = {})
  delete_notification_using_delete_with_http_info(notification_id, opts)
  nil
end

#delete_notification_using_delete_with_http_info(notification_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Notification Permanently Delete a Notification.

Parameters:

  • notification_id —

    UUID notification_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'lib/nucleus_api/api/utils_api.rb', line 832

def delete_notification_using_delete_with_http_info(notification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_notification_using_delete ...'
  end
  # verify the required parameter 'notification_id' is set
  if @api_client.config.client_side_validation && notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_id' when calling UtilsApi.delete_notification_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification/{notification_id}'.sub('{' + 'notification_id' + '}', notification_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_notification_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_reason_code_using_delete(reason_code_id, opts = {}) ⇒ nil

Delete a reason code Permanently delete a reason code for your firm.

Parameters:

  • reason_code_id —

    UUID reason_code_id

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

    the optional parameters

Returns:

  • (nil) 


873
874
875
876
 
# File 'lib/nucleus_api/api/utils_api.rb', line 873

def delete_reason_code_using_delete(reason_code_id, opts = {})
  delete_reason_code_using_delete_with_http_info(reason_code_id, opts)
  nil
end

#delete_reason_code_using_delete_with_http_info(reason_code_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a reason code Permanently delete a reason code for your firm.

Parameters:

  • reason_code_id —

    UUID reason_code_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/nucleus_api/api/utils_api.rb', line 883

def delete_reason_code_using_delete_with_http_info(reason_code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_reason_code_using_delete ...'
  end
  # verify the required parameter 'reason_code_id' is set
  if @api_client.config.client_side_validation && reason_code_id.nil?
    fail ArgumentError, "Missing the required parameter 'reason_code_id' when calling UtilsApi.delete_reason_code_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/reason_code/{reason_code_id}'.sub('{' + 'reason_code_id' + '}', reason_code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_reason_code_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_stage_using_delete(stage_id, opts = {}) ⇒ nil

Delete an account stage Permanently delete an account stage.

Parameters:

  • stage_id —

    UUID stage_id

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

    the optional parameters

Returns:

  • (nil) 


924
925
926
927
 
# File 'lib/nucleus_api/api/utils_api.rb', line 924

def delete_stage_using_delete(stage_id, opts = {})
  delete_stage_using_delete_with_http_info(stage_id, opts)
  nil
end

#delete_stage_using_delete_with_http_info(stage_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an account stage Permanently delete an account stage.

Parameters:

  • stage_id —

    UUID stage_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/nucleus_api/api/utils_api.rb', line 934

def delete_stage_using_delete_with_http_info(stage_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_stage_using_delete ...'
  end
  # verify the required parameter 'stage_id' is set
  if @api_client.config.client_side_validation && stage_id.nil?
    fail ArgumentError, "Missing the required parameter 'stage_id' when calling UtilsApi.delete_stage_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/stage/{stage_id}'.sub('{' + 'stage_id' + '}', stage_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_stage_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_transaction_code_using_delete(transaction_code_id, opts = {}) ⇒ nil

Delete a transaction code Permanently delete a transaction code for your firm.

Parameters:

  • transaction_code_id —

    UUID transaction_code_id

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

    the optional parameters

Returns:

  • (nil) 


975
976
977
978
 
# File 'lib/nucleus_api/api/utils_api.rb', line 975

def delete_transaction_code_using_delete(transaction_code_id, opts = {})
  delete_transaction_code_using_delete_with_http_info(transaction_code_id, opts)
  nil
end

#delete_transaction_code_using_delete_with_http_info(transaction_code_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a transaction code Permanently delete a transaction code for your firm.

Parameters:

  • transaction_code_id —

    UUID transaction_code_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/nucleus_api/api/utils_api.rb', line 985

def delete_transaction_code_using_delete_with_http_info(transaction_code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.delete_transaction_code_using_delete ...'
  end
  # verify the required parameter 'transaction_code_id' is set
  if @api_client.config.client_side_validation && transaction_code_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_code_id' when calling UtilsApi.delete_transaction_code_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/transaction_code/{transaction_code_id}'.sub('{' + 'transaction_code_id' + '}', transaction_code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#delete_transaction_code_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_all_using_get(opts = {}) ⇒ PageApplication

List all Application Get details for all Application.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1030
1031
1032
1033
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1030

def get_application_all_using_get(opts = {})
  data, _status_code, _headers = get_application_all_using_get_with_http_info(opts)
  data
end

#get_application_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageApplication, Fixnum, Hash)>

List all Application Get details for all Application.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageApplication, Fixnum, Hash)>) —

    PageApplication data, response status code and response headers



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1044

def get_application_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_application_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/application'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageApplication')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_application_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_using_get(application_id, opts = {}) ⇒ Application

Retrieve an Application Retrieve the information for an Application.

Parameters:

  • application_id —

    UUID application_id

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

    the optional parameters

Returns:



1087
1088
1089
1090
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1087

def get_application_using_get(application_id, opts = {})
  data, _status_code, _headers = get_application_using_get_with_http_info(application_id, opts)
  data
end

#get_application_using_get_with_http_info(application_id, opts = {}) ⇒ Array<(Application, Fixnum, Hash)>

Retrieve an Application Retrieve the information for an Application.

Parameters:

  • application_id —

    UUID application_id

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

    the optional parameters

Returns:

  • (Array<(Application, Fixnum, Hash)>) —

    Application data, response status code and response headers



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1097

def get_application_using_get_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_application_using_get ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling UtilsApi.get_application_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/application/{application_id}'.sub('{' + 'application_id' + '}', application_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Application')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_application_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_audit_log_all_using_get(opts = {}) ⇒ PageAuditLog

List all audit log Get details for all audit log.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1143
1144
1145
1146
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1143

def get_audit_log_all_using_get(opts = {})
  data, _status_code, _headers = get_audit_log_all_using_get_with_http_info(opts)
  data
end

#get_audit_log_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAuditLog, Fixnum, Hash)>

List all audit log Get details for all audit log.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageAuditLog, Fixnum, Hash)>) —

    PageAuditLog data, response status code and response headers



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1157

def get_audit_log_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_audit_log_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/audit_log'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageAuditLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_audit_log_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_audit_log_using_get(audit_log_id, opts = {}) ⇒ AuditLog

Retrieve a audit log Retrieve the information for a audit log.

Parameters:

  • audit_log_id —

    UUID audit_log_id

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

    the optional parameters

Returns:



1200
1201
1202
1203
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1200

def get_audit_log_using_get(audit_log_id, opts = {})
  data, _status_code, _headers = get_audit_log_using_get_with_http_info(audit_log_id, opts)
  data
end

#get_audit_log_using_get_with_http_info(audit_log_id, opts = {}) ⇒ Array<(AuditLog, Fixnum, Hash)>

Retrieve a audit log Retrieve the information for a audit log.

Parameters:

  • audit_log_id —

    UUID audit_log_id

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

    the optional parameters

Returns:

  • (Array<(AuditLog, Fixnum, Hash)>) —

    AuditLog data, response status code and response headers



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1210

def get_audit_log_using_get_with_http_info(audit_log_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_audit_log_using_get ...'
  end
  # verify the required parameter 'audit_log_id' is set
  if @api_client.config.client_side_validation && audit_log_id.nil?
    fail ArgumentError, "Missing the required parameter 'audit_log_id' when calling UtilsApi.get_audit_log_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/audit_log/{audit_log_id}'.sub('{' + 'audit_log_id' + '}', audit_log_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuditLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_audit_log_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_feature_all_using_get(opts = {}) ⇒ PageFeature

List all Feature Get details for all features.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1256
1257
1258
1259
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1256

def get_feature_all_using_get(opts = {})
  data, _status_code, _headers = get_feature_all_using_get_with_http_info(opts)
  data
end

#get_feature_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageFeature, Fixnum, Hash)>

List all Feature Get details for all features.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageFeature, Fixnum, Hash)>) —

    PageFeature data, response status code and response headers



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1270

def get_feature_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_feature_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/feature'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageFeature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_feature_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_feature_track_all_using_get(opts = {}) ⇒ PageFeatureTrack

List all Feature track Get details for all feature track.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1317
1318
1319
1320
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1317

def get_feature_track_all_using_get(opts = {})
  data, _status_code, _headers = get_feature_track_all_using_get_with_http_info(opts)
  data
end

#get_feature_track_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageFeatureTrack, Fixnum, Hash)>

List all Feature track Get details for all feature track.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageFeatureTrack, Fixnum, Hash)>) —

    PageFeatureTrack data, response status code and response headers



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1331

def get_feature_track_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_feature_track_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/feature_track'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageFeatureTrack')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_feature_track_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_feature_track_using_get(feature_track_id, opts = {}) ⇒ FeatureTrack

Retrieve a Feature track Retrieve the information for a Feature track.

Parameters:

  • feature_track_id —

    UUID feature_track_id

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

    the optional parameters

Returns:



1374
1375
1376
1377
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1374

def get_feature_track_using_get(feature_track_id, opts = {})
  data, _status_code, _headers = get_feature_track_using_get_with_http_info(feature_track_id, opts)
  data
end

#get_feature_track_using_get_with_http_info(feature_track_id, opts = {}) ⇒ Array<(FeatureTrack, Fixnum, Hash)>

Retrieve a Feature track Retrieve the information for a Feature track.

Parameters:

  • feature_track_id —

    UUID feature_track_id

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

    the optional parameters

Returns:

  • (Array<(FeatureTrack, Fixnum, Hash)>) —

    FeatureTrack data, response status code and response headers



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1384

def get_feature_track_using_get_with_http_info(feature_track_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_feature_track_using_get ...'
  end
  # verify the required parameter 'feature_track_id' is set
  if @api_client.config.client_side_validation && feature_track_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_track_id' when calling UtilsApi.get_feature_track_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature_track/{feature_track_id}'.sub('{' + 'feature_track_id' + '}', feature_track_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FeatureTrack')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_feature_track_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_feature_using_get(feature_id, opts = {}) ⇒ Feature

Retrieve a Feature Retrieve the information for a Feature.

Parameters:

  • feature_id —

    UUID feature_id

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

    the optional parameters

Returns:



1426
1427
1428
1429
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1426

def get_feature_using_get(feature_id, opts = {})
  data, _status_code, _headers = get_feature_using_get_with_http_info(feature_id, opts)
  data
end

#get_feature_using_get_with_http_info(feature_id, opts = {}) ⇒ Array<(Feature, Fixnum, Hash)>

Retrieve a Feature Retrieve the information for a Feature.

Parameters:

  • feature_id —

    UUID feature_id

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

    the optional parameters

Returns:

  • (Array<(Feature, Fixnum, Hash)>) —

    Feature data, response status code and response headers



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1436

def get_feature_using_get_with_http_info(feature_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_feature_using_get ...'
  end
  # verify the required parameter 'feature_id' is set
  if @api_client.config.client_side_validation && feature_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_id' when calling UtilsApi.get_feature_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature/{feature_id}'.sub('{' + 'feature_id' + '}', feature_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Feature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_feature_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_all_using_get(opts = {}) ⇒ PageNotification

Get All Notifications Get All Notification.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1482
1483
1484
1485
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1482

def get_notification_all_using_get(opts = {})
  data, _status_code, _headers = get_notification_all_using_get_with_http_info(opts)
  data
end

#get_notification_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageNotification, Fixnum, Hash)>

Get All Notifications Get All Notification.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageNotification, Fixnum, Hash)>) —

    PageNotification data, response status code and response headers



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1496

def get_notification_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_notification_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/notification'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageNotification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_notification_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_client_all_using_get(opts = {}) ⇒ PageNotificationClient

List all Notification Client List all Notification Client.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1543
1544
1545
1546
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1543

def get_notification_client_all_using_get(opts = {})
  data, _status_code, _headers = get_notification_client_all_using_get_with_http_info(opts)
  data
end

#get_notification_client_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageNotificationClient, Fixnum, Hash)>

List all Notification Client List all Notification Client.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageNotificationClient, Fixnum, Hash)>) —

    PageNotificationClient data, response status code and response headers



1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1557

def get_notification_client_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_notification_client_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_client'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageNotificationClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_notification_client_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_client_using_get(notification_client_id, opts = {}) ⇒ NotificationClient

Retrieve a Notification Client Retrieve a Notification Client.

Parameters:

  • notification_client_id —

    notification_client_id

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

    the optional parameters

Returns:



1600
1601
1602
1603
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1600

def get_notification_client_using_get(notification_client_id, opts = {})
  data, _status_code, _headers = get_notification_client_using_get_with_http_info(notification_client_id, opts)
  data
end

#get_notification_client_using_get_with_http_info(notification_client_id, opts = {}) ⇒ Array<(NotificationClient, Fixnum, Hash)>

Retrieve a Notification Client Retrieve a Notification Client.

Parameters:

  • notification_client_id —

    notification_client_id

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

    the optional parameters

Returns:

  • (Array<(NotificationClient, Fixnum, Hash)>) —

    NotificationClient data, response status code and response headers



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1610

def get_notification_client_using_get_with_http_info(notification_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_notification_client_using_get ...'
  end
  # verify the required parameter 'notification_client_id' is set
  if @api_client.config.client_side_validation && notification_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_client_id' when calling UtilsApi.get_notification_client_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_client/{notification_client_id}'.sub('{' + 'notification_client_id' + '}', notification_client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotificationClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_notification_client_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_setting_all_using_get(opts = {}) ⇒ PageNotificationSetting

List all Notification Setting List all Notification Setting.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1656
1657
1658
1659
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1656

def get_notification_setting_all_using_get(opts = {})
  data, _status_code, _headers = get_notification_setting_all_using_get_with_http_info(opts)
  data
end

#get_notification_setting_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageNotificationSetting, Fixnum, Hash)>

List all Notification Setting List all Notification Setting.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageNotificationSetting, Fixnum, Hash)>) —

    PageNotificationSetting data, response status code and response headers



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1670

def get_notification_setting_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_notification_setting_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_setting'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageNotificationSetting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_notification_setting_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_setting_using_get(notification_setting_id, opts = {}) ⇒ NotificationSetting

Retrieve a Notification Setting Retrieve a Notification Setting.

Parameters:

  • notification_setting_id —

    notification_setting_id

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

    the optional parameters

Returns:



1713
1714
1715
1716
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1713

def get_notification_setting_using_get(notification_setting_id, opts = {})
  data, _status_code, _headers = get_notification_setting_using_get_with_http_info(notification_setting_id, opts)
  data
end

#get_notification_setting_using_get_with_http_info(notification_setting_id, opts = {}) ⇒ Array<(NotificationSetting, Fixnum, Hash)>

Retrieve a Notification Setting Retrieve a Notification Setting.

Parameters:

  • notification_setting_id —

    notification_setting_id

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

    the optional parameters

Returns:

  • (Array<(NotificationSetting, Fixnum, Hash)>) —

    NotificationSetting data, response status code and response headers



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1723

def get_notification_setting_using_get_with_http_info(notification_setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_notification_setting_using_get ...'
  end
  # verify the required parameter 'notification_setting_id' is set
  if @api_client.config.client_side_validation && notification_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_setting_id' when calling UtilsApi.get_notification_setting_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_setting/{notification_setting_id}'.sub('{' + 'notification_setting_id' + '}', notification_setting_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotificationSetting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_notification_setting_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_using_get(notification_id, opts = {}) ⇒ Notification

Get a Notification Get a Notification.

Parameters:

  • notification_id —

    notification_id

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

    the optional parameters

Returns:



1765
1766
1767
1768
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1765

def get_notification_using_get(notification_id, opts = {})
  data, _status_code, _headers = get_notification_using_get_with_http_info(notification_id, opts)
  data
end

#get_notification_using_get_with_http_info(notification_id, opts = {}) ⇒ Array<(Notification, Fixnum, Hash)>

Get a Notification Get a Notification.

Parameters:

  • notification_id —

    notification_id

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

    the optional parameters

Returns:

  • (Array<(Notification, Fixnum, Hash)>) —

    Notification data, response status code and response headers



1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1775

def get_notification_using_get_with_http_info(notification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_notification_using_get ...'
  end
  # verify the required parameter 'notification_id' is set
  if @api_client.config.client_side_validation && notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_id' when calling UtilsApi.get_notification_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification/{notification_id}'.sub('{' + 'notification_id' + '}', notification_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Notification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_notification_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reason_code_all_using_get(opts = {}) ⇒ PageReasonCode

List all reason codes Get the information for all reason codes defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1821
1822
1823
1824
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1821

def get_reason_code_all_using_get(opts = {})
  data, _status_code, _headers = get_reason_code_all_using_get_with_http_info(opts)
  data
end

#get_reason_code_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageReasonCode, Fixnum, Hash)>

List all reason codes Get the information for all reason codes defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageReasonCode, Fixnum, Hash)>) —

    PageReasonCode data, response status code and response headers



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1835

def get_reason_code_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_reason_code_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/reason_code'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageReasonCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_reason_code_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reason_code_using_get(reason_code_id, opts = {}) ⇒ ReasonCode

Retrieve a reason code Retrieve the information for a reason code defined by your firm.

Parameters:

  • reason_code_id —

    UUID reason_code_id

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

    the optional parameters

Returns:



1878
1879
1880
1881
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1878

def get_reason_code_using_get(reason_code_id, opts = {})
  data, _status_code, _headers = get_reason_code_using_get_with_http_info(reason_code_id, opts)
  data
end

#get_reason_code_using_get_with_http_info(reason_code_id, opts = {}) ⇒ Array<(ReasonCode, Fixnum, Hash)>

Retrieve a reason code Retrieve the information for a reason code defined by your firm.

Parameters:

  • reason_code_id —

    UUID reason_code_id

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

    the optional parameters

Returns:

  • (Array<(ReasonCode, Fixnum, Hash)>) —

    ReasonCode data, response status code and response headers



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1888

def get_reason_code_using_get_with_http_info(reason_code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_reason_code_using_get ...'
  end
  # verify the required parameter 'reason_code_id' is set
  if @api_client.config.client_side_validation && reason_code_id.nil?
    fail ArgumentError, "Missing the required parameter 'reason_code_id' when calling UtilsApi.get_reason_code_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/reason_code/{reason_code_id}'.sub('{' + 'reason_code_id' + '}', reason_code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReasonCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_reason_code_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stage_all_using_get(opts = {}) ⇒ PageStage

List all account stages Get the information for all possible account stages.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1934
1935
1936
1937
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1934

def get_stage_all_using_get(opts = {})
  data, _status_code, _headers = get_stage_all_using_get_with_http_info(opts)
  data
end

#get_stage_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageStage, Fixnum, Hash)>

List all account stages Get the information for all possible account stages.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageStage, Fixnum, Hash)>) —

    PageStage data, response status code and response headers



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1948

def get_stage_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_stage_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/stage'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageStage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_stage_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stage_using_get(stage_id, opts = {}) ⇒ Stage

Retrieve an account stage Retrieve the information for a specific account stage.

Parameters:

  • stage_id —

    UUID stage_id

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

    the optional parameters

Returns:



1991
1992
1993
1994
 
# File 'lib/nucleus_api/api/utils_api.rb', line 1991

def get_stage_using_get(stage_id, opts = {})
  data, _status_code, _headers = get_stage_using_get_with_http_info(stage_id, opts)
  data
end

#get_stage_using_get_with_http_info(stage_id, opts = {}) ⇒ Array<(Stage, Fixnum, Hash)>

Retrieve an account stage Retrieve the information for a specific account stage.

Parameters:

  • stage_id —

    UUID stage_id

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

    the optional parameters

Returns:

  • (Array<(Stage, Fixnum, Hash)>) —

    Stage data, response status code and response headers



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2001

def get_stage_using_get_with_http_info(stage_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_stage_using_get ...'
  end
  # verify the required parameter 'stage_id' is set
  if @api_client.config.client_side_validation && stage_id.nil?
    fail ArgumentError, "Missing the required parameter 'stage_id' when calling UtilsApi.get_stage_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/stage/{stage_id}'.sub('{' + 'stage_id' + '}', stage_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Stage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_stage_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transaction_code_all_using_get(opts = {}) ⇒ PageTransactionCode

List all transaction codes Get the information for all transaction codes defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



2047
2048
2049
2050
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2047

def get_transaction_code_all_using_get(opts = {})
  data, _status_code, _headers = get_transaction_code_all_using_get_with_http_info(opts)
  data
end

#get_transaction_code_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageTransactionCode, Fixnum, Hash)>

List all transaction codes Get the information for all transaction codes defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageTransactionCode, Fixnum, Hash)>) —

    PageTransactionCode data, response status code and response headers



2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2061

def get_transaction_code_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_transaction_code_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/transaction_code'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageTransactionCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_transaction_code_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transaction_code_using_get(transaction_code_id, opts = {}) ⇒ TransactionCode

Retrieve a transaction code Retrieve the information for a transaction code defined by your firm.

Parameters:

  • transaction_code_id —

    UUID transaction_code_id

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

    the optional parameters

Returns:

  • (TransactionCode) 


2104
2105
2106
2107
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2104

def get_transaction_code_using_get(transaction_code_id, opts = {})
  data, _status_code, _headers = get_transaction_code_using_get_with_http_info(transaction_code_id, opts)
  data
end

#get_transaction_code_using_get_with_http_info(transaction_code_id, opts = {}) ⇒ Array<(TransactionCode, Fixnum, Hash)>

Retrieve a transaction code Retrieve the information for a transaction code defined by your firm.

Parameters:

  • transaction_code_id —

    UUID transaction_code_id

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

    the optional parameters

Returns:

  • (Array<(TransactionCode, Fixnum, Hash)>) —

    TransactionCode data, response status code and response headers



2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2114

def get_transaction_code_using_get_with_http_info(transaction_code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_transaction_code_using_get ...'
  end
  # verify the required parameter 'transaction_code_id' is set
  if @api_client.config.client_side_validation && transaction_code_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_code_id' when calling UtilsApi.get_transaction_code_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/transaction_code/{transaction_code_id}'.sub('{' + 'transaction_code_id' + '}', transaction_code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TransactionCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_transaction_code_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_application_using_put(application, application_id, opts = {}) ⇒ Application

Update an Application Update the information for an Application

Parameters:

  • application —

    application

  • application_id —

    UUID application_id

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

    the optional parameters

Returns:



2157
2158
2159
2160
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2157

def update_application_using_put(application, application_id, opts = {})
  data, _status_code, _headers = update_application_using_put_with_http_info(application, application_id, opts)
  data
end

#update_application_using_put_with_http_info(application, application_id, opts = {}) ⇒ Array<(Application, Fixnum, Hash)>

Update an Application Update the information for an Application

Parameters:

  • application —

    application

  • application_id —

    UUID application_id

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

    the optional parameters

Returns:

  • (Array<(Application, Fixnum, Hash)>) —

    Application data, response status code and response headers



2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2168

def update_application_using_put_with_http_info(application, application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_application_using_put ...'
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling UtilsApi.update_application_using_put"
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling UtilsApi.update_application_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/application/{application_id}'.sub('{' + 'application_id' + '}', application_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(application)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Application')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_application_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_feature_track_using_put(feature_track, feature_track_id, opts = {}) ⇒ FeatureTrack

Update a Feature Track Update the information for a Feature track registered with your firm.

Parameters:

  • feature_track —

    feature_track

  • feature_track_id —

    UUID feature_track_id

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

    the optional parameters

Returns:



2217
2218
2219
2220
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2217

def update_feature_track_using_put(feature_track, feature_track_id, opts = {})
  data, _status_code, _headers = update_feature_track_using_put_with_http_info(feature_track, feature_track_id, opts)
  data
end

#update_feature_track_using_put_with_http_info(feature_track, feature_track_id, opts = {}) ⇒ Array<(FeatureTrack, Fixnum, Hash)>

Update a Feature Track Update the information for a Feature track registered with your firm.

Parameters:

  • feature_track —

    feature_track

  • feature_track_id —

    UUID feature_track_id

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

    the optional parameters

Returns:

  • (Array<(FeatureTrack, Fixnum, Hash)>) —

    FeatureTrack data, response status code and response headers



2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2228

def update_feature_track_using_put_with_http_info(feature_track, feature_track_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_feature_track_using_put ...'
  end
  # verify the required parameter 'feature_track' is set
  if @api_client.config.client_side_validation && feature_track.nil?
    fail ArgumentError, "Missing the required parameter 'feature_track' when calling UtilsApi.update_feature_track_using_put"
  end
  # verify the required parameter 'feature_track_id' is set
  if @api_client.config.client_side_validation && feature_track_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_track_id' when calling UtilsApi.update_feature_track_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature_track/{feature_track_id}'.sub('{' + 'feature_track_id' + '}', feature_track_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(feature_track)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FeatureTrack')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_feature_track_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_feature_using_put(feature, feature_id, opts = {}) ⇒ Feature

Update a Feature Update the information for a Feature registered with your firm.

Parameters:

  • feature —

    feature

  • feature_id —

    UUID feature_id

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

    the optional parameters

Returns:



2277
2278
2279
2280
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2277

def update_feature_using_put(feature, feature_id, opts = {})
  data, _status_code, _headers = update_feature_using_put_with_http_info(feature, feature_id, opts)
  data
end

#update_feature_using_put_with_http_info(feature, feature_id, opts = {}) ⇒ Array<(Feature, Fixnum, Hash)>

Update a Feature Update the information for a Feature registered with your firm.

Parameters:

  • feature —

    feature

  • feature_id —

    UUID feature_id

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

    the optional parameters

Returns:

  • (Array<(Feature, Fixnum, Hash)>) —

    Feature data, response status code and response headers



2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2288

def update_feature_using_put_with_http_info(feature, feature_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_feature_using_put ...'
  end
  # verify the required parameter 'feature' is set
  if @api_client.config.client_side_validation && feature.nil?
    fail ArgumentError, "Missing the required parameter 'feature' when calling UtilsApi.update_feature_using_put"
  end
  # verify the required parameter 'feature_id' is set
  if @api_client.config.client_side_validation && feature_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_id' when calling UtilsApi.update_feature_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/feature/{feature_id}'.sub('{' + 'feature_id' + '}', feature_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(feature)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Feature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_feature_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notification_client_using_put(notification_client, notification_client_id, opts = {}) ⇒ NotificationClient

Update a Notification Client Update a Notification Client.

Parameters:

  • notification_client —

    notification_client

  • notification_client_id —

    UUID notification_client_id

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

    the optional parameters

Returns:



2337
2338
2339
2340
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2337

def update_notification_client_using_put(notification_client, notification_client_id, opts = {})
  data, _status_code, _headers = update_notification_client_using_put_with_http_info(notification_client, notification_client_id, opts)
  data
end

#update_notification_client_using_put_with_http_info(notification_client, notification_client_id, opts = {}) ⇒ Array<(NotificationClient, Fixnum, Hash)>

Update a Notification Client Update a Notification Client.

Parameters:

  • notification_client —

    notification_client

  • notification_client_id —

    UUID notification_client_id

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

    the optional parameters

Returns:

  • (Array<(NotificationClient, Fixnum, Hash)>) —

    NotificationClient data, response status code and response headers



2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2348

def update_notification_client_using_put_with_http_info(notification_client, notification_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_notification_client_using_put ...'
  end
  # verify the required parameter 'notification_client' is set
  if @api_client.config.client_side_validation && notification_client.nil?
    fail ArgumentError, "Missing the required parameter 'notification_client' when calling UtilsApi.update_notification_client_using_put"
  end
  # verify the required parameter 'notification_client_id' is set
  if @api_client.config.client_side_validation && notification_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_client_id' when calling UtilsApi.update_notification_client_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_client/{notification_client_id}'.sub('{' + 'notification_client_id' + '}', notification_client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(notification_client)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotificationClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_notification_client_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notification_setting_using_put(notification_setting, notification_setting_id, opts = {}) ⇒ NotificationSetting

Update a Notification Setting Update a Notification Setting.

Parameters:

  • notification_setting —

    notification_setting

  • notification_setting_id —

    UUID notification_setting_id

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

    the optional parameters

Returns:



2397
2398
2399
2400
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2397

def update_notification_setting_using_put(notification_setting, notification_setting_id, opts = {})
  data, _status_code, _headers = update_notification_setting_using_put_with_http_info(notification_setting, notification_setting_id, opts)
  data
end

#update_notification_setting_using_put_with_http_info(notification_setting, notification_setting_id, opts = {}) ⇒ Array<(NotificationSetting, Fixnum, Hash)>

Update a Notification Setting Update a Notification Setting.

Parameters:

  • notification_setting —

    notification_setting

  • notification_setting_id —

    UUID notification_setting_id

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

    the optional parameters

Returns:

  • (Array<(NotificationSetting, Fixnum, Hash)>) —

    NotificationSetting data, response status code and response headers



2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2408

def update_notification_setting_using_put_with_http_info(notification_setting, notification_setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_notification_setting_using_put ...'
  end
  # verify the required parameter 'notification_setting' is set
  if @api_client.config.client_side_validation && notification_setting.nil?
    fail ArgumentError, "Missing the required parameter 'notification_setting' when calling UtilsApi.update_notification_setting_using_put"
  end
  # verify the required parameter 'notification_setting_id' is set
  if @api_client.config.client_side_validation && notification_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_setting_id' when calling UtilsApi.update_notification_setting_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification_setting/{notification_setting_id}'.sub('{' + 'notification_setting_id' + '}', notification_setting_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(notification_setting)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotificationSetting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_notification_setting_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notification_using_put(notification, notification_id, opts = {}) ⇒ Notification

Update a Notification Update a Notification.

Parameters:

  • notification —

    notification

  • notification_id —

    UUID notification_id

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

    the optional parameters

Returns:



2457
2458
2459
2460
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2457

def update_notification_using_put(notification, notification_id, opts = {})
  data, _status_code, _headers = update_notification_using_put_with_http_info(notification, notification_id, opts)
  data
end

#update_notification_using_put_with_http_info(notification, notification_id, opts = {}) ⇒ Array<(Notification, Fixnum, Hash)>

Update a Notification Update a Notification.

Parameters:

  • notification —

    notification

  • notification_id —

    UUID notification_id

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

    the optional parameters

Returns:

  • (Array<(Notification, Fixnum, Hash)>) —

    Notification data, response status code and response headers



2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2468

def update_notification_using_put_with_http_info(notification, notification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_notification_using_put ...'
  end
  # verify the required parameter 'notification' is set
  if @api_client.config.client_side_validation && notification.nil?
    fail ArgumentError, "Missing the required parameter 'notification' when calling UtilsApi.update_notification_using_put"
  end
  # verify the required parameter 'notification_id' is set
  if @api_client.config.client_side_validation && notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_id' when calling UtilsApi.update_notification_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/notification/{notification_id}'.sub('{' + 'notification_id' + '}', notification_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(notification)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Notification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_notification_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_reason_code_using_put(reason_code, reason_code_id, opts = {}) ⇒ ReasonCode

Update a reason code Update a reason code for your firm.

Parameters:

  • reason_code —

    reason_code

  • reason_code_id —

    UUID reason_code_id

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

    the optional parameters

Returns:



2517
2518
2519
2520
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2517

def update_reason_code_using_put(reason_code, reason_code_id, opts = {})
  data, _status_code, _headers = update_reason_code_using_put_with_http_info(reason_code, reason_code_id, opts)
  data
end

#update_reason_code_using_put_with_http_info(reason_code, reason_code_id, opts = {}) ⇒ Array<(ReasonCode, Fixnum, Hash)>

Update a reason code Update a reason code for your firm.

Parameters:

  • reason_code —

    reason_code

  • reason_code_id —

    UUID reason_code_id

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

    the optional parameters

Returns:

  • (Array<(ReasonCode, Fixnum, Hash)>) —

    ReasonCode data, response status code and response headers



2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2528

def update_reason_code_using_put_with_http_info(reason_code, reason_code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_reason_code_using_put ...'
  end
  # verify the required parameter 'reason_code' is set
  if @api_client.config.client_side_validation && reason_code.nil?
    fail ArgumentError, "Missing the required parameter 'reason_code' when calling UtilsApi.update_reason_code_using_put"
  end
  # verify the required parameter 'reason_code_id' is set
  if @api_client.config.client_side_validation && reason_code_id.nil?
    fail ArgumentError, "Missing the required parameter 'reason_code_id' when calling UtilsApi.update_reason_code_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/reason_code/{reason_code_id}'.sub('{' + 'reason_code_id' + '}', reason_code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(reason_code)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReasonCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_reason_code_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_stage_using_put(stage, stage_id, opts = {}) ⇒ Stage

Update an account stage Update the information for an account stage.

Parameters:

  • stage —

    stage

  • stage_id —

    UUID stage_id

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

    the optional parameters

Returns:



2577
2578
2579
2580
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2577

def update_stage_using_put(stage, stage_id, opts = {})
  data, _status_code, _headers = update_stage_using_put_with_http_info(stage, stage_id, opts)
  data
end

#update_stage_using_put_with_http_info(stage, stage_id, opts = {}) ⇒ Array<(Stage, Fixnum, Hash)>

Update an account stage Update the information for an account stage.

Parameters:

  • stage —

    stage

  • stage_id —

    UUID stage_id

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

    the optional parameters

Returns:

  • (Array<(Stage, Fixnum, Hash)>) —

    Stage data, response status code and response headers



2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2588

def update_stage_using_put_with_http_info(stage, stage_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_stage_using_put ...'
  end
  # verify the required parameter 'stage' is set
  if @api_client.config.client_side_validation && stage.nil?
    fail ArgumentError, "Missing the required parameter 'stage' when calling UtilsApi.update_stage_using_put"
  end
  # verify the required parameter 'stage_id' is set
  if @api_client.config.client_side_validation && stage_id.nil?
    fail ArgumentError, "Missing the required parameter 'stage_id' when calling UtilsApi.update_stage_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/stage/{stage_id}'.sub('{' + 'stage_id' + '}', stage_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stage)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Stage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_stage_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_transaction_code_using_put(transaction_code, transaction_code_id, opts = {}) ⇒ TransactionCode

Update a transaction code Update a transaction code for your firm.

Parameters:

  • transaction_code —

    transaction_code

  • transaction_code_id —

    UUID transaction_code_id

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

    the optional parameters

Returns:

  • (TransactionCode) 


2637
2638
2639
2640
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2637

def update_transaction_code_using_put(transaction_code, transaction_code_id, opts = {})
  data, _status_code, _headers = update_transaction_code_using_put_with_http_info(transaction_code, transaction_code_id, opts)
  data
end

#update_transaction_code_using_put_with_http_info(transaction_code, transaction_code_id, opts = {}) ⇒ Array<(TransactionCode, Fixnum, Hash)>

Update a transaction code Update a transaction code for your firm.

Parameters:

  • transaction_code —

    transaction_code

  • transaction_code_id —

    UUID transaction_code_id

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

    the optional parameters

Returns:

  • (Array<(TransactionCode, Fixnum, Hash)>) —

    TransactionCode data, response status code and response headers



2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
 
# File 'lib/nucleus_api/api/utils_api.rb', line 2648

def update_transaction_code_using_put_with_http_info(transaction_code, transaction_code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.update_transaction_code_using_put ...'
  end
  # verify the required parameter 'transaction_code' is set
  if @api_client.config.client_side_validation && transaction_code.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_code' when calling UtilsApi.update_transaction_code_using_put"
  end
  # verify the required parameter 'transaction_code_id' is set
  if @api_client.config.client_side_validation && transaction_code_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_code_id' when calling UtilsApi.update_transaction_code_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/transaction_code/{transaction_code_id}'.sub('{' + 'transaction_code_id' + '}', transaction_code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(transaction_code)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TransactionCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#update_transaction_code_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end