connect-sdk-ruby 1.30.0 → 1.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/connect-sdk-ruby.gemspec +1 -1
  3. data/examples/merchant/disputes/get_dispute_example.rb +22 -0
  4. data/examples/merchant/disputes/submit_dispute_example.rb +22 -0
  5. data/examples/merchant/payments/create_payment_dispute_example.rb +37 -0
  6. data/examples/merchant/payments/get_payment_disputes_example.rb +22 -0
  7. data/lib/ingenico/connect/sdk/domain/dispute/create_dispute_request.rb +63 -0
  8. data/lib/ingenico/connect/sdk/domain/dispute/dispute.rb +67 -0
  9. data/lib/ingenico/connect/sdk/domain/dispute/dispute_creation_detail.rb +45 -0
  10. data/lib/ingenico/connect/sdk/domain/dispute/dispute_output.rb +106 -0
  11. data/lib/ingenico/connect/sdk/domain/dispute/dispute_reference.rb +59 -0
  12. data/lib/ingenico/connect/sdk/domain/dispute/dispute_response.rb +15 -0
  13. data/lib/ingenico/connect/sdk/domain/dispute/dispute_status_output.rb +52 -0
  14. data/lib/ingenico/connect/sdk/domain/dispute/disputes_response.rb +38 -0
  15. data/lib/ingenico/connect/sdk/domain/file/hosted_file.rb +52 -0
  16. data/lib/ingenico/connect/sdk/domain/payment/abstract_redirect_payment_product840_specific_input.rb +31 -0
  17. data/lib/ingenico/connect/sdk/domain/payment/redirect_payment_method_specific_input_base.rb +20 -0
  18. data/lib/ingenico/connect/sdk/domain/payment/redirect_payment_product840_specific_input.rb +2 -2
  19. data/lib/ingenico/connect/sdk/domain/payment/redirect_payment_product840_specific_input_base.rb +15 -0
  20. data/lib/ingenico/connect/sdk/merchant/captures/captures_client.rb +1 -3
  21. data/lib/ingenico/connect/sdk/merchant/disputes/disputes_client.rb +86 -0
  22. data/lib/ingenico/connect/sdk/merchant/hostedcheckouts/hostedcheckouts_client.rb +2 -6
  23. data/lib/ingenico/connect/sdk/merchant/hostedmandatemanagements/hostedmandatemanagements_client.rb +2 -6
  24. data/lib/ingenico/connect/sdk/merchant/mandates/mandates_client.rb +6 -18
  25. data/lib/ingenico/connect/sdk/merchant/merchant_client.rb +7 -26
  26. data/lib/ingenico/connect/sdk/merchant/payments/payments_client.rb +78 -42
  27. data/lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb +6 -18
  28. data/lib/ingenico/connect/sdk/merchant/productgroups/productgroups_client.rb +3 -9
  29. data/lib/ingenico/connect/sdk/merchant/products/products_client.rb +7 -21
  30. data/lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb +5 -15
  31. data/lib/ingenico/connect/sdk/merchant/riskassessments/riskassessments_client.rb +2 -6
  32. data/lib/ingenico/connect/sdk/merchant/services/services_client.rb +4 -12
  33. data/lib/ingenico/connect/sdk/merchant/sessions/sessions_client.rb +1 -3
  34. data/lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb +5 -15
  35. data/lib/ingenico/connect/sdk/meta_data_provider.rb +1 -1
  36. data/lib/ingenico/connect/sdk/modules.rb +14 -0
  37. metadata +18 -2
@@ -4,6 +4,7 @@
4
4
  #
5
5
  require 'ingenico/connect/sdk/api_resource'
6
6
  require 'ingenico/connect/sdk/merchant/captures/captures_client'
7
+ require 'ingenico/connect/sdk/merchant/disputes/disputes_client'
7
8
  require 'ingenico/connect/sdk/merchant/hostedcheckouts/hostedcheckouts_client'
8
9
  require 'ingenico/connect/sdk/merchant/hostedmandatemanagements/hostedmandatemanagements_client'
