Class: NucleusApi::CardApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CardApi

Returns a new instance of CardApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_card_program_using_post(card_program_request, opts = {}) ⇒ CardProgram

Create a cardProgram request Create a new cardProgram request.

Parameters:

  • card_program_request —

    cardProgramRequest

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

    the optional parameters

Returns:



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

def create_card_program_using_post(card_program_request, opts = {})
  data, _status_code, _headers = create_card_program_using_post_with_http_info(card_program_request, opts)
  data
end

#create_card_program_using_post_with_http_info(card_program_request, opts = {}) ⇒ Array<(CardProgram, Fixnum, Hash)>

Create a cardProgram request Create a new cardProgram request.

Parameters:

  • card_program_request —

    cardProgramRequest

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

    the optional parameters

Returns:

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

    CardProgram 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/card_api.rb', line 37

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

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

#create_card_using_post(card_request, opts = {}) ⇒ Card

Create a card request Create a new card request.

Parameters:

  • card_request —

    cardRequest

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

    the optional parameters

Returns:



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

def create_card_using_post(card_request, opts = {})
  data, _status_code, _headers = create_card_using_post_with_http_info(card_request, opts)
  data
end

#create_card_using_post_with_http_info(card_request, opts = {}) ⇒ Array<(Card, Fixnum, Hash)>

Create a card request Create a new card request.

Parameters:

  • card_request —

    cardRequest

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

    the optional parameters

Returns:

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

    Card 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/card_api.rb', line 91

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

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

#delete_card_program_using_delete(card_program_id, opts = {}) ⇒ nil

Delete an cardProgram Permanently delete an cardProgram.

Parameters:

  • card_program_id —

    UUID card_program_id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_card_program_using_delete(card_program_id, opts = {})
  delete_card_program_using_delete_with_http_info(card_program_id, opts)
  nil
end

#delete_card_program_using_delete_with_http_info(card_program_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an cardProgram Permanently delete an cardProgram.

Parameters:

  • card_program_id —

    UUID card_program_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/card_api.rb', line 145

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

#delete_card_using_delete(card_id, opts = {}) ⇒ nil

Delete a card request Permanently delete a card request.

Parameters:

  • card_id —

    UUID card_id

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

    the optional parameters

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/nucleus_api/api/card_api.rb', line 186

def delete_card_using_delete(card_id, opts = {})
  delete_card_using_delete_with_http_info(card_id, opts)
  nil
end

#delete_card_using_delete_with_http_info(card_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a card request Permanently delete a card request.

Parameters:

  • card_id —

    UUID card_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



196
197
198
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
 
# File 'lib/nucleus_api/api/card_api.rb', line 196

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

#get_all_client_cards_using_get(opts = {}) ⇒ PageClientBusinessCardVO

List all client cards Get the information for all cards for an client.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    USD

  • :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:



242
243
244
245
 
# File 'lib/nucleus_api/api/card_api.rb', line 242

def get_all_client_cards_using_get(opts = {})
  data, _status_code, _headers = get_all_client_cards_using_get_with_http_info(opts)
  data
end

#get_all_client_cards_using_get_with_http_info(opts = {}) ⇒ Array<(PageClientBusinessCardVO, Fixnum, Hash)>

List all client cards Get the information for all cards for an client.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    USD

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageClientBusinessCardVO data, response status code and response headers



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
292
293
294
295
 
# File 'lib/nucleus_api/api/card_api.rb', line 257

def get_all_client_cards_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.get_all_client_cards_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/card/cardholder_overview'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].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 => 'PageClientBusinessCardVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#get_all_client_cards_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card_all_using_get(opts = {}) ⇒ PageCard

List all card requests Get the information for all card requests.

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:



305
306
307
308
 
# File 'lib/nucleus_api/api/card_api.rb', line 305

def get_card_all_using_get(opts = {})
  data, _status_code, _headers = get_card_all_using_get_with_http_info(opts)
  data
end

