connect-sdk-ruby 3.0.0 → 3.1.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 (82) hide show
  1. checksums.yaml +4 -4
  2. data/connect-sdk-ruby.gemspec +1 -1
  3. data/examples/v1/merchant/captures/create_refund_capture_example.rb +3 -3
  4. data/examples/v1/merchant/payments/create_payment_example.rb +3 -3
  5. data/examples/v1/merchant/payments/refund_payment_example.rb +3 -3
  6. data/examples/v1/merchant/payouts/create_payout_example.rb +3 -3
  7. data/lib/worldline/connect/sdk/communication/metadata_provider.rb +1 -1
  8. data/lib/worldline/connect/sdk/v1/api_exception.rb +5 -7
  9. data/lib/worldline/connect/sdk/v1/authorization_exception.rb +3 -3
  10. data/lib/worldline/connect/sdk/v1/declined_payment_exception.rb +12 -23
  11. data/lib/worldline/connect/sdk/v1/declined_payout_exception.rb +13 -24
  12. data/lib/worldline/connect/sdk/v1/declined_refund_exception.rb +13 -24
  13. data/lib/worldline/connect/sdk/v1/declined_transaction_exception.rb +2 -2
  14. data/lib/worldline/connect/sdk/v1/domain/abstract_card_payment_method_specific_input.rb +0 -3
  15. data/lib/worldline/connect/sdk/v1/domain/abstract_sepa_direct_debit_payment_product771_specific_input.rb +0 -1
  16. data/lib/worldline/connect/sdk/v1/domain/additional_order_input.rb +0 -3
  17. data/lib/worldline/connect/sdk/v1/domain/airline_data.rb +0 -1
  18. data/lib/worldline/connect/sdk/v1/domain/airline_flight_leg.rb +0 -1
  19. data/lib/worldline/connect/sdk/v1/domain/bank_transfer_payout_method_specific_input.rb +0 -1
  20. data/lib/worldline/connect/sdk/v1/domain/card_payment_method_specific_input.rb +0 -2
  21. data/lib/worldline/connect/sdk/v1/domain/card_payment_method_specific_output.rb +7 -0
  22. data/lib/worldline/connect/sdk/v1/domain/cash_payment_method_specific_input.rb +0 -1
  23. data/lib/worldline/connect/sdk/v1/domain/cash_payment_product1503_specific_input.rb +0 -1
  24. data/lib/worldline/connect/sdk/v1/domain/create_payout_request.rb +0 -8
  25. data/lib/worldline/connect/sdk/v1/domain/created_payment_output.rb +0 -1
  26. data/lib/worldline/connect/sdk/v1/domain/customer.rb +0 -1
  27. data/lib/worldline/connect/sdk/v1/domain/customer_base.rb +0 -1
  28. data/lib/worldline/connect/sdk/v1/domain/customer_risk_assessment.rb +0 -1
  29. data/lib/worldline/connect/sdk/v1/domain/decrypted_payment_data.rb +0 -1
  30. data/lib/worldline/connect/sdk/v1/domain/device_render_options.rb +0 -1
  31. data/lib/worldline/connect/sdk/v1/domain/external_cardholder_authentication_data.rb +0 -1
  32. data/lib/worldline/connect/sdk/v1/domain/fraud_fields.rb +0 -12
  33. data/lib/worldline/connect/sdk/v1/domain/fraud_fields_shipping_details.rb +0 -3
  34. data/lib/worldline/connect/sdk/v1/domain/level3_summary_data.rb +0 -3
  35. data/lib/worldline/connect/sdk/v1/domain/line_item.rb +0 -1
  36. data/lib/worldline/connect/sdk/v1/domain/loan_recipient.rb +0 -5
  37. data/lib/worldline/connect/sdk/v1/domain/order.rb +0 -2
  38. data/lib/worldline/connect/sdk/v1/domain/order_line_details.rb +7 -0
  39. data/lib/worldline/connect/sdk/v1/domain/payment_approval_response.rb +0 -1
  40. data/lib/worldline/connect/sdk/v1/domain/redirect_payment_method_specific_input.rb +0 -1
  41. data/lib/worldline/connect/sdk/v1/domain/redirect_payment_product809_specific_input.rb +0 -1
  42. data/lib/worldline/connect/sdk/v1/domain/redirect_payment_product840_specific_input.rb +0 -1
  43. data/lib/worldline/connect/sdk/v1/domain/shipping.rb +7 -0
  44. data/lib/worldline/connect/sdk/v1/domain/value_mapping_element.rb +0 -1
  45. data/lib/worldline/connect/sdk/v1/exception_factory.rb +19 -14
  46. data/lib/worldline/connect/sdk/v1/idempotence_exception.rb +2 -3
  47. data/lib/worldline/connect/sdk/v1/merchant/captures/captures_client.rb +6 -4
  48. data/lib/worldline/connect/sdk/v1/merchant/disputes/disputes_client.rb +12 -8
  49. data/lib/worldline/connect/sdk/v1/merchant/disputes/upload_file_request.rb +2 -1
  50. data/lib/worldline/connect/sdk/v1/merchant/files/files_client.rb +3 -2
  51. data/lib/worldline/connect/sdk/v1/merchant/hostedcheckouts/hostedcheckouts_client.rb +9 -6
  52. data/lib/worldline/connect/sdk/v1/merchant/hostedmandatemanagements/hostedmandatemanagements_client.rb +6 -4
  53. data/lib/worldline/connect/sdk/v1/merchant/installments/installments_client.rb +3 -2
  54. data/lib/worldline/connect/sdk/v1/merchant/mandates/mandates_client.rb +18 -12
  55. data/lib/worldline/connect/sdk/v1/merchant/merchant_client.rb +16 -0
  56. data/lib/worldline/connect/sdk/v1/merchant/payments/find_payments_params.rb +1 -0
  57. data/lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb +51 -34
  58. data/lib/worldline/connect/sdk/v1/merchant/payouts/find_payouts_params.rb +1 -0
  59. data/lib/worldline/connect/sdk/v1/merchant/payouts/payouts_client.rb +18 -12
  60. data/lib/worldline/connect/sdk/v1/merchant/productgroups/find_productgroups_params.rb +1 -0
  61. data/lib/worldline/connect/sdk/v1/merchant/productgroups/get_productgroup_params.rb +1 -0
  62. data/lib/worldline/connect/sdk/v1/merchant/productgroups/productgroups_client.rb +9 -6
  63. data/lib/worldline/connect/sdk/v1/merchant/products/directory_params.rb +1 -0
  64. data/lib/worldline/connect/sdk/v1/merchant/products/find_products_params.rb +1 -0
  65. data/lib/worldline/connect/sdk/v1/merchant/products/get_product_params.rb +1 -0
  66. data/lib/worldline/connect/sdk/v1/merchant/products/networks_params.rb +1 -0
  67. data/lib/worldline/connect/sdk/v1/merchant/products/products_client.rb +21 -14
  68. data/lib/worldline/connect/sdk/v1/merchant/refunds/find_refunds_params.rb +1 -0
  69. data/lib/worldline/connect/sdk/v1/merchant/refunds/refunds_client.rb +15 -10
  70. data/lib/worldline/connect/sdk/v1/merchant/riskassessments/riskassessments_client.rb +6 -4
  71. data/lib/worldline/connect/sdk/v1/merchant/services/convert_amount_params.rb +1 -0
  72. data/lib/worldline/connect/sdk/v1/merchant/services/privacypolicy_params.rb +1 -0
  73. data/lib/worldline/connect/sdk/v1/merchant/services/services_client.rb +15 -10
  74. data/lib/worldline/connect/sdk/v1/merchant/sessions/sessions_client.rb +3 -2
  75. data/lib/worldline/connect/sdk/v1/merchant/tokens/delete_token_params.rb +1 -0
  76. data/lib/worldline/connect/sdk/v1/merchant/tokens/tokens_client.rb +15 -10
  77. data/lib/worldline/connect/sdk/v1/platform_exception.rb +2 -4
  78. data/lib/worldline/connect/sdk/v1/reference_exception.rb +1 -2
  79. data/lib/worldline/connect/sdk/v1/v1_client.rb +1 -0
  80. data/lib/worldline/connect/sdk/v1/validation_exception.rb +2 -3
  81. data/lib/worldline/connect/sdk/v1/webhooks/v1_webhooks_factory.rb +1 -0
  82. metadata +2 -2
