connect-sdk-ruby 3.0.0 → 3.1.0

data/lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb

@@ -41,19 +41,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/create.html Create payment}
+              #
               # @param body    [Worldline::Connect::SDK::V1::Domain::CreatePaymentRequest]
               # @param context [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CreatePaymentResponse]
               # @raise [Worldline::Connect::SDK::V1::DeclinedPaymentException] if the Worldline Global Collect platform declined / rejected the payment. The payment result will be available from the exception.
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def create(body, context = nil)
                 uri = instantiate_uri('/v1/{merchantId}/payments', nil)
                 @communicator.post(
@@ -70,18 +71,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/find.html Find payments}
+              #
               # @param query   [Worldline::Connect::SDK::V1::Merchant::Payments::FindPaymentsParams]
               # @param context [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::FindPaymentsResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def find(query, context = nil)
                 uri = instantiate_uri('/v1/{merchantId}/payments', nil)
                 @communicator.get(
@@ -97,18 +99,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/get.html Get payment}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::PaymentResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def get(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -127,19 +130,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/complete - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/complete.html Complete payment}
+              #
               # @param payment_id [String]
               # @param body       [Worldline::Connect::SDK::V1::Domain::CompletePaymentRequest]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CompletePaymentResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def complete(payment_id, body, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -159,18 +163,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/thirdpartystatus - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/thirdPartyStatus.html Third party status poll}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::ThirdPartyStatusResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def third_party_status(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -189,19 +194,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/tokenize - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/tokenize.html Create a token from payment}
+              #
               # @param payment_id [String]
               # @param body       [Worldline::Connect::SDK::V1::Domain::TokenizePaymentRequest]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CreateTokenResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def tokenize(payment_id, body, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -221,18 +227,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/processchallenged - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/processchallenged.html Approves challenged payment}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::PaymentResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def processchallenged(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -252,19 +259,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/approve - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/approve.html Approve payment}
+              #
               # @param payment_id [String]
               # @param body       [Worldline::Connect::SDK::V1::Domain::ApprovePaymentRequest]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::PaymentApprovalResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def approve(payment_id, body, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -284,19 +292,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/capture - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/capture.html Capture payment}
+              #
               # @param payment_id [String]
               # @param body       [Worldline::Connect::SDK::V1::Domain::CapturePaymentRequest]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CaptureResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def capture(payment_id, body, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -316,18 +325,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/cancelapproval - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/cancelapproval.html Undo capture payment}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CancelApprovalPaymentResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def cancelapproval(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -347,18 +357,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/captures - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/captures.html Get captures of payment}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CapturesResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def captures(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -377,20 +388,21 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/refund - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/refund.html Create refund}
+              #
               # @param payment_id [String]
               # @param body       [Worldline::Connect::SDK::V1::Domain::RefundRequest]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::RefundResponse]
               # @raise [Worldline::Connect::SDK::V1::DeclinedRefundException] if the Worldline Global Collect platform declined / rejected the refund. The refund result will be available from the exception.
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def refund(payment_id, body, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -410,18 +422,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/refunds - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/refunds.html Get refunds of payment}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::RefundsResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def refunds(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -440,18 +453,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/cancel - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/cancel.html Cancel payment}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CancelPaymentResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def cancel(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -471,19 +485,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/dispute - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/dispute.html Create dispute}
+              #
               # @param payment_id [String]
               # @param body       [Worldline::Connect::SDK::V1::Domain::CreateDisputeRequest]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::DisputeResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def dispute(payment_id, body, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -503,18 +518,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/disputes - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/disputes.html Get disputes}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::DisputesResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def disputes(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,
