Class: NucleusApi::RoundupApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoundupApi

Returns a new instance of RoundupApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_roundup_settings_using_post(roundup_settings, opts = {}) ⇒ RoundupSettings

Create a Roundup Settings Create a Roundup Settings for Roundup amount with your firm.

Parameters:

  • roundup_settings —

    roundupSettings

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

    the optional parameters

Returns:



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

def create_roundup_settings_using_post(roundup_settings, opts = {})
  data, _status_code, _headers = create_roundup_settings_using_post_with_http_info(roundup_settings, opts)
  data
end

#create_roundup_settings_using_post_with_http_info(roundup_settings, opts = {}) ⇒ Array<(RoundupSettings, Fixnum, Hash)>

Create a Roundup Settings Create a Roundup Settings for Roundup amount with your firm.

Parameters:

  • roundup_settings —

    roundupSettings

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

    the optional parameters

Returns:

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

    RoundupSettings 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/roundup_api.rb', line 37

def create_roundup_settings_using_post_with_http_info(roundup_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.create_roundup_settings_using_post ...'
  end
  # verify the required parameter 'roundup_settings' is set
  if @api_client.config.client_side_validation && roundup_settings.nil?
    fail ArgumentError, "Missing the required parameter 'roundup_settings' when calling RoundupApi.create_roundup_settings_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup_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(roundup_settings)
  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 => 'RoundupSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#create_roundup_settings_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_roundup_using_post(roundup_co, opts = {}) ⇒ Roundup

Create a roundup Create a new roundup with your firm.

Parameters:

  • roundup_co —

    roundupCO

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

    the optional parameters

Returns:



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

def create_roundup_using_post(roundup_co, opts = {})
  data, _status_code, _headers = create_roundup_using_post_with_http_info(roundup_co, opts)
  data
end

#create_roundup_using_post_with_http_info(roundup_co, opts = {}) ⇒ Array<(Roundup, Fixnum, Hash)>

Create a roundup Create a new roundup with your firm.

Parameters:

  • roundup_co —

    roundupCO

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

    the optional parameters

Returns:

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

    Roundup 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/roundup_api.rb', line 91

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

  # 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(roundup_co)
  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 => 'Roundup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#create_roundup_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_roundup_settings_using_delete(roundup_setting_id, opts = {}) ⇒ nil

Delete a roundup settings Permanently delete a roundup settings registered with your firm.

Parameters:

  • roundup_setting_id —

    UUID roundup_setting_id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_roundup_settings_using_delete(roundup_setting_id, opts = {})
  delete_roundup_settings_using_delete_with_http_info(roundup_setting_id, opts)
  nil
end

#delete_roundup_settings_using_delete_with_http_info(roundup_setting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a roundup settings Permanently delete a roundup settings registered with your firm.

Parameters:

  • roundup_setting_id —

    UUID roundup_setting_id

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 145

def delete_roundup_settings_using_delete_with_http_info(roundup_setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.delete_roundup_settings_using_delete ...'
  end
  # verify the required parameter 'roundup_setting_id' is set
  if @api_client.config.client_side_validation && roundup_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'roundup_setting_id' when calling RoundupApi.delete_roundup_settings_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup_setting/{roundup_setting_id}'.sub('{' + 'roundup_setting_id' + '}', roundup_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: RoundupApi#delete_roundup_settings_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_roundup_all_using_get(opts = {}) ⇒ PageRoundup

List all roundups Get details for all roundups.

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:



190
191
192
193
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 190

def get_roundup_all_using_get(opts = {})
  data, _status_code, _headers = get_roundup_all_using_get_with_http_info(opts)
  data
end

#get_roundup_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageRoundup, Fixnum, Hash)>

List all roundups Get details for all roundups.

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<(PageRoundup, Fixnum, Hash)>) —

    PageRoundup data, response status code and response headers



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
238
239
240
241
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 204

def get_roundup_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.get_roundup_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup'

  # 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 => 'PageRoundup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#get_roundup_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_roundup_settings_all_using_get(opts = {}) ⇒ PageRoundupSettings

List all roundup settings Get details for all roundup setting with 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:



251
252
253
254
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 251

def get_roundup_settings_all_using_get(opts = {})
  data, _status_code, _headers = get_roundup_settings_all_using_get_with_http_info(opts)
  data
end

#get_roundup_settings_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageRoundupSettings, Fixnum, Hash)>

List all roundup settings Get details for all roundup setting with 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<(PageRoundupSettings, Fixnum, Hash)>) —

    PageRoundupSettings data, response status code and response headers



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
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 265

