Class: Billabear::PaymentDetailsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/billabear/api/payment_details_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentDetailsApi

Returns a new instance of PaymentDetailsApi.



16
17
18
# File 'lib/billabear/api/payment_details_api.rb', line 16

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



14
15
16
# File 'lib/billabear/api/payment_details_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#complete_frontend_payment_details(body, customer_id, opts = {}) ⇒ PaymentDetails

Complete Frontend Detail Collection Complete frontend payment details

Parameters:

  • body
  • customer_id

    The id of the customer to retrieve

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

    the optional parameters

Returns:



25
26
27
28
# File 'lib/billabear/api/payment_details_api.rb', line 25

def complete_frontend_payment_details(body, customer_id, opts = {})
  data, _status_code, _headers = complete_frontend_payment_details_with_http_info(body, customer_id, opts)
  data
end

#complete_frontend_payment_details_with_http_info(body, customer_id, opts = {}) ⇒ Array<(PaymentDetails, Integer, Hash)>

Complete Frontend Detail Collection Complete frontend payment details

Parameters:

  • body
  • customer_id

    The id of the customer to retrieve

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

    the optional parameters

Returns:

  • (Array<(PaymentDetails, Integer, Hash)>)

    PaymentDetails data, response status code and response headers



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/billabear/api/payment_details_api.rb', line 36

