Class: SyncteraRubySdk::DigitalWalletTokensApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DigitalWalletTokensApi

Returns a new instance of DigitalWalletTokensApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_digital_wallet_apple(card_id, apple_digital_wallet_provision_request, opts = {}) ⇒ AppleDigitalWalletProvisionResponse

Create digital wallet token provision request for Apple Pay

Parameters:

  • card_id (String)
  • apple_digital_wallet_provision_request (AppleDigitalWalletProvisionRequest) —

    Request to provision digital wallet card data to pass to Apple Pay digital wallet. <br>Cannot be used outside of production.</br>

  • 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/digital_wallet_tokens_api.rb', line 28

def create_digital_wallet_apple(card_id, apple_digital_wallet_provision_request, opts = {})
  data, _status_code, _headers = create_digital_wallet_apple_with_http_info(card_id, apple_digital_wallet_provision_request, opts)
  data
end

#create_digital_wallet_apple_with_http_info(card_id, apple_digital_wallet_provision_request, opts = {}) ⇒ Array<(AppleDigitalWalletProvisionResponse, Integer, Hash)>

Create digital wallet token provision request for Apple Pay

Parameters:

  • card_id (String)
  • apple_digital_wallet_provision_request (AppleDigitalWalletProvisionRequest) —

    Request to provision digital wallet card data to pass to Apple Pay digital wallet. &lt;br&gt;Cannot be used outside of production.&lt;/br&gt;

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



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
92
93
94
95
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 39

def create_digital_wallet_apple_with_http_info(card_id, apple_digital_wallet_provision_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DigitalWalletTokensApi.create_digital_wallet_apple ...'
  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 DigitalWalletTokensApi.create_digital_wallet_apple"
  end
  # verify the required parameter 'apple_digital_wallet_provision_request' is set
  if @api_client.config.client_side_validation && apple_digital_wallet_provision_request.nil?
    fail ArgumentError, "Missing the required parameter 'apple_digital_wallet_provision_request' when calling DigitalWalletTokensApi.create_digital_wallet_apple"
  end
  # resource path
  local_var_path = '/cards/{card_id}/digital_wallet_tokens/applepay'.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(apple_digital_wallet_provision_request)

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

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

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

#create_digital_wallet_google(card_id, google_digital_wallet_provision_request, opts = {}) ⇒ GoogleDigitalWalletProvisionResponse

Create digital wallet token provision request for Google Pay

Parameters:

  • card_id (String)
  • google_digital_wallet_provision_request (GoogleDigitalWalletProvisionRequest) —

    Request to provision digital wallet card data to pass to Google Pay digital wallet. &lt;br&gt;Cannot be used outside of production.&lt;/br&gt;

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



103
104
105
106
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 103

def create_digital_wallet_google(card_id, google_digital_wallet_provision_request, opts = {})
  data, _status_code, _headers = create_digital_wallet_google_with_http_info(card_id, google_digital_wallet_provision_request, opts)
  data
end

#create_digital_wallet_google_with_http_info(card_id, google_digital_wallet_provision_request, opts = {}) ⇒ Array<(GoogleDigitalWalletProvisionResponse, Integer, Hash)>

Create digital wallet token provision request for Google Pay

Parameters:

  • card_id (String)
  • google_digital_wallet_provision_request (GoogleDigitalWalletProvisionRequest) —

    Request to provision digital wallet card data to pass to Google Pay digital wallet. &lt;br&gt;Cannot be used outside of production.&lt;/br&gt;

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



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
163
164
165
166
167
168
169
170
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 114

def create_digital_wallet_google_with_http_info(card_id, google_digital_wallet_provision_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DigitalWalletTokensApi.create_digital_wallet_google ...'
  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 DigitalWalletTokensApi.create_digital_wallet_google"
  end
  # verify the required parameter 'google_digital_wallet_provision_request' is set
  if @api_client.config.client_side_validation && google_digital_wallet_provision_request.nil?
    fail ArgumentError, "Missing the required parameter 'google_digital_wallet_provision_request' when calling DigitalWalletTokensApi.create_digital_wallet_google"
  end
  # resource path
  local_var_path = '/cards/{card_id}/digital_wallet_tokens/googlepay'.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(google_digital_wallet_provision_request)

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

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

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

#get_digital_wallet_token(digital_wallet_token_id, opts = {}) ⇒ DigitalWalletTokenResponse

Get Digital Wallet Token Get the details about the digital wallet token of a card
NB: Digital wallet tokens cannot be created outside of production</br>

Parameters:

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

    the optional parameters

Returns:



177
178
179
180
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 177

def get_digital_wallet_token(digital_wallet_token_id, opts = {})
  data, _status_code, _headers = get_digital_wallet_token_with_http_info(digital_wallet_token_id, opts)
  data
end

#get_digital_wallet_token_with_http_info(digital_wallet_token_id, opts = {}) ⇒ Array<(DigitalWalletTokenResponse, Integer, Hash)>

Get Digital Wallet Token Get the details about the digital wallet token of a card &lt;br&gt;NB: Digital wallet tokens cannot be created outside of production&lt;/br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    DigitalWalletTokenResponse data, response status code and response headers



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/digital_wallet_tokens_api.rb', line 187

def get_digital_wallet_token_with_http_info(digital_wallet_token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DigitalWalletTokensApi.get_digital_wallet_token ...'
  end
  # verify the required parameter 'digital_wallet_token_id' is set
  if @api_client.config.client_side_validation && digital_wallet_token_id.nil?
    fail ArgumentError, "Missing the required parameter 'digital_wallet_token_id' when calling DigitalWalletTokensApi.get_digital_wallet_token"
  end
  # resource path
  local_var_path = '/cards/digital_wallet_tokens/{digital_wallet_token_id}'.sub('{' + 'digital_wallet_token_id' + '}', CGI.escape(digital_wallet_token_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] || 'DigitalWalletTokenResponse'

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

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

#list_digital_wallet_tokens(opts = {}) ⇒ TokenListResponse

List Digital Wallet Tokens List Digital Wallet Tokens
NB: Digital wallet tokens cannot be created outside of production</br>

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :card_id (String)
  • :token_state (DigitalWalletTokenState) —

    The status of the Digital Wallet Token

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

Returns:



243
244
245
246
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 243

def list_digital_wallet_tokens(opts = {})
  data, _status_code, _headers = list_digital_wallet_tokens_with_http_info(opts)
  data
end

#list_digital_wallet_tokens_with_http_info(opts = {}) ⇒ Array<(TokenListResponse, Integer, Hash)>

List Digital Wallet Tokens List Digital Wallet Tokens &lt;br&gt;NB: Digital wallet tokens cannot be created outside of production&lt;/br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :card_id (String)
  • :token_state (DigitalWalletTokenState) —

    The status of the Digital Wallet Token

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

Returns:

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

    TokenListResponse data, response status code and response headers



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
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 256

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

  # resource path
  local_var_path = '/cards/digital_wallet_tokens'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'card_id'] = opts[:'card_id'] if !opts[:'card_id'].nil?
  query_params[:'token_state'] = opts[:'token_state'] if !opts[:'token_state'].nil?
  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] || 'TokenListResponse'

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

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

#update_digital_wallet_token_status(digital_wallet_token_id, digital_wallet_token_edit_request, opts = {}) ⇒ DigitalWalletTokenResponse

Update Digital Wallet Token’s life cycle status The status of a digital wallet token can be updated as, ACTIVE to SUSPENDED, SUSPENDED to ACTIVE, ACTIVE to TERMINATED or SUSPENDED to TERMINATED.

Parameters:

  • digital_wallet_token_id (String)
  • digital_wallet_token_edit_request (DigitalWalletTokenEditRequest) —

    Update Digital wallet token status

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



315
316
317
318
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 315

def update_digital_wallet_token_status(digital_wallet_token_id, digital_wallet_token_edit_request, opts = {})
  data, _status_code, _headers = update_digital_wallet_token_status_with_http_info(digital_wallet_token_id, digital_wallet_token_edit_request, opts)
  data
end

#update_digital_wallet_token_status_with_http_info(digital_wallet_token_id, digital_wallet_token_edit_request, opts = {}) ⇒ Array<(DigitalWalletTokenResponse, Integer, Hash)>

Update Digital Wallet Token&#39;s life cycle status The status of a digital wallet token can be updated as, ACTIVE to SUSPENDED, SUSPENDED to ACTIVE, ACTIVE to TERMINATED or SUSPENDED to TERMINATED.

Parameters:

  • digital_wallet_token_id (String)
  • digital_wallet_token_edit_request (DigitalWalletTokenEditRequest) —

    Update Digital wallet token status

  • 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<(DigitalWalletTokenResponse, Integer, Hash)>) —

    DigitalWalletTokenResponse data, response status code and response headers



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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/synctera_ruby_sdk/api/digital_wallet_tokens_api.rb', line 327

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

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

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

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