9
10
  require 'ingenico/connect/sdk/merchant/mandates/mandates_client'
@@ -30,104 +31,84 @@ module Ingenico::Connect::SDK
30
31
  end
31
32
 
32
33
  # Resource /{{merchantId}}/hostedcheckouts
33
- #
34
- # Create new hosted checkout
35
34
  # Returns:: {Ingenico::Connect::SDK::Merchant::Hostedcheckouts::HostedcheckoutsClient}
36
35
  def hostedcheckouts
37
36
  Ingenico::Connect::SDK::Merchant::Hostedcheckouts::HostedcheckoutsClient.new(self, nil)
38
37
  end
39
38
 
40
39
  # Resource /{{merchantId}}/hostedmandatemanagements
41
- #
42
- # Create new hosted mandate management
43
40
  # Returns:: {Ingenico::Connect::SDK::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient}
44
41
  def hostedmandatemanagements
45
42
  Ingenico::Connect::SDK::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient.new(self, nil)
46
43
  end
47
44
 
48
45
  # Resource /{{merchantId}}/payments
49
- #
50
- # Create, cancel and approve payments
51
46
  # Returns:: {Ingenico::Connect::SDK::Merchant::Payments::PaymentsClient}
52
47
  def payments
53
48
  Ingenico::Connect::SDK::Merchant::Payments::PaymentsClient.new(self, nil)
54
49
  end
55
50
 
56
51
  # Resource /{{merchantId}}/captures
57
- #
58
- # Get capture
59
52
  # Returns:: {Ingenico::Connect::SDK::Merchant::Captures::CapturesClient}
60
53
  def captures
61
54
  Ingenico::Connect::SDK::Merchant::Captures::CapturesClient.new(self, nil)
62
55
  end
63
56
 
64
57
  # Resource /{{merchantId}}/refunds
65
- #
66
- # Create, cancel and approve refunds
67
58
  # Returns:: {Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient}
68
59
  def refunds
69
60
  Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient.new(self, nil)
70
61
  end
71
62
 
63
+ # Resource /{{merchantId}}/disputes
64
+ # Returns:: {Ingenico::Connect::SDK::Merchant::Disputes::DisputesClient}
65
+ def disputes
66
+ Ingenico::Connect::SDK::Merchant::Disputes::DisputesClient.new(self, nil)
67
+ end
68
+
72
69
  # Resource /{{merchantId}}/payouts
73
- #
74
- # Create, cancel and approve payouts
75
70
  # Returns:: {Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient}
76
71
  def payouts
77
72
  Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient.new(self, nil)
78
73
  end
79
74
 
80
75
  # Resource /{{merchantId}}/productgroups
81
- #
82
- # Get information about payment product groups
83
76
  # Returns:: {Ingenico::Connect::SDK::Merchant::Productgroups::ProductgroupsClient}
84
77
  def productgroups
85
78
  Ingenico::Connect::SDK::Merchant::Productgroups::ProductgroupsClient.new(self, nil)
86
79
  end
87
80
 
88
81
  # Resource /{{merchantId}}/products
89
- #
90
- # Get information about payment products
91
82
  # Returns:: {Ingenico::Connect::SDK::Merchant::Products::ProductsClient}
92
83
  def products
93
84
  Ingenico::Connect::SDK::Merchant::Products::ProductsClient.new(self, nil)
94
85
  end
95
86
 
96
87
  # Resource /{{merchantId}}/riskassessments
97
- #
98
- # Perform risk assessments on your customer data
99
88
  # Returns:: {Ingenico::Connect::SDK::Merchant::Riskassessments::RiskassessmentsClient}
100
89
  def riskassessments
101
90
  Ingenico::Connect::SDK::Merchant::Riskassessments::RiskassessmentsClient.new(self, nil)
102
91
  end
103
92
 
104
93
  # Resource /{{merchantId}}/services
105
- #
106
- # Several services to help you
107
94
  # Returns:: {Ingenico::Connect::SDK::Merchant::Services::ServicesClient}
