Class: OrderCloud::PaymentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/api/payment_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentApi

Returns a new instance of PaymentApi.



30
31
32
 
# File 'lib/order_cloud/api/payment_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/order_cloud/api/payment_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create(buyer_id, order_id, payment, opts = {}) ⇒ Payment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

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

    the optional parameters

Returns:



41
42
43
44
 
# File 'lib/order_cloud/api/payment_api.rb', line 41

def create(buyer_id, order_id, payment, opts = {})
  data, _status_code, _headers = create_with_http_info(buyer_id, order_id, payment, opts)
  return data
end

#create_transaction(buyer_id, order_id, payment_id, transaction, opts = {}) ⇒ Payment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:



107
108
109
110
 
# File 'lib/order_cloud/api/payment_api.rb', line 107

def create_transaction(buyer_id, order_id, payment_id, transaction, opts = {})
  data, _status_code, _headers = create_transaction_with_http_info(buyer_id, order_id, payment_id, transaction, opts)
  return data
end

#create_transaction_with_http_info(buyer_id, order_id, payment_id, transaction, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Returns Payment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
 
# File 'lib/order_cloud/api/payment_api.rb', line 120

def create_transaction_with_http_info(buyer_id, order_id, payment_id, transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.create_transaction ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.create_transaction" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.create_transaction" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.create_transaction" if payment_id.nil?
  # verify the required parameter 'transaction' is set
  fail ArgumentError, "Missing the required parameter 'transaction' when calling PaymentApi.create_transaction" if transaction.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#create_with_http_info(buyer_id, order_id, payment, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Returns Payment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
96
97
 
# File 'lib/order_cloud/api/payment_api.rb', line 53

def create_with_http_info(buyer_id, order_id, payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.create ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.create" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.create" if order_id.nil?
  # verify the required parameter 'payment' is set
  fail ArgumentError, "Missing the required parameter 'payment' when calling PaymentApi.create" if payment.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete(buyer_id, order_id, payment_id, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:

  • (nil) 


175
176
177
178
 
# File 'lib/order_cloud/api/payment_api.rb', line 175

def delete(buyer_id, order_id, payment_id, opts = {})
  delete_with_http_info(buyer_id, order_id, payment_id, opts)
  return nil
end

#delete_transaction(buyer_id, order_id, payment_id, transaction_id, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

  • transaction_id —

    ID of the transaction.

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

    the optional parameters

Returns:

  • (nil) 


240
241
242
243
 
# File 'lib/order_cloud/api/payment_api.rb', line 240

def delete_transaction(buyer_id, order_id, payment_id, transaction_id, opts = {})
  delete_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, opts)
  return nil
end

#delete_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

  • transaction_id —

    ID of the transaction.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
297
298
 
# File 'lib/order_cloud/api/payment_api.rb', line 253

def delete_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.delete_transaction ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.delete_transaction" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.delete_transaction" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.delete_transaction" if payment_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PaymentApi.delete_transaction" if transaction_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s).sub('{' + 'transactionID' + '}', transaction_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete_with_http_info(buyer_id, order_id, payment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/order_cloud/api/payment_api.rb', line 187

def delete_with_http_info(buyer_id, order_id, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.delete ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.delete" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.delete" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.delete" if payment_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get(buyer_id, order_id, payment_id, opts = {}) ⇒ Payment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:



307
308
309
310
 
# File 'lib/order_cloud/api/payment_api.rb', line 307

def get(buyer_id, order_id, payment_id, opts = {})
  data, _status_code, _headers = get_with_http_info(buyer_id, order_id, payment_id, opts)
  return data
end

#get_with_http_info(buyer_id, order_id, payment_id, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Returns Payment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/order_cloud/api/payment_api.rb', line 319

def get_with_http_info(buyer_id, order_id, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.get ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.get" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.get" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.get" if payment_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#list(buyer_id, order_id, opts = {}) ⇒ ListPayment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

  • :filters (Hash<String, String>) —

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:



377
378
379
380
 
# File 'lib/order_cloud/api/payment_api.rb', line 377

def list(buyer_id, order_id, opts = {})
  data, _status_code, _headers = list_with_http_info(buyer_id, order_id, opts)
  return data
end

#list_with_http_info(buyer_id, order_id, opts = {}) ⇒ Array<(ListPayment, Fixnum, Hash)>

Returns ListPayment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

  • :filters (Hash<String, String>) —

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:

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

    ListPayment data, response status code and response headers



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
437
438
439
440
441
442
 
# File 'lib/order_cloud/api/payment_api.rb', line 394

def list_with_http_info(buyer_id, order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.list ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.list" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.list" if order_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#patch(buyer_id, order_id, payment_id, partial_payment, opts = {}) ⇒ Payment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:



452
453
454
455
 
# File 'lib/order_cloud/api/payment_api.rb', line 452

def patch(buyer_id, order_id, payment_id, partial_payment, opts = {})
  data, _status_code, _headers = patch_with_http_info(buyer_id, order_id, payment_id, partial_payment, opts)
  return data
end

#patch_transaction(buyer_id, order_id, payment_id, transaction_id, partial_transaction, opts = {}) ⇒ Payment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

  • transaction_id —

    ID of the transaction.

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

    the optional parameters

Returns:



522
523
524
525
 
# File 'lib/order_cloud/api/payment_api.rb', line 522

def patch_transaction(buyer_id, order_id, payment_id, transaction_id, partial_transaction, opts = {})
  data, _status_code, _headers = patch_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, partial_transaction, opts)
  return data
end

#patch_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, partial_transaction, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Returns Payment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

  • transaction_id —

    ID of the transaction.

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/order_cloud/api/payment_api.rb', line 536

def patch_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, partial_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.patch_transaction ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.patch_transaction" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.patch_transaction" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.patch_transaction" if payment_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PaymentApi.patch_transaction" if transaction_id.nil?
  # verify the required parameter 'partial_transaction' is set
  fail ArgumentError, "Missing the required parameter 'partial_transaction' when calling PaymentApi.patch_transaction" if partial_transaction.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s).sub('{' + 'transactionID' + '}', transaction_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(partial_transaction)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#patch_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_with_http_info(buyer_id, order_id, payment_id, partial_payment, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Returns Payment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/order_cloud/api/payment_api.rb', line 465

def patch_with_http_info(buyer_id, order_id, payment_id, partial_payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.patch ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.patch" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.patch" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.patch" if payment_id.nil?
  # verify the required parameter 'partial_payment' is set
  fail ArgumentError, "Missing the required parameter 'partial_payment' when calling PaymentApi.patch" if partial_payment.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(partial_payment)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(buyer_id, order_id, payment_id, payment, opts = {}) ⇒ Payment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:



594
595
596
597
 
# File 'lib/order_cloud/api/payment_api.rb', line 594

def update(buyer_id, order_id, payment_id, payment, opts = {})
  data, _status_code, _headers = update_with_http_info(buyer_id, order_id, payment_id, payment, opts)
  return data
end

#update_transaction(buyer_id, order_id, payment_id, transaction_id, transaction, opts = {}) ⇒ Payment

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

  • transaction_id —

    ID of the transaction.

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

    the optional parameters

Returns:



664
665
666
667
 
# File 'lib/order_cloud/api/payment_api.rb', line 664

def update_transaction(buyer_id, order_id, payment_id, transaction_id, transaction, opts = {})
  data, _status_code, _headers = update_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, transaction, opts)
  return data
end

#update_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, transaction, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Returns Payment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

  • transaction_id —

    ID of the transaction.

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/order_cloud/api/payment_api.rb', line 678

def update_transaction_with_http_info(buyer_id, order_id, payment_id, transaction_id, transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.update_transaction ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.update_transaction" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.update_transaction" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.update_transaction" if payment_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PaymentApi.update_transaction" if transaction_id.nil?
  # verify the required parameter 'transaction' is set
  fail ArgumentError, "Missing the required parameter 'transaction' when calling PaymentApi.update_transaction" if transaction.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s).sub('{' + 'transactionID' + '}', transaction_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(transaction)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_with_http_info(buyer_id, order_id, payment_id, payment, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Returns Payment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • order_id —

    ID of the order.

  • payment_id —

    ID of the payment.

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/order_cloud/api/payment_api.rb', line 607

def update_with_http_info(buyer_id, order_id, payment_id, payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.update ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling PaymentApi.update" if buyer_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentApi.update" if order_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentApi.update" if payment_id.nil?
  # verify the required parameter 'payment' is set
  fail ArgumentError, "Missing the required parameter 'payment' when calling PaymentApi.update" if payment.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/orders/{orderID}/payments/{paymentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'paymentID' + '}', payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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