#get_card_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageCard, Fixnum, Hash)>

List all card requests Get the information for all card requests.

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

    PageCard data, response status code and response headers



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
355
356
 
# File 'lib/nucleus_api/api/card_api.rb', line 319

def get_card_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.get_card_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/card'

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

#get_card_asset_size_agg_all_using_get(card_id, opts = {}) ⇒ Array<Object>

List all card asset sizes Get a list of asset sizes by date for an card.

Parameters:

  • card_id —

    Card Id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

    Quarter (Q), Monthly (M) , Annually (Y), Daily (D) –caps matter, codes in ()

  • :start_date (Date) —

    start date

Returns:

  • (Array<Object>) 


367
368
369
370
 
# File 'lib/nucleus_api/api/card_api.rb', line 367

def get_card_asset_size_agg_all_using_get(card_id, opts = {})
  data, _status_code, _headers = get_card_asset_size_agg_all_using_get_with_http_info(card_id, opts)
  data
end

#get_card_asset_size_agg_all_using_get_with_http_info(card_id, opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

List all card asset sizes Get a list of asset sizes by date for an card.

Parameters:

  • card_id —

    Card Id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

    Quarter (Q), Monthly (M) , Annually (Y), Daily (D) –caps matter, codes in ()

  • :start_date (Date) —

    start date

Returns:

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

    Array<Object> data, response status code and response headers



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/nucleus_api/api/card_api.rb', line 382

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

  # query parameters
  query_params = {}
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].nil?
  query_params[:'sort_type'] = opts[:'sort_type'] if !opts[:'sort_type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#get_card_asset_size_agg_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card_program_all_using_get(opts = {}) ⇒ PageCardProgram

List all cardProgram Get information for all cardProgram.

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:



433
434
435
436
 
# File 'lib/nucleus_api/api/card_api.rb', line 433

def get_card_program_all_using_get(opts = {})
  data, _status_code, _headers = get_card_program_all_using_get_with_http_info(opts)
  data
end

#get_card_program_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageCardProgram, Fixnum, Hash)>

List all cardProgram Get information for all cardProgram.

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

    PageCardProgram data, response status code and response headers



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/nucleus_api/api/card_api.rb', line 447

def get_card_program_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.get_card_program_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/card_program'

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

#get_card_program_using_get(card_program_id, opts = {}) ⇒ CardProgram

Retrieve an cardProgram Retrieve the information for a specific cardProgram.

Parameters:

  • card_program_id —

    UUID card_program_id

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

    the optional parameters

Returns:



490
491
492
493
 
# File 'lib/nucleus_api/api/card_api.rb', line 490

def get_card_program_using_get(card_program_id, opts = {})
  data, _status_code, _headers = get_card_program_using_get_with_http_info(card_program_id, opts)
  data
end

#get_card_program_using_get_with_http_info(card_program_id, opts = {}) ⇒ Array<(CardProgram, Fixnum, Hash)>

Retrieve an cardProgram Retrieve the information for a specific cardProgram.

Parameters:

  • card_program_id —

    UUID card_program_id

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

    the optional parameters

Returns:

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

    CardProgram data, response status code and response headers



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/nucleus_api/api/card_api.rb', line 500

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

#get_card_transaction_agg_all_using_get(card_id, opts = {}) ⇒ PagePortfolioTransaction

List all card transactions Get the information for all transactions for an card.

Parameters:

  • card_id —

    UUID card_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (Date) —

    start date

Returns:



550
551
552
553
 
# File 'lib/nucleus_api/api/card_api.rb', line 550

def get_card_transaction_agg_all_using_get(card_id, opts = {})
  data, _status_code, _headers = get_card_transaction_agg_all_using_get_with_http_info(card_id, opts)
  data
end

#get_card_transaction_agg_all_using_get1(card_id, opts = {}) ⇒ PagePortfolioTransaction

List all card transactions Get the information for all transactions for an card.

Parameters:

  • card_id —

    card_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :end_date (DateTime) —

    end_date (default to null)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (DateTime) —

    start_date (default to null)

Returns:



626
627
628
629
 
# File 'lib/nucleus_api/api/card_api.rb', line 626

def get_card_transaction_agg_all_using_get1(card_id, opts = {})
  data, _status_code, _headers = get_card_transaction_agg_all_using_get1_with_http_info(card_id, opts)
  data
end

#get_card_transaction_agg_all_using_get1_with_http_info(card_id, opts = {}) ⇒ Array<(PagePortfolioTransaction, Fixnum, Hash)>

List all card transactions Get the information for all transactions for an card.

Parameters:

  • card_id —

    card_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :end_date (DateTime) —

    end_date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (DateTime) —

    start_date

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/nucleus_api/api/card_api.rb', line 644

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

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].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?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?

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