108
95
  def services
109
96
  Ingenico::Connect::SDK::Merchant::Services::ServicesClient.new(self, nil)
110
97
  end
111
98
 
112
99
  # Resource /{{merchantId}}/tokens
113
- #
114
- # Create, delete and update tokens
115
100
  # Returns:: {Ingenico::Connect::SDK::Merchant::Tokens::TokensClient}
116
101
  def tokens
117
102
  Ingenico::Connect::SDK::Merchant::Tokens::TokensClient.new(self, nil)
118
103
  end
119
104
 
120
105
  # Resource /{{merchantId}}/mandates
121
- #
122
- # Create, get and update mandates
123
106
  # Returns:: {Ingenico::Connect::SDK::Merchant::Mandates::MandatesClient}
124
107
  def mandates
125
108
  Ingenico::Connect::SDK::Merchant::Mandates::MandatesClient.new(self, nil)
126
109
  end
127
110
 
128
111
  # Resource /{{merchantId}}/sessions
129
- #
130
- # Create new Session for Client2Server API calls
131
112
  # Returns:: {Ingenico::Connect::SDK::Merchant::Sessions::SessionsClient}
132
113
  def sessions
133
114
  Ingenico::Connect::SDK::Merchant::Sessions::SessionsClient.new(self, nil)
@@ -6,6 +6,8 @@ require 'ingenico/connect/sdk/api_resource'
6
6
  require 'ingenico/connect/sdk/response_exception'
7
7
  require 'ingenico/connect/sdk/domain/capture/capture_response'
8
8
  require 'ingenico/connect/sdk/domain/capture/captures_response'
9
+ require 'ingenico/connect/sdk/domain/dispute/dispute_response'
10
+ require 'ingenico/connect/sdk/domain/dispute/disputes_response'
9
11
  require 'ingenico/connect/sdk/domain/errors/error_response'
10
12
  require 'ingenico/connect/sdk/domain/payment/cancel_approval_payment_response'
11
13
  require 'ingenico/connect/sdk/domain/payment/cancel_payment_response'
@@ -34,9 +36,7 @@ module Ingenico::Connect::SDK
34
36
  super(parent, path_context)
35
37
  end
36
38
 
37
- # Resource /{{merchantId}}/payments
38
- #
39
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/create.html Create payment}
39
+ # Resource /{{merchantId}}/payments - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/create.html Create payment}
40
40
  # body:: {Ingenico::Connect::SDK::Domain::Payment::CreatePaymentRequest}
41
41
  # context:: {Ingenico::Connect::SDK::CallContext}
42
42
  # Returns:: {Ingenico::Connect::SDK::Domain::Payment::CreatePaymentResponse}
@@ -65,9 +65,7 @@ module Ingenico::Connect::SDK
65
65
  raise create_exception(e.status_code, e.body, error_object, context)
66
66
  end
67
67
 
68
- # Resource /{{merchantId}}/payments
69
- #
70
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/find.html Find payments}
68
+ # Resource /{{merchantId}}/payments - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/find.html Find payments}
71
69
  # query:: {Ingenico::Connect::SDK::Merchant::Payments::FindPaymentsParams}
72
70
  # context:: {Ingenico::Connect::SDK::CallContext}
73
71
  # Returns:: {Ingenico::Connect::SDK::Domain::Payment::FindPaymentsResponse}
@@ -94,9 +92,7 @@ module Ingenico::Connect::SDK
94
92
  raise create_exception(e.status_code, e.body, error_object, context)
95
93
  end
96
94
 
97
- # Resource /{{merchantId}}/payments/{{paymentId}}
98
- #
99
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/get.html Get payment}
95
+ # Resource /{{merchantId}}/payments/{{paymentId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/get.html Get payment}
100
96
  # payment_id:: String
101
97
  # context:: {Ingenico::Connect::SDK::CallContext}
102
98
  # Returns:: {Ingenico::Connect::SDK::Domain::Payment::PaymentResponse}