@@ -26,18 +26,19 @@ module Worldline
26
26
  end
27
27
 
28
28
  # Resource /!{merchantId}/productgroups - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/productgroups/find.html Get payment product groups}
29
+ #
29
30
  # @param query [Worldline::Connect::SDK::V1::Merchant::Productgroups::FindProductgroupsParams]
30
31
  # @param context [Worldline::Connect::SDK::CallContext, nil]
31
32
  # @return [Worldline::Connect::SDK::V1::Domain::PaymentProductGroups]
33
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
32
34
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
33
35
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
34
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
35
36
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
36
37
  # or there was a conflict (HTTP status code 404, 409 or 410)
37
38
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
38
39
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
39
40
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
40
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
41
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
41
42
  def find(query, context = nil)
42
43
  uri = instantiate_uri('/v1/{merchantId}/productgroups', nil)
43
44
  @communicator.get(
@@ -53,19 +54,20 @@ module Worldline
53
54
  end
54
55
 
55
56
  # Resource /!{merchantId}/productgroups/!{paymentProductGroupId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/productgroups/get.html Get payment product group}
57
+ #
56
58
  # @param payment_product_group_id [String]
57
59
  # @param query [Worldline::Connect::SDK::V1::Merchant::Productgroups::GetProductgroupParams]
58
60
  # @param context [Worldline::Connect::SDK::CallContext, nil]
59
61
  # @return [Worldline::Connect::SDK::V1::Domain::PaymentProductGroupResponse]
62
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
60
63
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
61
64
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
62
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
63
65
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
64
66
  # or there was a conflict (HTTP status code 404, 409 or 410)
65
67
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
66
68
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
67
69
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
68
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
70
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
69
71
  def get(payment_product_group_id, query, context = nil)
70
72
  path_context = {
71
73
  'paymentProductGroupId'.freeze => payment_product_group_id,
@@ -84,19 +86,20 @@ module Worldline
84
86
  end
85
87
 
86
88
  # Resource /!{merchantId}/productgroups/!{paymentProductGroupId}/deviceFingerprint - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/productgroups/deviceFingerprint.html Get device fingerprint}
89
+ #
87
90
  # @param payment_product_group_id [String]
88
91
  # @param body [Worldline::Connect::SDK::V1::Domain::DeviceFingerprintRequest]
89
92
  # @param context [Worldline::Connect::SDK::CallContext, nil]
90
93
  # @return [Worldline::Connect::SDK::V1::Domain::DeviceFingerprintResponse]
94
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
91
95
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
92
96
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
93
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
94
97
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
95
98
  # or there was a conflict (HTTP status code 404, 409 or 410)
96
99
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
97
100
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
98
101
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
99
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
102
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
100
103
  def device_fingerprint(payment_product_group_id, body, context = nil)
101
104
  path_context = {
102
105
  'paymentProductGroupId'.freeze => payment_product_group_id,
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Products
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/directory.html Get payment product directory}
15
+ #
15
16
  # @attr [String] country_code
16
17
  # @attr [String] currency_code
17
18
  class DirectoryParams < Worldline::Connect::SDK::Communication::ParamRequest
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Products
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/find.html Get payment products}
15
+ #
15
16
  # @attr [String] country_code
16
17
  # @attr [String] currency_code
17
18
  # @attr [String] locale
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Products
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/get.html Get payment product}
15
+ #
15
16
  # @attr [String] country_code