@@ -533,18 +549,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payments/!{paymentId}/devicefingerprint - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payments/devicefingerprint.html Get Device Fingerprint details}
+              #
               # @param payment_id [String]
               # @param context    [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::DeviceFingerprintDetails]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def devicefingerprint(payment_id, context = nil)
                 path_context = {
                   'paymentId'.freeze => payment_id,

data/lib/worldline/connect/sdk/v1/merchant/payouts/find_payouts_params.rb

@@ -12,6 +12,7 @@ module Worldline
         module Merchant
           module Payouts
             # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts}
+            #
             # @attr [String] merchant_reference
             # @attr [Integer] merchant_order_id
             # @attr [Integer] offset

data/lib/worldline/connect/sdk/v1/merchant/payouts/payouts_client.rb

@@ -26,19 +26,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payouts - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payouts/create.html Create payout}
+              #
               # @param body    [Worldline::Connect::SDK::V1::Domain::CreatePayoutRequest]
               # @param context [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::PayoutResponse]
               # @raise [Worldline::Connect::SDK::V1::DeclinedPayoutException] if the Worldline Global Collect platform declined / rejected the payout. The payout result will be available from the exception.
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def create(body, context = nil)
                 uri = instantiate_uri('/v1/{merchantId}/payouts', nil)
                 @communicator.post(
@@ -55,18 +56,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payouts - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts}
+              #
               # @param query   [Worldline::Connect::SDK::V1::Merchant::Payouts::FindPayoutsParams]
               # @param context [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::FindPayoutsResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def find(query, context = nil)
                 uri = instantiate_uri('/v1/{merchantId}/payouts', nil)
                 @communicator.get(
@@ -82,18 +84,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payouts/!{payoutId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payouts/get.html Get payout}
+              #
               # @param payout_id [String]
               # @param context   [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::PayoutResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def get(payout_id, context = nil)
                 path_context = {
                   'payoutId'.freeze => payout_id,
@@ -112,19 +115,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payouts/!{payoutId}/approve - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payouts/approve.html Approve payout}
+              #
               # @param payout_id [String]
               # @param body      [Worldline::Connect::SDK::V1::Domain::ApprovePayoutRequest]
               # @param context   [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::PayoutResponse]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def approve(payout_id, body, context = nil)
                 path_context = {
                   'payoutId'.freeze => payout_id,
@@ -144,17 +148,18 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payouts/!{payoutId}/cancel - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payouts/cancel.html Cancel payout}
+              #
               # @param payout_id [String]
               # @param context   [Worldline::Connect::SDK::CallContext, nil]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def cancel(payout_id, context = nil)
                 path_context = {
                   'payoutId'.freeze => payout_id,
@@ -174,17 +179,18 @@ module Worldline
               end
 
               # Resource /!{merchantId}/payouts/!{payoutId}/cancelapproval - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/payouts/cancelapproval.html Undo approve payout}
+              #
               # @param payout_id [String]
               # @param context   [Worldline::Connect::SDK::CallContext, nil]
+              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
               # @raise [Worldline::Connect::SDK::V1::AuthorizationException] if the request was not allowed (HTTP status code 403)
-              # @raise [Worldline::Connect::SDK::V1::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
               # @raise [Worldline::Connect::SDK::V1::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
               #        or there was a conflict (HTTP status code 404, 409 or 410)
               # @raise [Worldline::Connect::SDK::V1::PlatformException] if something went wrong at the Worldline Global Collect platform,
               #        the Worldline Global Collect platform was unable to process a message from a downstream partner/acquirer,
               #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-              # @raise [Worldline::Connect::SDK::V1::ApiException]if the Worldline Global Collect platform returned any other error
+              # @raise [Worldline::Connect::SDK::V1::ApiException] if the Worldline Global Collect platform returned any other error
               def cancelapproval(payout_id, context = nil)
                 path_context = {
                   'payoutId'.freeze => payout_id,

data/lib/worldline/connect/sdk/v1/merchant/productgroups/find_productgroups_params.rb

@@ -12,6 +12,7 @@ module Worldline
         module Merchant
           module Productgroups
             # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/productgroups/find.html Get payment product groups}
+            #
             # @attr [String] country_code
             # @attr [String] currency_code
             # @attr [String] locale

data/lib/worldline/connect/sdk/v1/merchant/productgroups/get_productgroup_params.rb

@@ -12,6 +12,7 @@ module Worldline
         module Merchant
           module Productgroups
             # Query parameters for {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/productgroups/get.html Get payment product group}
+            #
             # @attr [String] country_code
             # @attr [String] currency_code
             # @attr [String] locale