def complete_frontend_payment_details_with_http_info(body, customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.complete_frontend_payment_details ...'
  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 PaymentDetailsApi.complete_frontend_payment_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 PaymentDetailsApi.complete_frontend_payment_details"
  end
  # resource path
  local_var_path = '/customer/{customerId}/payment-methods/frontend-payment-token'.sub('{' + 'customerId' + '}', customer_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'PaymentDetails' 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#complete_frontend_payment_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_payment_details(payment_details_id, opts = {}) ⇒ nil

Delete Delete Payment Details

Parameters:

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (nil)


88
89
90
91
# File 'lib/billabear/api/payment_details_api.rb', line 88

def delete_payment_details(payment_details_id, opts = {})
  delete_payment_details_with_http_info(payment_details_id, opts)
  nil
end

#delete_payment_details_customer(customer_id, payment_details_id, opts = {}) ⇒ nil

Delete With Customer Delete Payment Details

Parameters:

  • customer_id

    The id of the customer to retrieve

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (nil)


145
146
147
148
# File 'lib/billabear/api/payment_details_api.rb', line 145

def delete_payment_details_customer(customer_id, payment_details_id, opts = {})
  delete_payment_details_customer_with_http_info(customer_id, payment_details_id, opts)
  nil
end

#delete_payment_details_customer_with_http_info(customer_id, payment_details_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete With Customer Delete Payment Details

Parameters:

  • customer_id

    The id of the customer to retrieve

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/billabear/api/payment_details_api.rb', line 156

def delete_payment_details_customer_with_http_info(customer_id, payment_details_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.delete_payment_details_customer ...'
  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 PaymentDetailsApi.delete_payment_details_customer"
  end
  # verify the required parameter 'payment_details_id' is set
  if @api_client.config.client_side_validation && payment_details_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_details_id' when calling PaymentDetailsApi.delete_payment_details_customer"
  end
  # resource path
  local_var_path = '/customer/{customerId}/payment-methods/{paymentDetailsId}'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'paymentDetailsId' + '}', payment_details_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'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#delete_payment_details_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_payment_details_with_http_info(payment_details_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Delete Payment Details

Parameters:

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/billabear/api/payment_details_api.rb', line 98

def delete_payment_details_with_http_info(payment_details_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.delete_payment_details ...'
  end
  # verify the required parameter 'payment_details_id' is set
  if @api_client.config.client_side_validation && payment_details_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_details_id' when calling PaymentDetailsApi.delete_payment_details"
  end
  # resource path
  local_var_path = '/payment-methods/{paymentDetailsId}'.sub('{' + 'paymentDetailsId' + '}', payment_details_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'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#delete_payment_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_details(payment_details_id, opts = {}) ⇒ PaymentDetails

Fetch Fetch the payment cards

Parameters:

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:



206
207
208
209
# File 'lib/billabear/api/payment_details_api.rb', line 206

def get_payment_details(payment_details_id, opts = {})
  data, _status_code, _headers = get_payment_details_with_http_info(payment_details_id, opts)
  data
end

#get_payment_details_with_http_info(payment_details_id, opts = {}) ⇒ Array<(PaymentDetails, Integer, Hash)>

Fetch Fetch the payment cards

Parameters:

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (Array<(PaymentDetails, Integer, Hash)>)

    PaymentDetails data, response status code and response headers



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/billabear/api/payment_details_api.rb', line 216

def get_payment_details_with_http_info(payment_details_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.get_payment_details ...'
  end
  # verify the required parameter 'payment_details_id' is set
  if @api_client.config.client_side_validation && payment_details_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_details_id' when calling PaymentDetailsApi.get_payment_details"
  end
  # resource path
  local_var_path = '/payment-methods/{paymentDetailsId}'.sub('{' + 'paymentDetailsId' + '}', payment_details_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'])

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

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

  return_type = opts[:return_type] || 'PaymentDetails' 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#get_payment_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_payment_details(customer_id, opts = {}) ⇒ InlineResponse2007

List Customer’s Payment Details List all customers
Added in version 1.1

Parameters:

  • customer_id

    The id of the customer to retrieve

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

    the optional parameters

Returns:



262
263
264
265
# File 'lib/billabear/api/payment_details_api.rb', line 262

def list_payment_details(customer_id, opts = {})
  data, _status_code, _headers = list_payment_details_with_http_info(customer_id, opts)
  data
end

#list_payment_details_with_http_info(customer_id, opts = {}) ⇒ Array<(InlineResponse2007, Integer, Hash)>

List Customer&#x27;s Payment Details List all customers &lt;br&gt;&lt;br&gt;Added in version 1.1

Parameters:

  • customer_id

    The id of the customer to retrieve

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

    the optional parameters

Returns:

  • (Array<(InlineResponse2007, Integer, Hash)>)

    InlineResponse2007 data, response status code and response headers



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
307
308
309
310
311
312
# File 'lib/billabear/api/payment_details_api.rb', line 272

def list_payment_details_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.list_payment_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 PaymentDetailsApi.list_payment_details"
  end
  # resource path
  local_var_path = '/customer/{customerId}/payment-methods'.sub('{' + 'customerId' + '}', customer_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'])

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

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

  return_type = opts[:return_type] || 'InlineResponse2007' 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#list_payment_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#make_default_payment_details(customer_id, payment_details_id, opts = {}) ⇒ nil

Make Default Delete Payment Details

Parameters:

  • customer_id

    The id of the customer to retrieve

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (nil)


319
320
321
322
# File 'lib/billabear/api/payment_details_api.rb', line 319

def make_default_payment_details(customer_id, payment_details_id, opts = {})
  make_default_payment_details_with_http_info(customer_id, payment_details_id, opts)
  nil
end

#make_default_payment_details_customer(customer_id, payment_details_id, opts = {}) ⇒ nil

Make Default With Customer Delete Payment Details

Parameters:

  • customer_id

    The id of the customer to retrieve

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (nil)


381
382
383
384
# File 'lib/billabear/api/payment_details_api.rb', line 381

def make_default_payment_details_customer(customer_id, payment_details_id, opts = {})
  make_default_payment_details_customer_with_http_info(customer_id, payment_details_id, opts)
  nil
end

#make_default_payment_details_customer_with_http_info(customer_id, payment_details_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Make Default With Customer Delete Payment Details

Parameters:

  • customer_id

    The id of the customer to retrieve

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers



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
431
432
433
434
435
436
# File 'lib/billabear/api/payment_details_api.rb', line 392

def make_default_payment_details_customer_with_http_info(customer_id, payment_details_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.make_default_payment_details_customer ...'
  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 PaymentDetailsApi.make_default_payment_details_customer"
  end
  # verify the required parameter 'payment_details_id' is set
  if @api_client.config.client_side_validation && payment_details_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_details_id' when calling PaymentDetailsApi.make_default_payment_details_customer"
  end
  # resource path
  local_var_path = '/customer/{customerId}/payment-methods/{paymentDetailsId}/default'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'paymentDetailsId' + '}', payment_details_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'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#make_default_payment_details_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#make_default_payment_details_with_http_info(customer_id, payment_details_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Make Default Delete Payment Details

Parameters:

  • customer_id

    The id of the customer to retrieve

  • payment_details_id

    The id of the payment details

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers



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
# File 'lib/billabear/api/payment_details_api.rb', line 330

def make_default_payment_details_with_http_info(customer_id, payment_details_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.make_default_payment_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 PaymentDetailsApi.make_default_payment_details"
  end
  # verify the required parameter 'payment_details_id' is set
  if @api_client.config.client_side_validation && payment_details_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_details_id' when calling PaymentDetailsApi.make_default_payment_details"
  end
  # resource path
  local_var_path = '/payment-methods/{paymentDetailsId}/default'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'paymentDetailsId' + '}', payment_details_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'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#make_default_payment_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#start_frontend_payment_details(customer_id, opts = {}) ⇒ FrontendToken

Start Frontend Detail Collection Start frontend payment details

Parameters:

  • customer_id

    The id of the customer to retrieve

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

    the optional parameters

Returns:



442
443
444
445
# File 'lib/billabear/api/payment_details_api.rb', line 442

def start_frontend_payment_details(customer_id, opts = {})
  data, _status_code, _headers = start_frontend_payment_details_with_http_info(customer_id, opts)
  data
end

#start_frontend_payment_details_with_http_info(customer_id, opts = {}) ⇒ Array<(FrontendToken, Integer, Hash)>

Start Frontend Detail Collection Start frontend payment details

Parameters:

  • customer_id

    The id of the customer to retrieve

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

    the optional parameters

Returns:

  • (Array<(FrontendToken, Integer, Hash)>)

    FrontendToken data, response status code and response headers



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
# File 'lib/billabear/api/payment_details_api.rb', line 452

def start_frontend_payment_details_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentDetailsApi.start_frontend_payment_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 PaymentDetailsApi.start_frontend_payment_details"
  end
  # resource path
  local_var_path = '/customer/{customerId}/payment-methods/frontend-payment-token'.sub('{' + 'customerId' + '}', customer_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'])

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

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

  return_type = opts[:return_type] || 'FrontendToken' 

  auth_names = opts[:auth_names] || ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentDetailsApi#start_frontend_payment_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end