Class: SyncteraRubySdk::CardsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CardsApi

Returns a new instance of CardsApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#activate_card(card_activation_request, opts = {}) ⇒ CardResponse

Activate a card Activate a card

Parameters:

  • card_activation_request (CardActivationRequest) —

    Card activation code

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



28
29
30
31
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 28

def activate_card(card_activation_request, opts = {})
  data, _status_code, _headers = activate_card_with_http_info(card_activation_request, opts)
  data
end

#activate_card_with_http_info(card_activation_request, opts = {}) ⇒ Array<(CardResponse, Integer, Hash)>

Activate a card Activate a card

Parameters:

  • card_activation_request (CardActivationRequest) —

    Card activation code

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    CardResponse data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 39

def activate_card_with_http_info(card_activation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.activate_card ...'
  end
  # verify the required parameter 'card_activation_request' is set
  if @api_client.config.client_side_validation && card_activation_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_activation_request' when calling CardsApi.activate_card"
  end
  # resource path
  local_var_path = '/cards/activate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.activate_card",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#activate_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_card_image(create_card_image_request, opts = {}) ⇒ CardImageDetails

Create Card Image Create a card image entity. Note that this does not include the image data itself. You can upload the image data via a subsequent uploadCardImageData request using the ID created here.

Parameters:

  • create_card_image_request (CreateCardImageRequest) —

    Details of the image to create

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



99
100
101
102
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 99

def create_card_image(create_card_image_request, opts = {})
  data, _status_code, _headers = create_card_image_with_http_info(create_card_image_request, opts)
  data
end

#create_card_image_with_http_info(create_card_image_request, opts = {}) ⇒ Array<(CardImageDetails, Integer, Hash)>

Create Card Image Create a card image entity. Note that this does not include the image data itself. You can upload the image data via a subsequent uploadCardImageData request using the ID created here.

Parameters:

  • create_card_image_request (CreateCardImageRequest) —

    Details of the image to create

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    CardImageDetails data, response status code and response headers



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 110

def create_card_image_with_http_info(create_card_image_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.create_card_image ...'
  end
  # verify the required parameter 'create_card_image_request' is set
  if @api_client.config.client_side_validation && create_card_image_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_card_image_request' when calling CardsApi.create_card_image"
  end
  # resource path
  local_var_path = '/cards/images'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.create_card_image",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#create_card_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_gateway(create_gateway_request, opts = {}) ⇒ GatewayResponse

Create Gateway Create a new Authorization Gateway Configuration

Parameters:

  • create_gateway_request (CreateGatewayRequest) —

    Create a new Authorization Gateway Configuration

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



170
171
172
173
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 170

def create_gateway(create_gateway_request, opts = {})
  data, _status_code, _headers = create_gateway_with_http_info(create_gateway_request, opts)
  data
end

#create_gateway_with_http_info(create_gateway_request, opts = {}) ⇒ Array<(GatewayResponse, Integer, Hash)>

Create Gateway Create a new Authorization Gateway Configuration

Parameters:

  • create_gateway_request (CreateGatewayRequest) —

    Create a new Authorization Gateway Configuration

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    GatewayResponse data, response status code and response headers



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 181

def create_gateway_with_http_info(create_gateway_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.create_gateway ...'
  end
  # verify the required parameter 'create_gateway_request' is set
  if @api_client.config.client_side_validation && create_gateway_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_gateway_request' when calling CardsApi.create_gateway"
  end
  # resource path
  local_var_path = '/cards/gateways'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.create_gateway",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#create_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card(card_id, opts = {}) ⇒ CardResponse

Get Card Get the details about a card that has been issued

Parameters:

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

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 240

def get_card(card_id, opts = {})
  data, _status_code, _headers = get_card_with_http_info(card_id, opts)
  data
end

#get_card_barcode(card_id, opts = {}) ⇒ GetCardBarcode200Response

Get Card Barcode This endpoint is for testing environment only to provide access to barcode of a test card

Parameters:

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

    the optional parameters

Returns:



303
304
305
306
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 303

def get_card_barcode(card_id, opts = {})
  data, _status_code, _headers = get_card_barcode_with_http_info(card_id, opts)
  data
end

#get_card_barcode_with_http_info(card_id, opts = {}) ⇒ Array<(GetCardBarcode200Response, Integer, Hash)>

Get Card Barcode This endpoint is for testing environment only to provide access to barcode of a test card

Parameters:

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

    the optional parameters

Returns:

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

    GetCardBarcode200Response data, response status code and response headers



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 313

def get_card_barcode_with_http_info(card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_card_barcode ...'
  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 CardsApi.get_card_barcode"
  end
  # resource path
  local_var_path = '/cards/{card_id}/barcodes'.sub('{' + 'card_id' + '}', CGI.escape(card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_card_barcode",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_card_barcode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card_image_data(card_image_id, opts = {}) ⇒ File

Get Card Image Data Get card image data

Parameters:

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

    the optional parameters

Returns:

  • (File) 


366
367
368
369
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 366

def get_card_image_data(card_image_id, opts = {})
  data, _status_code, _headers = get_card_image_data_with_http_info(card_image_id, opts)
  data
end

#get_card_image_data_with_http_info(card_image_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get Card Image Data Get card image data

Parameters:

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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

def get_card_image_data_with_http_info(card_image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_card_image_data ...'
  end
  # verify the required parameter 'card_image_id' is set
  if @api_client.config.client_side_validation && card_image_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_image_id' when calling CardsApi.get_card_image_data"
  end
  # resource path
  local_var_path = '/cards/images/{card_image_id}/data'.sub('{' + 'card_image_id' + '}', CGI.escape(card_image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/jpeg', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_card_image_data",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_card_image_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card_image_details(card_image_id, opts = {}) ⇒ CardImageDetails

Get Card Image Details Get card image details

Parameters:

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

    the optional parameters

Returns:



429
430
431
432
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 429

def get_card_image_details(card_image_id, opts = {})
  data, _status_code, _headers = get_card_image_details_with_http_info(card_image_id, opts)
  data
end

#get_card_image_details_with_http_info(card_image_id, opts = {}) ⇒ Array<(CardImageDetails, Integer, Hash)>

Get Card Image Details Get card image details

Parameters:

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

    the optional parameters

Returns:

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

    CardImageDetails data, response status code and response headers



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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 439

def get_card_image_details_with_http_info(card_image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_card_image_details ...'
  end
  # verify the required parameter 'card_image_id' is set
  if @api_client.config.client_side_validation && card_image_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_image_id' when calling CardsApi.get_card_image_details"
  end
  # resource path
  local_var_path = '/cards/images/{card_image_id}'.sub('{' + 'card_image_id' + '}', CGI.escape(card_image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_card_image_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_card_image_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card_widget_url(widget_type, customer_id, account_id, opts = {}) ⇒ CardWidgetUrlResponse

Get card widget URL This endpoint returns a URL address of the specified widget for a given card

Parameters:

  • widget_type (WidgetType) —

    The type of widget for which to construct the URL

  • customer_id (String)
  • account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :card_id (String) —

    The ID of the card (required for set PIN widget)

Returns:



495
496
497
498
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 495

def get_card_widget_url(widget_type, customer_id, , opts = {})
  data, _status_code, _headers = get_card_widget_url_with_http_info(widget_type, customer_id, , opts)
  data
end

#get_card_widget_url_with_http_info(widget_type, customer_id, account_id, opts = {}) ⇒ Array<(CardWidgetUrlResponse, Integer, Hash)>

Get card widget URL This endpoint returns a URL address of the specified widget for a given card

Parameters:

  • widget_type (WidgetType) —

    The type of widget for which to construct the URL

  • customer_id (String)
  • account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :card_id (String) —

    The ID of the card (required for set PIN widget)

Returns:

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

    CardWidgetUrlResponse data, response status code and response headers



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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 508

def get_card_widget_url_with_http_info(widget_type, customer_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_card_widget_url ...'
  end
  # verify the required parameter 'widget_type' is set
  if @api_client.config.client_side_validation && widget_type.nil?
    fail ArgumentError, "Missing the required parameter 'widget_type' when calling CardsApi.get_card_widget_url"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CardsApi.get_card_widget_url"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CardsApi.get_card_widget_url"
  end
  # resource path
  local_var_path = '/cards/card_widget_url'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'widget_type'] = widget_type
  query_params[:'customer_id'] = customer_id
  query_params[:'account_id'] = 
  query_params[:'card_id'] = opts[:'card_id'] if !opts[:'card_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_card_widget_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_card_widget_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_card_with_http_info(card_id, opts = {}) ⇒ Array<(CardResponse, Integer, Hash)>

Get Card Get the details about a card that has been issued

Parameters:

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

    the optional parameters

Returns:

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

    CardResponse data, response status code and response headers



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

def get_card_with_http_info(card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_card ...'
  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 CardsApi.get_card"
  end
  # resource path
  local_var_path = '/cards/{card_id}'.sub('{' + 'card_id' + '}', CGI.escape(card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_card",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client_access_token(card_id, opts = {}) ⇒ ClientToken

Get a client token Create a client access token for interacting with a card. This token will be used on the client to identify the card for flows like viewing Full PAN or setting the PIN in a PCI compliant manner.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



574
575
576
577
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 574

def get_client_access_token(card_id, opts = {})
  data, _status_code, _headers = get_client_access_token_with_http_info(card_id, opts)
  data
end

#get_client_access_token_with_http_info(card_id, opts = {}) ⇒ Array<(ClientToken, Integer, Hash)>

Get a client token Create a client access token for interacting with a card. This token will be used on the client to identify the card for flows like viewing Full PAN or setting the PIN in a PCI compliant manner.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    ClientToken data, response status code and response headers



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
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 585

def get_client_access_token_with_http_info(card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_client_access_token ...'
  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 CardsApi.get_client_access_token"
  end
  # resource path
  local_var_path = '/cards/{card_id}/client_token'.sub('{' + 'card_id' + '}', CGI.escape(card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_client_access_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_client_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client_single_use_token(single_use_token_request, opts = {}) ⇒ SingleUseTokenResponse

Get single-use token This endpoint returns a single-use access token. This type of token authorizes a single request to access API endpoints and data associated with a particular user

Parameters:

  • single_use_token_request (SingleUseTokenRequest) —

    User token details

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



640
641
642
643
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 640

def get_client_single_use_token(single_use_token_request, opts = {})
  data, _status_code, _headers = get_client_single_use_token_with_http_info(single_use_token_request, opts)
  data
end

#get_client_single_use_token_with_http_info(single_use_token_request, opts = {}) ⇒ Array<(SingleUseTokenResponse, Integer, Hash)>

Get single-use token This endpoint returns a single-use access token. This type of token authorizes a single request to access API endpoints and data associated with a particular user

Parameters:

  • single_use_token_request (SingleUseTokenRequest) —

    User token details

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    SingleUseTokenResponse data, response status code and response headers



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
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 651

def get_client_single_use_token_with_http_info(single_use_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_client_single_use_token ...'
  end
  # verify the required parameter 'single_use_token_request' is set
  if @api_client.config.client_side_validation && single_use_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'single_use_token_request' when calling CardsApi.get_client_single_use_token"
  end
  # resource path
  local_var_path = '/cards/single_use_token'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_client_single_use_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_client_single_use_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_gateway(gateway_id, opts = {}) ⇒ GatewayResponse

Get Gateway Get the details of an Authorization Gateway that has been configured

Parameters:

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

    the optional parameters

Returns:



710
711
712
713
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 710

def get_gateway(gateway_id, opts = {})
  data, _status_code, _headers = get_gateway_with_http_info(gateway_id, opts)
  data
end

#get_gateway_with_http_info(gateway_id, opts = {}) ⇒ Array<(GatewayResponse, Integer, Hash)>

Get Gateway Get the details of an Authorization Gateway that has been configured

Parameters:

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

    the optional parameters

Returns:

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

    GatewayResponse data, response status code and response headers



720
721
722
723
724
725
726
727
728
729
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
766
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 720

def get_gateway_with_http_info(gateway_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_gateway ...'
  end
  # verify the required parameter 'gateway_id' is set
  if @api_client.config.client_side_validation && gateway_id.nil?
    fail ArgumentError, "Missing the required parameter 'gateway_id' when calling CardsApi.get_gateway"
  end
  # resource path
  local_var_path = '/cards/gateways/{gateway_id}'.sub('{' + 'gateway_id' + '}', CGI.escape(gateway_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_gateway",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#get_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_card(card_issuance_request, opts = {}) ⇒ CardResponse

Issue a Card Issue or reissue a new card for a customer

Parameters:

  • card_issuance_request (CardIssuanceRequest) —

    Card to issue

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



774
775
776
777
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 774

def issue_card(card_issuance_request, opts = {})
  data, _status_code, _headers = issue_card_with_http_info(card_issuance_request, opts)
  data
end

#issue_card_with_http_info(card_issuance_request, opts = {}) ⇒ Array<(CardResponse, Integer, Hash)>

Issue a Card Issue or reissue a new card for a customer

Parameters:

  • card_issuance_request (CardIssuanceRequest) —

    Card to issue

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    CardResponse data, response status code and response headers



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
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 785

def issue_card_with_http_info(card_issuance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.issue_card ...'
  end
  # verify the required parameter 'card_issuance_request' is set
  if @api_client.config.client_side_validation && card_issuance_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_issuance_request' when calling CardsApi.issue_card"
  end
  # resource path
  local_var_path = '/cards'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.issue_card",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#issue_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_card_image_details(customer_id, opts = {}) ⇒ CardImageDetailsList

List Card Image Details List all card image details

Parameters:

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

    the optional parameters

Returns:



844
845
846
847
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 844

def list_card_image_details(customer_id, opts = {})
  data, _status_code, _headers = list_card_image_details_with_http_info(customer_id, opts)
  data
end

#list_card_image_details_with_http_info(customer_id, opts = {}) ⇒ Array<(CardImageDetailsList, Integer, Hash)>

List Card Image Details List all card image details

Parameters:

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

    the optional parameters

Returns:

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

    CardImageDetailsList data, response status code and response headers



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 854

def list_card_image_details_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.list_card_image_details ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CardsApi.list_card_image_details"
  end
  # resource path
  local_var_path = '/cards/images'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'customer_id'] = customer_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.list_card_image_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#list_card_image_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_card_products(opts = {}) ⇒ CardProductListResponse

List Card Products

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :form (Form) —

    The format of the card

Returns:



909
910
911
912
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 909

def list_card_products(opts = {})
  data, _status_code, _headers = list_card_products_with_http_info(opts)
  data
end

#list_card_products_with_http_info(opts = {}) ⇒ Array<(CardProductListResponse, Integer, Hash)>

List Card Products

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :form (Form) —

    The format of the card

Returns:

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

    CardProductListResponse data, response status code and response headers



920
921
922
923
924
925
926
927
928
929
930
931
932
933
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/synctera_ruby_sdk/api/cards_api.rb', line 920

def list_card_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.list_card_products ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CardsApi.list_card_products, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/cards/products'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?
  query_params[:'form'] = opts[:'form'] if !opts[:'form'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.list_card_products",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#list_card_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cards(opts = {}) ⇒ CardListResponse

List Cards List of cards matching query parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String)
  • :account_id (Array<String>) —

    Account ID(s). Multiple IDs can be provided as a comma-separated list.

  • :emboss_name (String) —

    emboss name

  • :last_four (String) —

    The last 4 digits of the card PAN

  • :expiration_date (Date) —

    The date representing when the card would expire at

  • :card_type (CardType) —

    Indicates the type of card

  • :card_brand (CardBrand) —

    The brand of a card product

  • :form (Form) —

    The format of the card

  • :card_product_id (String)
  • :card_status (CardStatus) —

    The status of a card

  • :postal_code (String) —

    The postal code of a card user

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :sort_by (Array<String>) —

    Specifies the sort order for the returned cards.

Returns:



989
990
991
992
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 989

def list_cards(opts = {})
  data, _status_code, _headers = list_cards_with_http_info(opts)
  data
end

#list_cards_with_http_info(opts = {}) ⇒ Array<(CardListResponse, Integer, Hash)>

List Cards List of cards matching query parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String)
  • :account_id (Array<String>) —

    Account ID(s). Multiple IDs can be provided as a comma-separated list.

  • :emboss_name (String) —

    emboss name

  • :last_four (String) —

    The last 4 digits of the card PAN

  • :expiration_date (Date) —

    The date representing when the card would expire at

  • :card_type (CardType) —

    Indicates the type of card

  • :card_brand (CardBrand) —

    The brand of a card product

  • :form (Form) —

    The format of the card

  • :card_product_id (String)
  • :card_status (CardStatus) —

    The status of a card

  • :postal_code (String) —

    The postal code of a card user

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :sort_by (Array<String>) —

    Specifies the sort order for the returned cards.

Returns:

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

    CardListResponse data, response status code and response headers



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
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/synctera_ruby_sdk/api/cards_api.rb', line 1012

def list_cards_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.list_cards ...'
  end
  pattern = Regexp.new(/^\d{4}$/)
  if @api_client.config.client_side_validation && !opts[:'last_four'].nil? && opts[:'last_four'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"last_four\"]' when calling CardsApi.list_cards, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CardsApi.list_cards, must be greater than or equal to 1.'
  end

  allowable_values = ["account_id:asc", "account_id:desc", "customer_id:asc", "customer_id:desc", "card_product_id:asc", "card_product_id:desc", "last_four:asc", "last_four:desc", "card_type:asc", "card_type:desc", "card_brand:asc", "card_brand:desc", "expiration_date:asc", "expiration_date:desc", "form:asc", "form:desc", "card_status:asc", "card_status:desc"]
  if @api_client.config.client_side_validation && opts[:'sort_by'] && !opts[:'sort_by'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"sort_by\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/cards'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'customer_id'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
  query_params[:'account_id'] = @api_client.build_collection_param(opts[:'account_id'], :csv) if !opts[:'account_id'].nil?
  query_params[:'emboss_name'] = opts[:'emboss_name'] if !opts[:'emboss_name'].nil?
  query_params[:'last_four'] = opts[:'last_four'] if !opts[:'last_four'].nil?
  query_params[:'expiration_date'] = opts[:'expiration_date'] if !opts[:'expiration_date'].nil?
  query_params[:'card_type'] = opts[:'card_type'] if !opts[:'card_type'].nil?
  query_params[:'card_brand'] = opts[:'card_brand'] if !opts[:'card_brand'].nil?
  query_params[:'form'] = opts[:'form'] if !opts[:'form'].nil?
  query_params[:'card_product_id'] = opts[:'card_product_id'] if !opts[:'card_product_id'].nil?
  query_params[:'card_status'] = opts[:'card_status'] if !opts[:'card_status'].nil?
  query_params[:'postal_code'] = opts[:'postal_code'] if !opts[:'postal_code'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.list_cards",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#list_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_changes(card_id, opts = {}) ⇒ CardChangesList

List Card Changes List card change history

Parameters:

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

    the optional parameters

Returns:



1088
1089
1090
1091
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1088

def list_changes(card_id, opts = {})
  data, _status_code, _headers = list_changes_with_http_info(card_id, opts)
  data
end

#list_changes_with_http_info(card_id, opts = {}) ⇒ Array<(CardChangesList, Integer, Hash)>

List Card Changes List card change history

Parameters:

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

    the optional parameters

Returns:

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

    CardChangesList data, response status code and response headers



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
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1098

def list_changes_with_http_info(card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.list_changes ...'
  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 CardsApi.list_changes"
  end
  # resource path
  local_var_path = '/cards/{card_id}/changes'.sub('{' + 'card_id' + '}', CGI.escape(card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.list_changes",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#list_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_gateways(opts = {}) ⇒ GatewayListResponse

List Gateways List of gateways matching query parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:



1152
1153
1154
1155
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1152

def list_gateways(opts = {})
  data, _status_code, _headers = list_gateways_with_http_info(opts)
  data
end

#list_gateways_with_http_info(opts = {}) ⇒ Array<(GatewayListResponse, Integer, Hash)>

List Gateways List of gateways matching query parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:

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

    GatewayListResponse data, response status code and response headers



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
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1163

def list_gateways_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.list_gateways ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CardsApi.list_gateways, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/cards/gateways'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.list_gateways",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#list_gateways\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_card(card_id, card_edit_request, opts = {}) ⇒ CardResponse

Update Card Integrators can update the card resource to change status, update shipping (if the card hasn’t been shipped) or edit metadata.

Parameters:

  • card_id (String)
  • card_edit_request (CardEditRequest) —

    Card edits

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



1220
1221
1222
1223
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1220

def update_card(card_id, card_edit_request, opts = {})
  data, _status_code, _headers = update_card_with_http_info(card_id, card_edit_request, opts)
  data
end

#update_card_image_details(card_image_id, update_card_image_request, opts = {}) ⇒ CardImageDetails

Update Card Image Details Update card image details. The only detail that can be updated is the card status as APPROVED or REJECTED.

Parameters:

  • card_image_id (String)
  • update_card_image_request (UpdateCardImageRequest) —

    Details of the image to create

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



1297
1298
1299
1300
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1297

def update_card_image_details(card_image_id, update_card_image_request, opts = {})
  data, _status_code, _headers = update_card_image_details_with_http_info(card_image_id, update_card_image_request, opts)
  data
end

#update_card_image_details_with_http_info(card_image_id, update_card_image_request, opts = {}) ⇒ Array<(CardImageDetails, Integer, Hash)>

Update Card Image Details Update card image details. The only detail that can be updated is the card status as APPROVED or REJECTED.

Parameters:

  • card_image_id (String)
  • update_card_image_request (UpdateCardImageRequest) —

    Details of the image to create

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    CardImageDetails data, response status code and response headers



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
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
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1309

def update_card_image_details_with_http_info(card_image_id, update_card_image_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.update_card_image_details ...'
  end
  # verify the required parameter 'card_image_id' is set
  if @api_client.config.client_side_validation && card_image_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_image_id' when calling CardsApi.update_card_image_details"
  end
  # verify the required parameter 'update_card_image_request' is set
  if @api_client.config.client_side_validation && update_card_image_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_card_image_request' when calling CardsApi.update_card_image_details"
  end
  # resource path
  local_var_path = '/cards/images/{card_image_id}'.sub('{' + 'card_image_id' + '}', CGI.escape(card_image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.update_card_image_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#update_card_image_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_card_with_http_info(card_id, card_edit_request, opts = {}) ⇒ Array<(CardResponse, Integer, Hash)>

Update Card Integrators can update the card resource to change status, update shipping (if the card hasn&#39;t been shipped) or edit metadata.

Parameters:

  • card_id (String)
  • card_edit_request (CardEditRequest) —

    Card edits

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    CardResponse data, response status code and response headers



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1232

def update_card_with_http_info(card_id, card_edit_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.update_card ...'
  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 CardsApi.update_card"
  end
  # verify the required parameter 'card_edit_request' is set
  if @api_client.config.client_side_validation && card_edit_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_edit_request' when calling CardsApi.update_card"
  end
  # resource path
  local_var_path = '/cards/{card_id}'.sub('{' + 'card_id' + '}', CGI.escape(card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.update_card",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#update_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_gateway(gateway_id, update_gateway_request, opts = {}) ⇒ GatewayResponse

Update Gateway Update Authorization Gateway configuration

Parameters:

  • gateway_id (String)
  • update_gateway_request (UpdateGatewayRequest) —

    Gateway edits

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



1374
1375
1376
1377
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1374

def update_gateway(gateway_id, update_gateway_request, opts = {})
  data, _status_code, _headers = update_gateway_with_http_info(gateway_id, update_gateway_request, opts)
  data
end

#update_gateway_with_http_info(gateway_id, update_gateway_request, opts = {}) ⇒ Array<(GatewayResponse, Integer, Hash)>

Update Gateway Update Authorization Gateway configuration

Parameters:

  • gateway_id (String)
  • update_gateway_request (UpdateGatewayRequest) —

    Gateway edits

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    GatewayResponse data, response status code and response headers



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
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1386

def update_gateway_with_http_info(gateway_id, update_gateway_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.update_gateway ...'
  end
  # verify the required parameter 'gateway_id' is set
  if @api_client.config.client_side_validation && gateway_id.nil?
    fail ArgumentError, "Missing the required parameter 'gateway_id' when calling CardsApi.update_gateway"
  end
  # verify the required parameter 'update_gateway_request' is set
  if @api_client.config.client_side_validation && update_gateway_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_gateway_request' when calling CardsApi.update_gateway"
  end
  # resource path
  local_var_path = '/cards/gateways/{gateway_id}'.sub('{' + 'gateway_id' + '}', CGI.escape(gateway_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.update_gateway",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#update_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_card_image_data(card_image_id, body, opts = {}) ⇒ CardImageDetails

Upload Card Image Upload card image data

Parameters:

  • card_image_id (String)
  • body (File) —

    Binary image data

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:



1451
1452
1453
1454
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1451

def upload_card_image_data(card_image_id, body, opts = {})
  data, _status_code, _headers = upload_card_image_data_with_http_info(card_image_id, body, opts)
  data
end

#upload_card_image_data_with_http_info(card_image_id, body, opts = {}) ⇒ Array<(CardImageDetails, Integer, Hash)>

Upload Card Image Upload card image data

Parameters:

  • card_image_id (String)
  • body (File) —

    Binary image data

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

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

    CardImageDetails data, response status code and response headers



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'lib/synctera_ruby_sdk/api/cards_api.rb', line 1463

def upload_card_image_data_with_http_info(card_image_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.upload_card_image_data ...'
  end
  # verify the required parameter 'card_image_id' is set
  if @api_client.config.client_side_validation && card_image_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_image_id' when calling CardsApi.upload_card_image_data"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CardsApi.upload_card_image_data"
  end
  # resource path
  local_var_path = '/cards/images/{card_image_id}/data'.sub('{' + 'card_image_id' + '}', CGI.escape(card_image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['image/jpeg'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"CardsApi.upload_card_image_data",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#upload_card_image_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end