16
17
  # @attr [String] currency_code
17
18
  # @attr [String] locale
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Products
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/networks.html Get payment product networks}
15
+ #
15
16
  # @attr [String] country_code
16
17
  # @attr [String] currency_code
17
18
  # @attr [Integer] amount
@@ -30,18 +30,19 @@ module Worldline
30
30
  end
31
31
 
32
32
  # Resource /!{merchantId}/products - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/find.html Get payment products}
33
+ #
33
34
  # @param query [Worldline::Connect::SDK::V1::Merchant::Products::FindProductsParams]
34
35
  # @param context [Worldline::Connect::SDK::CallContext, nil]
35
36
  # @return [Worldline::Connect::SDK::V1::Domain::PaymentProducts]
37
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
36
38
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
37
39
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
38
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
39
40
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
40
41
  # or there was a conflict (HTTP status code 404, 409 or 410)
41
42
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
42
43
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
43
44
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
44
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
45
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
45
46
  def find(query, context = nil)
46
47
  uri = instantiate_uri('/v1/{merchantId}/products', nil)
47
48
  @communicator.get(
@@ -57,19 +58,20 @@ module Worldline
57
58
  end
58
59
 
59
60
  # Resource /!{merchantId}/products/!{paymentProductId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/get.html Get payment product}
61
+ #
60
62
  # @param payment_product_id [Integer]
61
63
  # @param query [Worldline::Connect::SDK::V1::Merchant::Products::GetProductParams]
62
64
  # @param context [Worldline::Connect::SDK::CallContext, nil]
63
65
  # @return [Worldline::Connect::SDK::V1::Domain::PaymentProductResponse]
66
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
64
67
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
65
68
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
66
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
67
69
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
68
70
  # or there was a conflict (HTTP status code 404, 409 or 410)
69
71
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
70
72
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
71
73
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
72
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
74
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
73
75
  def get(payment_product_id, query, context = nil)
74
76
  path_context = {
75
77
  'paymentProductId'.freeze => payment_product_id.to_s,
@@ -88,19 +90,20 @@ module Worldline
88
90
  end
89
91
 
90
92
  # Resource /!{merchantId}/products/!{paymentProductId}/directory - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/directory.html Get payment product directory}
93
+ #
91
94
  # @param payment_product_id [Integer]
92
95
  # @param query [Worldline::Connect::SDK::V1::Merchant::Products::DirectoryParams]
93
96
  # @param context [Worldline::Connect::SDK::CallContext, nil]
94
97
  # @return [Worldline::Connect::SDK::V1::Domain::Directory]
98
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
95
99
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
96
100
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
97
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
98
101
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
99
102
  # or there was a conflict (HTTP status code 404, 409 or 410)
100
103
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
101
104
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
102
105
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
103
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
106
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
104
107
  def directory(payment_product_id, query, context = nil)
105
108
  path_context = {
106
109
  'paymentProductId'.freeze => payment_product_id.to_s,
@@ -119,19 +122,20 @@ module Worldline
119
122
  end
120
123
 
121
124
  # Resource /!{merchantId}/products/!{paymentProductId}/customerDetails - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/customerDetails.html Get customer details}
125
+ #
122
126
  # @param payment_product_id [Integer]
123
127
  # @param body [Worldline::Connect::SDK::V1::Domain::GetCustomerDetailsRequest]
124
128
  # @param context [Worldline::Connect::SDK::CallContext, nil]
125
129
  # @return [Worldline::Connect::SDK::V1::Domain::GetCustomerDetailsResponse]
130
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
126
131
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
127
132
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
128
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
129
133
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
130
134
  # or there was a conflict (HTTP status code 404, 409 or 410)
131
135
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
132
136
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
133
137
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
134
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
138
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
135
139
  def customer_details(payment_product_id, body, context = nil)
136
140
  path_context = {
137
141
  'paymentProductId'.freeze => payment_product_id.to_s,
@@ -151,19 +155,20 @@ module Worldline
151
155
  end
152
156
 
153
157
  # Resource /!{merchantId}/products/!{paymentProductId}/deviceFingerprint - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/deviceFingerprint.html Get device fingerprint}
158
+ #
154
159
  # @param payment_product_id [Integer]
155
160
  # @param body [Worldline::Connect::SDK::V1::Domain::DeviceFingerprintRequest]
156
161
  # @param context [Worldline::Connect::SDK::CallContext, nil]
157
162
  # @return [Worldline::Connect::SDK::V1::Domain::DeviceFingerprintResponse]
163
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
158
164
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
159
165
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
160
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
161
166
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
162
167
  # or there was a conflict (HTTP status code 404, 409 or 410)
163
168
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
164
169
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
165
170
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
166
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
171
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
167
172
  def device_fingerprint(payment_product_id, body, context = nil)
168
173
  path_context = {
169
174
  'paymentProductId'.freeze => payment_product_id.to_s,
@@ -183,19 +188,20 @@ module Worldline
183
188
  end
184
189
 
185
190
  # Resource /!{merchantId}/products/!{paymentProductId}/networks - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/networks.html Get payment product networks}
191
+ #
186
192
  # @param payment_product_id [Integer]
187
193
  # @param query [Worldline::Connect::SDK::V1::Merchant::Products::NetworksParams]
188
194
  # @param context [Worldline::Connect::SDK::CallContext, nil]
189
195
  # @return [Worldline::Connect::SDK::V1::Domain::PaymentProductNetworksResponse]
196
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
190
197
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
191
198
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
192
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
193
199
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
194
200
  # or there was a conflict (HTTP status code 404, 409 or 410)
195
201
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
196
202
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
197
203
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
198
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
204
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
199
205
  def networks(payment_product_id, query, context = nil)
200
206
  path_context = {
201
207
  'paymentProductId'.freeze => payment_product_id.to_s,
@@ -214,19 +220,20 @@ module Worldline
214
220
  end
215
221
 
216
222
  # Resource /!{merchantId}/products/!{paymentProductId}/sessions - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/products/sessions.html Create session for payment product}
223
+ #
217
224
  # @param payment_product_id [Integer]
218
225
  # @param body [Worldline::Connect::SDK::V1::Domain::CreatePaymentProductSessionRequest]
219
226
  # @param context [Worldline::Connect::SDK::CallContext, nil]
220
227
  # @return [Worldline::Connect::SDK::V1::Domain::CreatePaymentProductSessionResponse]
228
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
221
229
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
222
230
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
223
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
224
231
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
225
232
  # or there was a conflict (HTTP status code 404, 409 or 410)
226
233
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
227
234
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
228
235
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
229
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
236
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
230
237
  def sessions(payment_product_id, body, context = nil)
231
238
  path_context = {
232
239
  'paymentProductId'.freeze => payment_product_id.to_s,
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Refunds
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/refunds/find.html Find refunds}
15
+ #
15
16
  # @attr [String] hosted_checkout_id
16
17
  # @attr [String] merchant_reference
17
18
  # @attr [Integer] merchant_order_id
@@ -25,18 +25,19 @@ module Worldline
25
25
  end
26
26
 
27
27
  # Resource /!{merchantId}/refunds - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/refunds/find.html Find refunds}
28
+ #
28
29
  # @param query [Worldline::Connect::SDK::V1::Merchant::Refunds::FindRefundsParams]
29
30
  # @param context [Worldline::Connect::SDK::CallContext, nil]
30
31
  # @return [Worldline::Connect::SDK::V1::Domain::FindRefundsResponse]
32
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
31
33
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
32
34
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
33
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
34
35
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
35
36
  # or there was a conflict (HTTP status code 404, 409 or 410)
36
37
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
37
38
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
38
39
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
39
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
40
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
40
41
  def find(query, context = nil)
41
42
  uri = instantiate_uri('/v1/{merchantId}/refunds', nil)
42
43
  @communicator.get(
@@ -52,18 +53,19 @@ module Worldline
52
53
  end
53
54
 
54
55
  # Resource /!{merchantId}/refunds/!{refundId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/refunds/get.html Get refund}
56
+ #
55
57
  # @param refund_id [String]
56
58
  # @param context [Worldline::Connect::SDK::CallContext, nil]
57
59
  # @return [Worldline::Connect::SDK::V1::Domain::RefundResponse]
60
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
58
61
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
59
62
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
60
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
61
63
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
62
64
  # or there was a conflict (HTTP status code 404, 409 or 410)
63
65
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
64
66
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
65
67
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
66
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
68
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
67
69
  def get(refund_id, context = nil)
68
70
  path_context = {
69
71
  'refundId'.freeze => refund_id,
@@ -82,18 +84,19 @@ module Worldline
82
84
  end
83
85
 
84
86
  # Resource /!{merchantId}/refunds/!{refundId}/approve - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/refunds/approve.html Approve refund}
87
+ #
85
88
  # @param refund_id [String]
86
89
  # @param body [Worldline::Connect::SDK::V1::Domain::ApproveRefundRequest]
87
90
  # @param context [Worldline::Connect::SDK::CallContext, nil]
91
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
88
92
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
89
93
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
90
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
91
94
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
92
95
  # or there was a conflict (HTTP status code 404, 409 or 410)
93
96
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
94
97
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
95
98
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
96
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
99
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
97
100
  def approve(refund_id, body, context = nil)
98
101
  path_context = {
99
102
  'refundId'.freeze => refund_id,
@@ -113,17 +116,18 @@ module Worldline
113
116
  end
114
117
 
115
118
  # Resource /!{merchantId}/refunds/!{refundId}/cancel - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/refunds/cancel.html Cancel refund}
119
+ #
116
120
  # @param refund_id [String]
117
121
  # @param context [Worldline::Connect::SDK::CallContext, nil]
122
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
118
123
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
119
124
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
120
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
121
125
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
122
126
  # or there was a conflict (HTTP status code 404, 409 or 410)
123
127
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
124
128
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
125
129
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
126
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
130
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
127
131
  def cancel(refund_id, context = nil)
128
132
  path_context = {
129
133
  'refundId'.freeze => refund_id,
@@ -143,17 +147,18 @@ module Worldline
143
147
  end
144
148
 
145
149
  # Resource /!{merchantId}/refunds/!{refundId}/cancelapproval - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/refunds/cancelapproval.html Undo approve refund}
150
+ #
146
151
  # @param refund_id [String]
147
152
  # @param context [Worldline::Connect::SDK::CallContext, nil]
153
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
148
154
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
149
155
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
150
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
151
156
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
152
157
  # or there was a conflict (HTTP status code 404, 409 or 410)
153
158
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
154
159
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
155
160
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
156
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
161
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
157
162
  def cancelapproval(refund_id, context = nil)
158
163
  path_context = {
159
164
  'refundId'.freeze => refund_id,
@@ -24,18 +24,19 @@ module Worldline
24
24
  end
25
25
 
26
26
  # Resource /!{merchantId}/riskassessments/bankaccounts - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/riskassessments/bankaccounts.html Risk-assess bankaccount}
27
+ #
27
28
  # @param body [Worldline::Connect::SDK::V1::Domain::RiskAssessmentBankAccount]
28
29
  # @param context [Worldline::Connect::SDK::CallContext, nil]
29
30
  # @return [Worldline::Connect::SDK::V1::Domain::RiskAssessmentResponse]
31
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
30
32
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
31
33
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
32
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
33
34
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
34
35
  # or there was a conflict (HTTP status code 404, 409 or 410)
35
36
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
36
37
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
37
38
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
38
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
39
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
39
40
  def bankaccounts(body, context = nil)
40
41
  uri = instantiate_uri('/v1/{merchantId}/riskassessments/bankaccounts', nil)
41
42
  @communicator.post(
@@ -52,18 +53,19 @@ module Worldline
52
53
  end
53
54
 
54
55
  # Resource /!{merchantId}/riskassessments/cards - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/riskassessments/cards.html Risk-assess card}
56
+ #
55
57
  # @param body [Worldline::Connect::SDK::V1::Domain::RiskAssessmentCard]
56
58
  # @param context [Worldline::Connect::SDK::CallContext, nil]
57
59
  # @return [Worldline::Connect::SDK::V1::Domain::RiskAssessmentResponse]
60
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
58
61
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
59
62
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
60
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
61
63
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
62
64
  # or there was a conflict (HTTP status code 404, 409 or 410)
63
65
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
64
66
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
65
67
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
66
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
68
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
67
69
  def cards(body, context = nil)
68
70
  uri = instantiate_uri('/v1/{merchantId}/riskassessments/cards', nil)
69
71
  @communicator.post(
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Services
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/services/convertAmount.html Convert amount}
15
+ #
15
16
  # @attr [String] source
16
17
  # @attr [String] target
17
18
  # @attr [Integer] amount
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Services
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/services/privacypolicy.html Get privacy policy}
15
+ #
15
16
  # @attr [String] locale
16
17
  # @attr [Integer] payment_product_id
17
18
  class PrivacypolicyParams < Worldline::Connect::SDK::Communication::ParamRequest
@@ -28,18 +28,19 @@ module Worldline
28
28
  end
29
29
 
30
30
  # Resource /!{merchantId}/services/convert/amount - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/services/convertAmount.html Convert amount}
31
+ #
31
32
  # @param query [Worldline::Connect::SDK::V1::Merchant::Services::ConvertAmountParams]
32
33
  # @param context [Worldline::Connect::SDK::CallContext, nil]
33
34
  # @return [Worldline::Connect::SDK::V1::Domain::ConvertAmount]
35
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
34
36
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
35
37
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
36
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
37
38
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
38
39
  # or there was a conflict (HTTP status code 404, 409 or 410)
39
40
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
40
41
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
41
42
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
42
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
43
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
43
44
  def convert_amount(query, context = nil)
44
45
  uri = instantiate_uri('/v1/{merchantId}/services/convert/amount', nil)
45
46
  @communicator.get(
@@ -55,18 +56,19 @@ module Worldline
55
56
  end
56
57
 
57
58
  # Resource /!{merchantId}/services/convert/bankaccount - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/services/bankaccount.html Convert bankaccount}
59
+ #
58
60
  # @param body [Worldline::Connect::SDK::V1::Domain::BankDetailsRequest]
59
61
  # @param context [Worldline::Connect::SDK::CallContext, nil]
60
62
  # @return [Worldline::Connect::SDK::V1::Domain::BankDetailsResponse]
63
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
61
64
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
62
65
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
63
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
64
66
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
65
67
  # or there was a conflict (HTTP status code 404, 409 or 410)
66
68
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
67
69
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
68
70
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
69
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
71
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
70
72
  def bankaccount(body, context = nil)
71
73
  uri = instantiate_uri('/v1/{merchantId}/services/convert/bankaccount', nil)
72
74
  @communicator.post(
@@ -83,18 +85,19 @@ module Worldline
83
85
  end
84
86
 
85
87
  # Resource /!{merchantId}/services/getIINdetails - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/services/getIINdetails.html Get IIN details}
88
+ #
86
89
  # @param body [Worldline::Connect::SDK::V1::Domain::GetIINDetailsRequest]
87
90
  # @param context [Worldline::Connect::SDK::CallContext, nil]
88
91
  # @return [Worldline::Connect::SDK::V1::Domain::GetIINDetailsResponse]
92
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
89
93
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
90
94
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
91
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
92
95
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
93
96
  # or there was a conflict (HTTP status code 404, 409 or 410)
94
97
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
95
98
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
96
99
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
97
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
100
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
98
101
  def get_iin_details(body, context = nil)
99
102
  uri = instantiate_uri('/v1/{merchantId}/services/getIINdetails', nil)
100
103
  @communicator.post(
@@ -111,18 +114,19 @@ module Worldline
111
114
  end
112
115
 
113
116
  # Resource /!{merchantId}/services/privacypolicy - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/services/privacypolicy.html Get privacy policy}
117
+ #
114
118
  # @param query [Worldline::Connect::SDK::V1::Merchant::Services::PrivacypolicyParams]
115
119
  # @param context [Worldline::Connect::SDK::CallContext, nil]
116
120
  # @return [Worldline::Connect::SDK::V1::Domain::GetPrivacyPolicyResponse]
121
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
117
122
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
118
123
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
119
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
120
124
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
121
125
  # or there was a conflict (HTTP status code 404, 409 or 410)
122
126
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
123
127
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
124
128
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
125
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
129
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
126
130
  def privacypolicy(query, context = nil)
127
131
  uri = instantiate_uri('/v1/{merchantId}/services/privacypolicy', nil)
128
132
  @communicator.get(
@@ -138,17 +142,18 @@ module Worldline
138
142
  end
139
143
 
140
144
  # Resource /!{merchantId}/services/testconnection - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/services/testconnection.html Test connection}
145
+ #
141
146
  # @param context [Worldline::Connect::SDK::CallContext, nil]
142
147
  # @return [Worldline::Connect::SDK::V1::Domain::TestConnection]
148
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
143
149
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
144
150
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
145
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
146
151
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
147
152
  # or there was a conflict (HTTP status code 404, 409 or 410)
148
153
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
149
154
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
150
155
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
151
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
156
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
152
157
  def testconnection(context = nil)
153
158
  uri = instantiate_uri('/v1/{merchantId}/services/testconnection', nil)
154
159
  @communicator.get(
@@ -24,18 +24,19 @@ module Worldline
24
24
  end
25
25
 
26
26
  # Resource /!{merchantId}/sessions - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/sessions/create.html Create session}
27
+ #
27
28
  # @param body [Worldline::Connect::SDK::V1::Domain::SessionRequest]
28
29
  # @param context [Worldline::Connect::SDK::CallContext, nil]
29
30
  # @return [Worldline::Connect::SDK::V1::Domain::SessionResponse]
31
+ # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
30
32
  # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
31
33
  # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
32
- # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
33
34
  # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
34
35
  # or there was a conflict (HTTP status code 404, 409 or 410)
35
36
  # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
36
37
  # the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
37
38
  # or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
38
- # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
39
+ # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
39
40
  def create(body, context = nil)
40
41
  uri = instantiate_uri('/v1/{merchantId}/sessions', nil)
41
42
  @communicator.post(
@@ -12,6 +12,7 @@ module Worldline
12
12
  module Merchant
13
13
  module Tokens
14
14
  # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/tokens/delete.html Delete token}
15
+ #
15
16
  # @attr [String] mandate_cancel_date
16
17
  class DeleteTokenParams < Worldline::Connect::SDK::Communication::ParamRequest
17
18