@@ -126,9 +122,7 @@ module Ingenico::Connect::SDK
126
122
  raise create_exception(e.status_code, e.body, error_object, context)
127
123
  end
128
124
 
129
- # Resource /{{merchantId}}/payments/{{paymentId}}/complete
130
- #
131
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/complete.html Complete payment}
125
+ # Resource /{{merchantId}}/payments/{{paymentId}}/complete - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/complete.html Complete payment}
132
126
  # payment_id:: String
133
127
  # body:: {Ingenico::Connect::SDK::Domain::Payment::CompletePaymentRequest}
134
128
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -160,9 +154,7 @@ module Ingenico::Connect::SDK
160
154
  raise create_exception(e.status_code, e.body, error_object, context)
161
155
  end
162
156
 
163
- # Resource /{{merchantId}}/payments/{{paymentId}}/thirdpartystatus
164
- #
165
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/thirdPartyStatus.html Third party status poll}
157
+ # Resource /{{merchantId}}/payments/{{paymentId}}/thirdpartystatus - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/thirdPartyStatus.html Third party status poll}
166
158
  # payment_id:: String
167
159
  # context:: {Ingenico::Connect::SDK::CallContext}
168
160
  # Returns:: {Ingenico::Connect::SDK::Domain::Payment::ThirdPartyStatusResponse}
@@ -192,9 +184,7 @@ module Ingenico::Connect::SDK
192
184
  raise create_exception(e.status_code, e.body, error_object, context)
193
185
  end
194
186
 
195
- # Resource /{{merchantId}}/payments/{{paymentId}}/tokenize
196
- #
197
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/tokenize.html Create a token from payment}
187
+ # Resource /{{merchantId}}/payments/{{paymentId}}/tokenize - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/tokenize.html Create a token from payment}
198
188
  # payment_id:: String
199
189
  # body:: {Ingenico::Connect::SDK::Domain::Payment::TokenizePaymentRequest}
200
190
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -226,9 +216,7 @@ module Ingenico::Connect::SDK
226
216
  raise create_exception(e.status_code, e.body, error_object, context)
227
217
  end
228
218
 
229
- # Resource /{{merchantId}}/payments/{{paymentId}}/processchallenged
230
- #
231
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/processchallenged.html Approves challenged payment}
219
+ # Resource /{{merchantId}}/payments/{{paymentId}}/processchallenged - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/processchallenged.html Approves challenged payment}
232
220
  # payment_id:: String
233
221
  # context:: {Ingenico::Connect::SDK::CallContext}
234
222
  # Returns:: {Ingenico::Connect::SDK::Domain::Payment::PaymentResponse}
@@ -259,9 +247,7 @@ module Ingenico::Connect::SDK
259
247
  raise create_exception(e.status_code, e.body, error_object, context)
260
248
  end
261
249
 
262
- # Resource /{{merchantId}}/payments/{{paymentId}}/approve
263
- #
264
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/approve.html Approve payment}
250
+ # Resource /{{merchantId}}/payments/{{paymentId}}/approve - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/approve.html Approve payment}
265
251
  # payment_id:: String
266
252
  # body:: {Ingenico::Connect::SDK::Domain::Payment::ApprovePaymentRequest}
267
253
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -293,9 +279,7 @@ module Ingenico::Connect::SDK
293
279
  raise create_exception(e.status_code, e.body, error_object, context)
294
280
  end
295
281
 
296
- # Resource /{{merchantId}}/payments/{{paymentId}}/capture
297
- #
298
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/capture.html Capture payment}
282
+ # Resource /{{merchantId}}/payments/{{paymentId}}/capture - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/capture.html Capture payment}
299
283
  # payment_id:: String
300
284
  # body:: {Ingenico::Connect::SDK::Domain::Payment::CapturePaymentRequest}
301
285
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -327,9 +311,7 @@ module Ingenico::Connect::SDK
327
311
  raise create_exception(e.status_code, e.body, error_object, context)
328
312
  end
329
313
 
