connect-sdk-ruby 3.0.0 → 3.1.0

data/lib/worldline/connect/sdk/v1/merchant/tokens/tokens_client.rb

@@ -25,18 +25,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/tokens - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/tokens/create.html Create token}
+              #
               # @param body    [Worldline::Connect::SDK::V1::Domain::CreateTokenRequest]
               # @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 create(body, context = nil)
                 uri = instantiate_uri('/v1/{merchantId}/tokens', nil)
                 @communicator.post(
@@ -53,18 +54,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/tokens/!{tokenId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/tokens/get.html Get token}
+              #
               # @param token_id [String]
               # @param context  [Worldline::Connect::SDK::CallContext, nil]
               # @return [Worldline::Connect::SDK::V1::Domain::TokenResponse]
+              # @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(token_id, context = nil)
                 path_context = {
                   'tokenId'.freeze => token_id,
@@ -83,18 +85,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/tokens/!{tokenId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/tokens/update.html Update token}
+              #
               # @param token_id [String]
               # @param body     [Worldline::Connect::SDK::V1::Domain::UpdateTokenRequest]
               # @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 update(token_id, body, context = nil)
                 path_context = {
                   'tokenId'.freeze => token_id,
@@ -114,18 +117,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/tokens/!{tokenId} - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/tokens/delete.html Delete token}
+              #
               # @param token_id [String]
               # @param query    [Worldline::Connect::SDK::V1::Merchant::Tokens::DeleteTokenParams]
               # @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 delete(token_id, query, context = nil)
                 path_context = {
                   'tokenId'.freeze => token_id,
@@ -144,18 +148,19 @@ module Worldline
               end
 
               # Resource /!{merchantId}/tokens/!{tokenId}/approvesepadirectdebit - {https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/ruby/tokens/approvesepadirectdebit.html Approve SEPA DD mandate}
+              #
               # @param token_id [String]
               # @param body     [Worldline::Connect::SDK::V1::Domain::ApproveTokenRequest]
               # @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 approvesepadirectdebit(token_id, body, context = nil)
                 path_context = {
                   'tokenId'.freeze => token_id,

data/lib/worldline/connect/sdk/v1/platform_exception.rb

@@ -8,12 +8,10 @@ module Worldline
   module Connect
     module SDK
       module V1
-        # This exception is thrown when a response from the Worldline Global Collect platform indicates that an error occurred
-        # on the Worldline Global Collect platform while processing the request.
-        # This corresponds to a HTTP status code of 500 or 502.
+        # Represents an error response from the Worldline Global Collect platform when something went wrong at the Worldline Global Collect platform or further downstream.
         class PlatformException < ApiException
 
-          # Create a new PlatformException
+          # Create a new PlatformException.
           # @see ApiException#initialize
           def initialize(status_code, response_body, error_id, errors,
                          message='the Worldline Global Collect platform returned an error response')

data/lib/worldline/connect/sdk/v1/reference_exception.rb

@@ -8,8 +8,7 @@ module Worldline
   module Connect
     module SDK
       module V1
-        # This error is raised when the request refers to a resource or object that is not found by the Worldline Global Collect platform.
-        # The object referred to may not exist or it could have been removed recently.
+        # Represents an error response from the Worldline Global Collect platform when a non-existing or removed object is trying to be accessed.
         class ReferenceException < ApiException
 
           # Create a new ReferenceException.

data/lib/worldline/connect/sdk/v1/v1_client.rb

@@ -21,6 +21,7 @@ module Worldline
           end
 
           # Resource /!{merchantId}
+          #
           # @param merchant_id [String]
           # @return [Worldline::Connect::SDK::V1::Merchant::MerchantClient]
           def merchant(merchant_id)

data/lib/worldline/connect/sdk/v1/validation_exception.rb

@@ -8,11 +8,10 @@ module Worldline
   module Connect
     module SDK
       module V1
-        # Raised when the request sent to the Worldline Global Collect platform returned a HTTP response with status code 400.
-        # This indicates the request received by the Worldline Global Collect platform was malformed.
+        # Represents an error response from the Worldline Global Collect platform when validation of requests failed.
         class ValidationException < ApiException
 
-          # Create a new ValidationException
+          # Create a new ValidationException.
           # @see ApiException#initialize
           def initialize(status_code, response_body, error_id, errors,
                          message='the Worldline Global Collect platform returned an incorrect request error response')

data/lib/worldline/connect/sdk/v1/webhooks/v1_webhooks_factory.rb

@@ -14,6 +14,7 @@ module Worldline
           class V1WebhooksFactory
 
             # Creates a WebhooksHelper that uses the given SecretKeyStore.
+            #
             # @return [Worldline::Connect::SDK::V1::Webhooks::WebhooksHelper]
             def create_helper(secret_key_store, marshaller: nil)
               marshaller = DefaultMarshaller.instance unless marshaller

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: connect-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Worldline Global Collect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient