Class: PostFinanceCheckout::TokenService

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TokenService

Returns a new instance of TokenService.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#check_token_creation_possible(space_id, transaction_id, opts = {}) ⇒ BOOLEAN

Check If Token Creation Is Possible This operation checks if the given transaction can be used to create a token out of it.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to check if the token can be created or not.

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

    the optional parameters

Returns:

  • (BOOLEAN) 


34
35
36
37
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 34

def check_token_creation_possible(space_id, transaction_id, opts = {})
  data, _status_code, _headers = check_token_creation_possible_with_http_info(space_id, transaction_id, opts)
  return data
end

#check_token_creation_possible_with_http_info(space_id, transaction_id, opts = {}) ⇒ Array<(BOOLEAN, Fixnum, Hash)>

Returns BOOLEAN data, response status code and response headers.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to check if the token can be created or not.

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

    the optional parameters

Returns:

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

    BOOLEAN data, response status code and response headers



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
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 46

def check_token_creation_possible_with_http_info(space_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.check_token_creation_possible ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.check_token_creation_possible" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.check_token_creation_possible" if transaction_id.nil?
  # resource path
  local_var_path = "/token/check-token-creation-possible".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#count(space_id, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Integer) 


102
103
104
105
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 102

def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end

#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Returns Integer data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

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

    Integer data, response status code and response headers



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
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 114

def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.count" if space_id.nil?
  # resource path
  local_var_path = "/token/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#create(space_id, entity, opts = {}) ⇒ Token

Create Creates the entity with the given properties.

Parameters:

  • space_id
  • entity —

    The token object with the properties which should be created.

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

    the optional parameters

Returns:



167
168
169
170
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 167

def create(space_id, entity, opts = {})
  data, _status_code, _headers = create_with_http_info(space_id, entity, opts)
  return data
end

#create_token(space_id, transaction_id, opts = {}) ⇒ Token

Create Token This operation creates a token for the given transaction.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to create the token.

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

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 234

def create_token(space_id, transaction_id, opts = {})
  data, _status_code, _headers = create_token_with_http_info(space_id, transaction_id, opts)
  return data
end

#create_token_based_on_transaction(space_id, transaction_id, opts = {}) ⇒ TokenVersion

Create Token Based On Transaction This operation creates a token for the given transaction and fills it with the stored payment information of the transaction.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to create the token.

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

    the optional parameters

Returns:



302
303
304
305
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 302

def create_token_based_on_transaction(space_id, transaction_id, opts = {})
  data, _status_code, _headers = create_token_based_on_transaction_with_http_info(space_id, transaction_id, opts)
  return data
end

#create_token_based_on_transaction_with_http_info(space_id, transaction_id, opts = {}) ⇒ Array<(TokenVersion, Fixnum, Hash)>

Returns TokenVersion data, response status code and response headers.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to create the token.

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

    the optional parameters

Returns:

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

    TokenVersion data, response status code and response headers



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
360
361
362
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 314

def create_token_based_on_transaction_with_http_info(space_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.create_token_based_on_transaction ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create_token_based_on_transaction" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.create_token_based_on_transaction" if transaction_id.nil?
  # resource path
  local_var_path = "/token/create-token-based-on-transaction".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#create_token_with_http_info(space_id, transaction_id, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Returns Token data, response status code and response headers.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to create the token.

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



246
247
248
249
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
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 246

def create_token_with_http_info(space_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.create_token ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create_token" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.create_token" if transaction_id.nil?
  # resource path
  local_var_path = "/token/create-token".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#create_transaction_for_token_update(space_id, token_id, opts = {}) ⇒ Transaction

Create Transaction for Token Update This operation creates a transaction which allows the updating of the provided token.

Parameters:

  • space_id
  • token_id —

    The id of the token which should be updated.

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

    the optional parameters

Returns:



370
371
372
373
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 370

def create_transaction_for_token_update(space_id, token_id, opts = {})
  data, _status_code, _headers = create_transaction_for_token_update_with_http_info(space_id, token_id, opts)
  return data
end

#create_transaction_for_token_update_with_http_info(space_id, token_id, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • space_id
  • token_id —

    The id of the token which should be updated.

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

    the optional parameters

Returns:

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

    Transaction data, response status code and response headers



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 382

def create_transaction_for_token_update_with_http_info(space_id, token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.create_transaction_for_token_update ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create_transaction_for_token_update" if space_id.nil?
  # verify the required parameter 'token_id' is set
  fail ArgumentError, "Missing the required parameter 'token_id' when calling TokenService.create_transaction_for_token_update" if token_id.nil?
  # resource path
  local_var_path = "/token/createTransactionForTokenUpdate".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'tokenId'] = token_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#create_with_http_info(space_id, entity, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Returns Token data, response status code and response headers.

Parameters:

  • space_id
  • entity —

    The token object with the properties which should be created.

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



179
180
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
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 179

def create_with_http_info(space_id, entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.create ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.create" if space_id.nil?
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling TokenService.create" if entity.nil?
  # resource path
  local_var_path = "/token/create".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#delete(space_id, id, opts = {}) ⇒ nil

Delete Deletes the entity with the given id.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


438
439
440
441
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 438

def delete(space_id, id, opts = {})
  delete_with_http_info(space_id, id, opts)
  return nil
end

#delete_with_http_info(space_id, id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 450

def delete_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.delete ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.delete" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling TokenService.delete" if id.nil?
  # resource path
  local_var_path = "/token/delete".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#process_transaction(space_id, transaction_id, opts = {}) ⇒ Charge

Process Transaction This operation processes the given transaction by using the token associated with the transaction.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to check if the token can be created or not.

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

    the optional parameters

Returns:



504
505
506
507
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 504

def process_transaction(space_id, transaction_id, opts = {})
  data, _status_code, _headers = process_transaction_with_http_info(space_id, transaction_id, opts)
  return data
end

#process_transaction_with_http_info(space_id, transaction_id, opts = {}) ⇒ Array<(Charge, Fixnum, Hash)>

Returns Charge data, response status code and response headers.

Parameters:

  • space_id
  • transaction_id —

    The id of the transaction for which we want to check if the token can be created or not.

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

    the optional parameters

Returns:

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

    Charge data, response status code and response headers



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
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 516

def process_transaction_with_http_info(space_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.process_transaction ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.process_transaction" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TokenService.process_transaction" if transaction_id.nil?
  # resource path
  local_var_path = "/token/process-transaction".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#read(space_id, id, opts = {}) ⇒ Token

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • space_id
  • id —

    The id of the token which should be returned.

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

    the optional parameters

Returns:



572
573
574
575
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 572

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Returns Token data, response status code and response headers.

Parameters:

  • space_id
  • id —

    The id of the token which should be returned.

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 584

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling TokenService.read" if id.nil?
  # resource path
  local_var_path = "/token/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#search(space_id, query, opts = {}) ⇒ Array<Token>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the tokens which are returned by the search.

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

    the optional parameters

Returns:



640
641
642
643
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 640

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<Token>, Fixnum, Hash)>

Returns Array<Token> data, response status code and response headers.

Parameters:

  • space_id
  • query —

    The query restricts the tokens which are returned by the search.

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

    the optional parameters

Returns:

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

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



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
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 652

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling TokenService.search" if query.nil?
  # resource path
  local_var_path = "/token/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :timeout => timeout,
    :auth_names => auth_names,
    :return_type => 'Array<Token>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokenService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(space_id, entity, opts = {}) ⇒ Token

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The ‘id’ and ‘version’ are required to identify the entity.

Parameters:

  • space_id
  • entity —

    The object with all the properties which should be updated. The id and the version are required properties.

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

    the optional parameters

Returns:



707
708
709
710
 
# File 'lib/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 707

def update(space_id, entity, opts = {})
  data, _status_code, _headers = update_with_http_info(space_id, entity, opts)
  return data
end

#update_with_http_info(space_id, entity, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Returns Token data, response status code and response headers.

Parameters:

  • space_id
  • entity —

    The object with all the properties which should be updated. The id and the version are required properties.

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



719
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/postfinancecheckout-ruby-sdk/api/token_service_api.rb', line 719

def update_with_http_info(space_id, entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokenService.update ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TokenService.update" if space_id.nil?
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling TokenService.update" if entity.nil?
  # resource path
  local_var_path = "/token/update".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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