330
- # Resource /{{merchantId}}/payments/{{paymentId}}/cancelapproval
331
- #
332
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/cancelapproval.html Undo capture payment}
314
+ # Resource /{{merchantId}}/payments/{{paymentId}}/cancelapproval - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/cancelapproval.html Undo capture payment}
333
315
  # payment_id:: String
334
316
  # context:: {Ingenico::Connect::SDK::CallContext}
335
317
  # Returns:: {Ingenico::Connect::SDK::Domain::Payment::CancelApprovalPaymentResponse}
@@ -360,9 +342,7 @@ module Ingenico::Connect::SDK
360
342
  raise create_exception(e.status_code, e.body, error_object, context)
361
343
  end
362
344
 
363
- # Resource /{{merchantId}}/payments/{{paymentId}}/captures
364
- #
365
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/captures.html Get captures of payment}
345
+ # Resource /{{merchantId}}/payments/{{paymentId}}/captures - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/captures.html Get captures of payment}
366
346
  # payment_id:: String
367
347
  # context:: {Ingenico::Connect::SDK::CallContext}
368
348
  # Returns:: {Ingenico::Connect::SDK::Domain::Capture::CapturesResponse}
@@ -392,9 +372,7 @@ module Ingenico::Connect::SDK
392
372
  raise create_exception(e.status_code, e.body, error_object, context)
393
373
  end
394
374
 
395
- # Resource /{{merchantId}}/payments/{{paymentId}}/refund
396
- #
397
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/refund.html Create refund}
375
+ # Resource /{{merchantId}}/payments/{{paymentId}}/refund - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/refund.html Create refund}
398
376
  # payment_id:: String
399
377
  # body:: {Ingenico::Connect::SDK::Domain::Refund::RefundRequest}
400
378
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -427,9 +405,7 @@ module Ingenico::Connect::SDK
427
405
  raise create_exception(e.status_code, e.body, error_object, context)
428
406
  end
429
407
 
430
- # Resource /{{merchantId}}/payments/{{paymentId}}/refunds
431
- #
432
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/refunds.html Get refunds of payment}
408
+ # Resource /{{merchantId}}/payments/{{paymentId}}/refunds - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/refunds.html Get refunds of payment}
433
409
  # payment_id:: String
434
410
  # context:: {Ingenico::Connect::SDK::CallContext}
435
411
  # Returns:: {Ingenico::Connect::SDK::Domain::Refund::RefundsResponse}
@@ -459,9 +435,7 @@ module Ingenico::Connect::SDK
459
435
  raise create_exception(e.status_code, e.body, error_object, context)
460
436
  end
461
437
 
462
- # Resource /{{merchantId}}/payments/{{paymentId}}/cancel
463
- #
464
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/cancel.html Cancel payment}
438
+ # Resource /{{merchantId}}/payments/{{paymentId}}/cancel - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/cancel.html Cancel payment}
465
439
  # payment_id:: String
466
440
  # context:: {Ingenico::Connect::SDK::CallContext}
467
441
  # Returns:: {Ingenico::Connect::SDK::Domain::Payment::CancelPaymentResponse}
@@ -491,6 +465,68 @@ module Ingenico::Connect::SDK
491
465
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
492
466
  raise create_exception(e.status_code, e.body, error_object, context)
493
467
  end