#get_card_transaction_agg_all_using_get_with_http_info(card_id, opts = {}) ⇒ Array<(PagePortfolioTransaction, Fixnum, Hash)>

List all card transactions Get the information for all transactions for an card.

Parameters:

  • card_id —

    UUID card_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



568
569
570
571
572
573
574
575
576
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/card_api.rb', line 568

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

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].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?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'PagePortfolioTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#get_card_transaction_agg_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card_using_get(card_id, opts = {}) ⇒ Card

Retrieve a card request Retrieve the information for a card request.

Parameters:

  • card_id —

    UUID card_id

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

    the optional parameters

Returns:



696
697
698
699
 
# File 'lib/nucleus_api/api/card_api.rb', line 696

def get_card_using_get(card_id, opts = {})
  data, _status_code, _headers = get_card_using_get_with_http_info(card_id, opts)
  data
end

#get_card_using_get_with_http_info(card_id, opts = {}) ⇒ Array<(Card, Fixnum, Hash)>

Retrieve a card request Retrieve the information for a card request.

Parameters:

  • card_id —

    UUID card_id

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

    the optional parameters

Returns:

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

    Card data, response status code and response headers



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/nucleus_api/api/card_api.rb', line 706

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

#update_card_program_using_put(card_program, card_program_id, opts = {}) ⇒ CardProgram

Update an cardProgram Update the information for an cardProgram.

Parameters:

  • card_program —

    card_program

  • card_program_id —

    UUID card_program_id

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

    the optional parameters

Returns:



749
750
751
752
 
# File 'lib/nucleus_api/api/card_api.rb', line 749

def update_card_program_using_put(card_program, card_program_id, opts = {})
  data, _status_code, _headers = update_card_program_using_put_with_http_info(card_program, card_program_id, opts)
  data
end

#update_card_program_using_put_with_http_info(card_program, card_program_id, opts = {}) ⇒ Array<(CardProgram, Fixnum, Hash)>

Update an cardProgram Update the information for an cardProgram.

Parameters:

  • card_program —

    card_program

  • card_program_id —

    UUID card_program_id

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

    the optional parameters

Returns:

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

    CardProgram data, response status code and response headers



760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/nucleus_api/api/card_api.rb', line 760

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

#update_card_using_put(card, card_id, opts = {}) ⇒ Card

Update a card request Update the information for a card request.

Parameters:

  • card —

    card

  • card_id —

    UUID card_id

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

    the optional parameters

Returns:



809
810
811
812
 
# File 'lib/nucleus_api/api/card_api.rb', line 809

def update_card_using_put(card, card_id, opts = {})
  data, _status_code, _headers = update_card_using_put_with_http_info(card, card_id, opts)
  data
end

#update_card_using_put_with_http_info(card, card_id, opts = {}) ⇒ Array<(Card, Fixnum, Hash)>

Update a card request Update the information for a card request.

Parameters:

  • card —

    card

  • card_id —

    UUID card_id

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

    the optional parameters

Returns:

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

    Card data, response status code and response headers



820
821
822
823
824
825
826
827
828
829
830
831
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
 
# File 'lib/nucleus_api/api/card_api.rb', line 820

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