def get_roundup_settings_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.get_roundup_settings_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup_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(['*/*'])

  # 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 => 'PageRoundupSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#get_roundup_settings_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_roundup_settings_using_get(roundup_setting_id, opts = {}) ⇒ RoundupSettings

Retrieve a Roundup Setting Retrieve the information for a Roundup Settings with your firm.

Parameters:

  • roundup_setting_id —

    UUID roundup_setting_id

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

    the optional parameters

Returns:



308
309
310
311
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 308

def get_roundup_settings_using_get(roundup_setting_id, opts = {})
  data, _status_code, _headers = get_roundup_settings_using_get_with_http_info(roundup_setting_id, opts)
  data
end

#get_roundup_settings_using_get_with_http_info(roundup_setting_id, opts = {}) ⇒ Array<(RoundupSettings, Fixnum, Hash)>

Retrieve a Roundup Setting Retrieve the information for a Roundup Settings with your firm.

Parameters:

  • roundup_setting_id —

    UUID roundup_setting_id

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

    the optional parameters

Returns:

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

    RoundupSettings data, response status code and response headers



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 318

def get_roundup_settings_using_get_with_http_info(roundup_setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.get_roundup_settings_using_get ...'
  end
  # verify the required parameter 'roundup_setting_id' is set
  if @api_client.config.client_side_validation && roundup_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'roundup_setting_id' when calling RoundupApi.get_roundup_settings_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup_setting/{roundup_setting_id}'.sub('{' + 'roundup_setting_id' + '}', roundup_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 => 'RoundupSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#get_roundup_settings_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_roundup_using_get(roundup_id, opts = {}) ⇒ Roundup

Retrieve a Roundup Retrieve the information for a Roundup.

Parameters:

  • roundup_id —

    UUID roundup_id

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

    the optional parameters

Returns:



360
361
362
363
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 360

def get_roundup_using_get(roundup_id, opts = {})
  data, _status_code, _headers = get_roundup_using_get_with_http_info(roundup_id, opts)
  data
end

#get_roundup_using_get_with_http_info(roundup_id, opts = {}) ⇒ Array<(Roundup, Fixnum, Hash)>

Retrieve a Roundup Retrieve the information for a Roundup.

Parameters:

  • roundup_id —

    UUID roundup_id

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

    the optional parameters

Returns:

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

    Roundup data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 370

def get_roundup_using_get_with_http_info(roundup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.get_roundup_using_get ...'
  end
  # verify the required parameter 'roundup_id' is set
  if @api_client.config.client_side_validation && roundup_id.nil?
    fail ArgumentError, "Missing the required parameter 'roundup_id' when calling RoundupApi.get_roundup_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup/{roundup_id}'.sub('{' + 'roundup_id' + '}', roundup_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 => 'Roundup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#get_roundup_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_roundup_settings_using_put(roundup_setting, roundup_setting_id, opts = {}) ⇒ RoundupSettings

Update a roundup settings Update the information for a roundup setting registered with your firm.

Parameters:

  • roundup_setting —

    roundup_setting

  • roundup_setting_id —

    UUID roundup_setting_id

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

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 413

def update_roundup_settings_using_put(roundup_setting, roundup_setting_id, opts = {})
  data, _status_code, _headers = update_roundup_settings_using_put_with_http_info(roundup_setting, roundup_setting_id, opts)
  data
end

#update_roundup_settings_using_put_with_http_info(roundup_setting, roundup_setting_id, opts = {}) ⇒ Array<(RoundupSettings, Fixnum, Hash)>

Update a roundup settings Update the information for a roundup setting registered with your firm.

Parameters:

  • roundup_setting —

    roundup_setting

  • roundup_setting_id —

    UUID roundup_setting_id

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

    the optional parameters

Returns:

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

    RoundupSettings data, response status code and response headers



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
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/nucleus_api/api/roundup_api.rb', line 424

def update_roundup_settings_using_put_with_http_info(roundup_setting, roundup_setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.update_roundup_settings_using_put ...'
  end
  # verify the required parameter 'roundup_setting' is set
  if @api_client.config.client_side_validation && roundup_setting.nil?
    fail ArgumentError, "Missing the required parameter 'roundup_setting' when calling RoundupApi.update_roundup_settings_using_put"
  end
  # verify the required parameter 'roundup_setting_id' is set
  if @api_client.config.client_side_validation && roundup_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'roundup_setting_id' when calling RoundupApi.update_roundup_settings_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup_setting/{roundup_setting_id}'.sub('{' + 'roundup_setting_id' + '}', roundup_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(roundup_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 => 'RoundupSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#update_roundup_settings_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end