468
+
469
+ # Resource /{{merchantId}}/payments/{{paymentId}}/dispute - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/dispute.html Create dispute}
470
+ # payment_id:: String
471
+ # body:: {Ingenico::Connect::SDK::Domain::Dispute::CreateDisputeRequest}
472
+ # context:: {Ingenico::Connect::SDK::CallContext}
473
+ # Returns:: {Ingenico::Connect::SDK::Domain::Dispute::DisputeResponse}
474
+ # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
475
+ # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
476
+ # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
477
+ # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,
478
+ # or there was a conflict (HTTP status code 404, 409 or 410)
479
+ # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the Ingenico ePayments platform,
480
+ # the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,
481
+ # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
482
+ # Raises:: {Ingenico::Connect::SDK::ApiException} if the Ingenico ePayments platform returned any other error
483
+ def dispute(payment_id, body, context=nil)
484
+ path_context = {
485
+ 'paymentId' => payment_id,
486
+ }
487
+ uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/dispute', path_context)
488
+ return @communicator.post(
489
+ uri,
490
+ client_headers,
491
+ nil,
492
+ body,
493
+ Ingenico::Connect::SDK::Domain::Dispute::DisputeResponse,
494
+ context)
495
+ rescue ResponseException => e
496
+ error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
497
+ error_object = @communicator.marshaller.unmarshal(e.body, error_type)
498
+ raise create_exception(e.status_code, e.body, error_object, context)
499
+ end
500
+
501
+ # Resource /{{merchantId}}/payments/{{paymentId}}/disputes - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/disputes.html Get disputes}
502
+ # payment_id:: String
503
+ # context:: {Ingenico::Connect::SDK::CallContext}
504
+ # Returns:: {Ingenico::Connect::SDK::Domain::Dispute::DisputesResponse}
505
+ # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
506
+ # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
507
+ # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
508
+ # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,
509
+ # or there was a conflict (HTTP status code 404, 409 or 410)
510
+ # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the Ingenico ePayments platform,
511
+ # the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,
512
+ # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
513
+ # Raises:: {Ingenico::Connect::SDK::ApiException} if the Ingenico ePayments platform returned any other error
514
+ def disputes(payment_id, context=nil)
515
+ path_context = {
516
+ 'paymentId' => payment_id,
517
+ }
518
+ uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/disputes', path_context)
519
+ return @communicator.get(
520
+ uri,
521
+ client_headers,
522
+ nil,
523
+ Ingenico::Connect::SDK::Domain::Dispute::DisputesResponse,
524
+ context)
525
+ rescue ResponseException => e
526
+ error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
527
+ error_object = @communicator.marshaller.unmarshal(e.body, error_type)
528
+ raise create_exception(e.status_code, e.body, error_object, context)
529
+ end
494
530
  end
495
531
  end
496
532
  end
@@ -22,9 +22,7 @@ module Ingenico::Connect::SDK
22
22
  super(parent, path_context)
23
23
  end
24
24
 
25
- # Resource /{{merchantId}}/payouts
26
- #
27
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/create.html Create payout}
25
+ # Resource /{{merchantId}}/payouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/create.html Create payout}
28
26
  # body:: {Ingenico::Connect::SDK::Domain::Payout::CreatePayoutRequest}
29
27
  # context:: {Ingenico::Connect::SDK::CallContext}
30
28
  # Returns:: {Ingenico::Connect::SDK::Domain::Payout::PayoutResponse}
@@ -53,9 +51,7 @@ module Ingenico::Connect::SDK
53
51
  raise create_exception(e.status_code, e.body, error_object, context)
54
52
  end
55
53
 
56
- # Resource /{{merchantId}}/payouts
57
- #
58
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts}
54
+ # Resource /{{merchantId}}/payouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts}
59
55
  # query:: {Ingenico::Connect::SDK::Merchant::Payouts::FindPayoutsParams}
60
56
  # context:: {Ingenico::Connect::SDK::CallContext}
61
57
  # Returns:: {Ingenico::Connect::SDK::Domain::Payout::FindPayoutsResponse}
@@ -82,9 +78,7 @@ module Ingenico::Connect::SDK
82
78
  raise create_exception(e.status_code, e.body, error_object, context)
83
79
  end
84
80
 
85
- # Resource /{{merchantId}}/payouts/{{payoutId}}
86
- #
87
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/get.html Get payout}
81
+ # Resource /{{merchantId}}/payouts/{{payoutId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/get.html Get payout}
88
82
  # payout_id:: String
89
83
  # context:: {Ingenico::Connect::SDK::CallContext}
90
84
  # Returns:: {Ingenico::Connect::SDK::Domain::Payout::PayoutResponse}
@@ -114,9 +108,7 @@ module Ingenico::Connect::SDK
114
108
  raise create_exception(e.status_code, e.body, error_object, context)
115
109
  end
