connect-sdk-ruby 3.0.0 → 3.1.0

data/lib/worldline/connect/sdk/v1/merchant/hostedmandatemanagements/hostedmandatemanagements_client.rb

@@ -25,18 +25,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/hostedmandatemanagements - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/hostedmandatemanagements/create.html Create hosted mandate management}
+              #
               # @param body    [Worldline::Connect::SDK::V1::Domain::CreateHostedMandateManagementRequest]
               # @param context [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CreateHostedMandateManagementResponse]
+              # @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}/hostedmandatemanagements', nil)
                 @communicator.post(
@@ -53,18 +54,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/hostedmandatemanagements/!{hostedMandateManagementId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/hostedmandatemanagements/get.html Get hosted mandate management status}
+              #
               # @param hosted_mandate_management_id [String]
               # @param context                      [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::GetHostedMandateManagementResponse]
+              # @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(hosted_mandate_management_id, context = nil)
                 path_context = {
                   'hostedMandateManagementId'.freeze => hosted_mandate_management_id,

data/lib/worldline/connect/sdk/v1/merchant/installments/installments_client.rb

@@ -24,18 +24,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/installments/getInstallmentsInfo - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/installments/getInstallmentsInfo.html Get installment information}
+              #
               # @param body    [Worldline::Connect::SDK::V1::Domain::GetInstallmentRequest]
               # @param context [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::InstallmentOptionsResponse]
+              # @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_installments_info(body, context = nil)
                 uri = instantiate_uri('/v1/{merchantId}/installments/getInstallmentsInfo', nil)
                 @communicator.post(

data/lib/worldline/connect/sdk/v1/merchant/mandates/mandates_client.rb

@@ -25,18 +25,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/mandates - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/mandates/create.html Create mandate}
+              #
               # @param body    [Worldline::Connect::SDK::V1::Domain::CreateMandateRequest]
               # @param context [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CreateMandateResponse]
+              # @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}/mandates', nil)
                 @communicator.post(
@@ -53,19 +54,20 @@ module Worldline
               end
 
               # Resource /!{merchantId}/mandates/!{uniqueMandateReference} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/mandates/createWithMandateReference.html Create mandate with mandatereference}
+              #
               # @param unique_mandate_reference [String]
               # @param body                     [Worldline::Connect::SDK::V1::Domain::CreateMandateRequest]
               # @param context                  [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::CreateMandateResponse]
+              # @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_with_mandate_reference(unique_mandate_reference, body, context = nil)
                 path_context = {
                   'uniqueMandateReference'.freeze => unique_mandate_reference,
@@ -85,18 +87,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/mandates/!{uniqueMandateReference} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/mandates/get.html Get mandate}
+              #
               # @param unique_mandate_reference [String]
               # @param context                  [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::GetMandateResponse]
+              # @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(unique_mandate_reference, context = nil)
                 path_context = {
                   'uniqueMandateReference'.freeze => unique_mandate_reference,
@@ -115,18 +118,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/mandates/!{uniqueMandateReference}/block - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/mandates/block.html Block mandate}
+              #
               # @param unique_mandate_reference [String]
               # @param context                  [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::GetMandateResponse]
+              # @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 block(unique_mandate_reference, context = nil)
                 path_context = {
                   'uniqueMandateReference'.freeze => unique_mandate_reference,
@@ -146,18 +150,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/mandates/!{uniqueMandateReference}/unblock - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/mandates/unblock.html Unblock mandate}
+              #
               # @param unique_mandate_reference [String]
               # @param context                  [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::GetMandateResponse]
+              # @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 unblock(unique_mandate_reference, context = nil)
                 path_context = {
                   'uniqueMandateReference'.freeze => unique_mandate_reference,
@@ -177,18 +182,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/mandates/!{uniqueMandateReference}/revoke - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/mandates/revoke.html Revoke mandate}
+              #
               # @param unique_mandate_reference [String]
               # @param context                  [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::GetMandateResponse]
+              # @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 revoke(unique_mandate_reference, context = nil)
                 path_context = {
                   'uniqueMandateReference'.freeze => unique_mandate_reference,

data/lib/worldline/connect/sdk/v1/merchant/merchant_client.rb

@@ -35,96 +35,112 @@ module Worldline
             end
 
             # Resource /!{merchantId}/hostedcheckouts
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Hostedcheckouts::HostedcheckoutsClient]
             def hostedcheckouts
               Worldline::Connect::SDK::V1::Merchant::Hostedcheckouts::HostedcheckoutsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/hostedmandatemanagements
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient]
             def hostedmandatemanagements
               Worldline::Connect::SDK::V1::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/payments
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Payments::PaymentsClient]
             def payments
               Worldline::Connect::SDK::V1::Merchant::Payments::PaymentsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/captures
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Captures::CapturesClient]
             def captures
               Worldline::Connect::SDK::V1::Merchant::Captures::CapturesClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/refunds
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Refunds::RefundsClient]
             def refunds
               Worldline::Connect::SDK::V1::Merchant::Refunds::RefundsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/disputes
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Disputes::DisputesClient]
             def disputes
               Worldline::Connect::SDK::V1::Merchant::Disputes::DisputesClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/payouts
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Payouts::PayoutsClient]
             def payouts
               Worldline::Connect::SDK::V1::Merchant::Payouts::PayoutsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/productgroups
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Productgroups::ProductgroupsClient]
             def productgroups
               Worldline::Connect::SDK::V1::Merchant::Productgroups::ProductgroupsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/products
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Products::ProductsClient]
             def products
               Worldline::Connect::SDK::V1::Merchant::Products::ProductsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/riskassessments
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Riskassessments::RiskassessmentsClient]
             def riskassessments
               Worldline::Connect::SDK::V1::Merchant::Riskassessments::RiskassessmentsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/services
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Services::ServicesClient]
             def services
               Worldline::Connect::SDK::V1::Merchant::Services::ServicesClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/tokens
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Tokens::TokensClient]
             def tokens
               Worldline::Connect::SDK::V1::Merchant::Tokens::TokensClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/mandates
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Mandates::MandatesClient]
             def mandates
               Worldline::Connect::SDK::V1::Merchant::Mandates::MandatesClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/sessions
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Sessions::SessionsClient]
             def sessions
               Worldline::Connect::SDK::V1::Merchant::Sessions::SessionsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/installments
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Installments::InstallmentsClient]
             def installments
               Worldline::Connect::SDK::V1::Merchant::Installments::InstallmentsClient.new(self, nil)
             end
 
             # Resource /!{merchantId}/files
+            #
             # @return [Worldline::Connect::SDK::V1::Merchant::Files::FilesClient]
             def files
               Worldline::Connect::SDK::V1::Merchant::Files::FilesClient.new(self, nil)

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

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