116
110
 
117
- # Resource /{{merchantId}}/payouts/{{payoutId}}/approve
118
- #
119
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/approve.html Approve payout}
111
+ # Resource /{{merchantId}}/payouts/{{payoutId}}/approve - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/approve.html Approve payout}
120
112
  # payout_id:: String
121
113
  # body:: {Ingenico::Connect::SDK::Domain::Payout::ApprovePayoutRequest}
122
114
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -148,9 +140,7 @@ module Ingenico::Connect::SDK
148
140
  raise create_exception(e.status_code, e.body, error_object, context)
149
141
  end
150
142
 
151
- # Resource /{{merchantId}}/payouts/{{payoutId}}/cancel
152
- #
153
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancel.html Cancel payout}
143
+ # Resource /{{merchantId}}/payouts/{{payoutId}}/cancel - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancel.html Cancel payout}
154
144
  # payout_id:: String
155
145
  # context:: {Ingenico::Connect::SDK::CallContext}
156
146
  # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
@@ -180,9 +170,7 @@ module Ingenico::Connect::SDK
180
170
  raise create_exception(e.status_code, e.body, error_object, context)
181
171
  end
182
172
 
183
- # Resource /{{merchantId}}/payouts/{{payoutId}}/cancelapproval
184
- #
185
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancelapproval.html Undo approve payout}
173
+ # Resource /{{merchantId}}/payouts/{{payoutId}}/cancelapproval - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancelapproval.html Undo approve payout}
186
174
  # payout_id:: String
187
175
  # context:: {Ingenico::Connect::SDK::CallContext}
188
176
  # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
@@ -22,9 +22,7 @@ module Ingenico::Connect::SDK
22
22
  super(parent, path_context)
23
23
  end
24
24
 
25
- # Resource /{{merchantId}}/productgroups
26
- #
27
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/find.html Get payment product groups}
25
+ # Resource /{{merchantId}}/productgroups - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/find.html Get payment product groups}
28
26
  # query:: {Ingenico::Connect::SDK::Merchant::Productgroups::FindProductgroupsParams}
29
27
  # context:: {Ingenico::Connect::SDK::CallContext}
30
28
  # Returns:: {Ingenico::Connect::SDK::Domain::Product::PaymentProductGroups}
@@ -51,9 +49,7 @@ module Ingenico::Connect::SDK
51
49
  raise create_exception(e.status_code, e.body, error_object, context)
52
50
  end
53
51
 
54
- # Resource /{{merchantId}}/productgroups/{{paymentProductGroupId}}
55
- #
56
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/get.html Get payment product group}
52
+ # Resource /{{merchantId}}/productgroups/{{paymentProductGroupId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/get.html Get payment product group}
57
53
  # payment_product_group_id:: String
58
54
  # query:: {Ingenico::Connect::SDK::Merchant::Productgroups::GetProductgroupParams}
59
55
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -84,9 +80,7 @@ module Ingenico::Connect::SDK
84
80
  raise create_exception(e.status_code, e.body, error_object, context)
85
81
  end
86
82
 
87
- # Resource /{{merchantId}}/productgroups/{{paymentProductGroupId}}/deviceFingerprint
88
- #
89
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/deviceFingerprint.html Get device fingerprint}
83
+ # Resource /{{merchantId}}/productgroups/{{paymentProductGroupId}}/deviceFingerprint - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/deviceFingerprint.html Get device fingerprint}
90
84
  # payment_product_group_id:: String
91
85
  # body:: {Ingenico::Connect::SDK::Domain::Product::DeviceFingerprintRequest}
92
86
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -26,9 +26,7 @@ module Ingenico::Connect::SDK
26
26
  super(parent, path_context)
27
27
  end
28
28
 
29
- # Resource /{{merchantId}}/products
30
- #
31
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/find.html Get payment products}
29
+ # Resource /{{merchantId}}/products - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/find.html Get payment products}
32
30
  # query:: {Ingenico::Connect::SDK::Merchant::Products::FindProductsParams}
33
31
  # context:: {Ingenico::Connect::SDK::CallContext}
34
32
  # Returns:: {Ingenico::Connect::SDK::Domain::Product::PaymentProducts}
@@ -55,9 +53,7 @@ module Ingenico::Connect::SDK
55
53
  raise create_exception(e.status_code, e.body, error_object, context)
56
54
  end
57
55
 
58
- # Resource /{{merchantId}}/products/{{paymentProductId}}
59
- #
60
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/get.html Get payment product}
56
+ # Resource /{{merchantId}}/products/{{paymentProductId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/get.html Get payment product}
61
57
  # payment_product_id:: Integer
62
58
  # query:: {Ingenico::Connect::SDK::Merchant::Products::GetProductParams}
63
59
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -88,9 +84,7 @@ module Ingenico::Connect::SDK
88
84
  raise create_exception(e.status_code, e.body, error_object, context)
89
85
  end
90
86
 
91
- # Resource /{{merchantId}}/products/{{paymentProductId}}/directory
92
- #
93
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/directory.html Get payment product directory}
87
+ # Resource /{{merchantId}}/products/{{paymentProductId}}/directory - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/directory.html Get payment product directory}
94
88
  # payment_product_id:: Integer
95
89
  # query:: {Ingenico::Connect::SDK::Merchant::Products::DirectoryParams}
96
90
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -121,9 +115,7 @@ module Ingenico::Connect::SDK
121
115
  raise create_exception(e.status_code, e.body, error_object, context)
122
116
  end
123
117
 
124
- # Resource /{{merchantId}}/products/{{paymentProductId}}/customerDetails
125
- #
126
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/customerDetails.html Get customer details}
118
+ # Resource /{{merchantId}}/products/{{paymentProductId}}/customerDetails - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/customerDetails.html Get customer details}
127
119
  # payment_product_id:: Integer
128
120
  # body:: {Ingenico::Connect::SDK::Domain::Product::GetCustomerDetailsRequest}
129
121
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -155,9 +147,7 @@ module Ingenico::Connect::SDK
155
147
  raise create_exception(e.status_code, e.body, error_object, context)
156
148
  end
157
149
 
158
- # Resource /{{merchantId}}/products/{{paymentProductId}}/deviceFingerprint
159
- #
160
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/deviceFingerprint.html Get device fingerprint}
150
+ # Resource /{{merchantId}}/products/{{paymentProductId}}/deviceFingerprint - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/deviceFingerprint.html Get device fingerprint}
161
151
  # payment_product_id:: Integer
162
152
  # body:: {Ingenico::Connect::SDK::Domain::Product::DeviceFingerprintRequest}
163
153
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -189,9 +179,7 @@ module Ingenico::Connect::SDK
189
179
  raise create_exception(e.status_code, e.body, error_object, context)
190
180
  end
191
181
 
192
- # Resource /{{merchantId}}/products/{{paymentProductId}}/networks
193
- #
194
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/networks.html Get payment product networks}
182
+ # Resource /{{merchantId}}/products/{{paymentProductId}}/networks - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/networks.html Get payment product networks}
195
183
  # payment_product_id:: Integer
196
184
  # query:: {Ingenico::Connect::SDK::Merchant::Products::NetworksParams}
197
185
  # context:: {Ingenico::Connect::SDK::CallContext}
@@ -222,9 +210,7 @@ module Ingenico::Connect::SDK
222
210
  raise create_exception(e.status_code, e.body, error_object, context)
223
211
  end
224
212
 
225
- # Resource /{{merchantId}}/products/{{paymentProductId}}/publicKey
226
- #
227
- # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/publicKey.html Get payment product specific public key}
213
+ # Resource /{{merchantId}}/products/{{paymentProductId}}/publicKey - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/products/publicKey.html Get payment product specific public key}
228
214
  # payment_product_id:: Integer
229
215
  # context:: {Ingenico::Connect::SDK::CallContext}
230
216
  # Returns:: {Ingenico::Connect::SDK::Domain::Publickey::PublicKey}