connect-sdk-ruby 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ce3c9477f770ca8ec19dc8ac7801f8c810264352c3db5770db2a31b7aa6ceb2
-  data.tar.gz: 11271b04f8cdf8c76347cf3655cbc8b18a9f09206b76593c28d2f17dce45c3da
+  metadata.gz: 791117f1bb35e32230acf8eb4814e94c2d966e5d0bb025da5edf3ca23c6846be
+  data.tar.gz: 1eefc8bd5d196e6e32f2833bf25c522c8758408723831b7126d52ba56a860b94
 SHA512:
-  metadata.gz: c14472474b1b940ae7dbd0dcfe6d7a80a41ce1f1092301ee2f80b00498df4e5d65be8c48525d4fe5ea52daa992e90a10fb6bfb9cc2b5f80138d2d5e4ec9683c6
-  data.tar.gz: fbb71455d8d1324099dafec0208632c9361f072cf9fc836c1658d4067a77b050b20703bbc6055756a8751f642167c7eea163555f6d113944dc179a1593b0b862
+  metadata.gz: 41051f07e0b269e54623a8d07863bf1331a1d0b59469c58662940a4a15a1a39cfdf37bd9ead59a01e5d216c74cfe0e4ac7a5dab912251e7f60b565a8e5a82947
+  data.tar.gz: 7eda244b03340ab7a979b16d33139c91407478110cb6cc5b7ebeb3e97a09b2e02a5cdea8727b685913fb406348726715c8e03eca41738f9aa3d8aeccdcaa137f

data/connect-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '3.0.0'
+  spec.version        = '3.1.0'
   spec.authors        = ['Worldline Global Collect']
   spec.email          = ['github.connect@worldline.com']
   spec.summary        = %q{SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API}

data/examples/v1/merchant/captures/create_refund_capture_example.rb

@@ -29,7 +29,7 @@ def example
     rescue Worldline::Connect::SDK::V1::DeclinedRefundException => e
       handle_declined_refund(e.refund_result)
     rescue Worldline::Connect::SDK::V1::ApiException => e
-      handle_api_errors(e.errors)
+      handle_error_response(e.error_id, e.errors)
     end
   end
 end
@@ -48,6 +48,6 @@ def handle_declined_refund(refund_result)
   # handle the result here
 end
 
-def handle_api_errors(errors)
-  # handle the errors here
+def handle_error_response(error_id, errors)
+  # handle the error response here
 end

data/examples/v1/merchant/payments/create_payment_example.rb

@@ -198,7 +198,7 @@ def example
     rescue Worldline::Connect::SDK::V1::DeclinedPaymentException => e
       handle_declined_payment(e.payment_result)
     rescue Worldline::Connect::SDK::V1::ApiException => e
-      handle_api_errors(e.errors)
+      handle_error_response(e.error_id, e.errors)
     end
   end
 end
@@ -217,6 +217,6 @@ def handle_declined_payment(create_payment_result)
   # handle the result here
 end
 
-def handle_api_errors(errors)
-  # handle the errors here
+def handle_error_response(error_id, errors)
+  # handle the error response here
 end

data/examples/v1/merchant/payments/refund_payment_example.rb

@@ -59,7 +59,7 @@ def example
     rescue Worldline::Connect::SDK::V1::DeclinedRefundException => e
       handle_declined_refund(e.refund_result)
     rescue Worldline::Connect::SDK::V1::ApiException => e
-      handle_api_errors(e.errors)
+      handle_error_response(e.error_id, e.errors)
     end
   end
 end
@@ -78,6 +78,6 @@ def handle_declined_refund(refund_result)
   # handle the result here
 end
 
-def handle_api_errors(errors)
-  # handle the errors here
+def handle_error_response(error_id, errors)
+  # handle the error response here
 end

data/examples/v1/merchant/payouts/create_payout_example.rb

@@ -78,7 +78,7 @@ def example
     rescue Worldline::Connect::SDK::V1::DeclinedPayoutException => e
       handle_declined_payout(e.payout_result)
     rescue Worldline::Connect::SDK::V1::ApiException => e
-      handle_api_errors(e.errors)
+      handle_error_response(e.error_id, e.errors)
     end
   end
 end
@@ -97,6 +97,6 @@ def handle_declined_payout(payout_result)
   # handle the result here
 end
 
-def handle_api_errors(errors)
-  # handle the errors here
+def handle_error_response(error_id, errors)
+  # handle the error response here
 end

data/lib/worldline/connect/sdk/communication/metadata_provider.rb

@@ -14,7 +14,7 @@ module Worldline
         class MetadataProvider
           private
 
-          SDK_VERSION = '3.0.0'.freeze
+          SDK_VERSION = '3.1.0'.freeze
           SERVER_META_INFO_HEADER = 'X-GCS-ServerMetaInfo'.freeze
           PROHIBITED_HEADERS = [SERVER_META_INFO_HEADER, 'X-GCS-Idempotence-Key','Date', 'Content-Type', 'Authorization'].sort!.freeze
           CHARSET = 'utf-8'.freeze

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

@@ -8,14 +8,12 @@ module Worldline
   module Connect
     module SDK
       module V1
-        # Base class for many exceptions raised by the SDK.
-        # It is raised when an error response is received from the Worldline Global Collect platform.
-        # It contains data about the returned response.
+        # Represents an error response from the Worldline Global Collect platform which contains an ID and a list of errors.
         #
         # @attr_reader [Integer] status_code   HTTP status code of the returned response.
         # @attr_reader [String]  response_body Message body of the returned response.
-        # @attr_reader [String]  error_id      An error id corresponding to the error that occurred, if available.
-        # @attr_reader [Array<Worldline::Connect::SDK::V1::Domain::APIError>] errors A list of errors received from the Worldline Global Collect platform;
+        # @attr_reader [String] error_id The _errorId_ received from the Worldline Global Collect platform if available.
+        # @attr_reader [Array<Worldline::Connect::SDK::V1::Domain::APIError>] errors The _errors_ received from the Worldline Global Collect platform if available;
         #              may be empty but never _nil_
         class ApiException < RuntimeError
 
@@ -23,8 +21,8 @@ module Worldline
           #
           # @param status_code   (Integer) HTTP status code the response
           # @param response_body (String) HTTP response body
-          # @param error_id      (String) error id of the error, may be _nil_
-          # @param errors        (Array<Worldline::Connect::SDK::V1::Domain::APIError>) a list of errors that occurred, may be empty
+          # @param error_id      (String) The _errorId_ received from the Worldline Global Collect platform
+          # @param errors        (Array<Worldline::Connect::SDK::V1::Domain::APIError>) The _errors_ received from the Worldline Global Collect platform
           # @param message       (String) error message to include
           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/authorization_exception.rb

@@ -8,11 +8,11 @@ module Worldline
   module Connect
     module SDK
       module V1
-        # This exception is thrown when a request sent to the Worldline Global Collect platform is not correctly authenticated.
-        # Corresponds to a HTTP status code of 403.
-        # @see ApiException#initialize
+        # Represents an error response from the Worldline Global Collect platform when authorization failed.
         class AuthorizationException < ApiException
 
+          # Create a new AuthorizationException.
+          # @see ApiException#initialize
           def initialize(status_code, response_body, error_id, errors,
                          message='the Worldline Global Collect platform returned an authorization error response')
             super(status_code, response_body, error_id, errors, message)

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

@@ -2,48 +2,37 @@
 # This class was auto-generated from the API references found at
 # https://apireference.connect.worldline-solutions.com/
 #
-require 'worldline/connect/sdk/v1/declined_transaction_exception'
+require_relative 'declined_transaction_exception'
 
 module Worldline
   module Connect
     module SDK
       module V1
-        # Indicates that a payment is declined by the Worldline Global Collect platform or one of its downstream partners/acquirers.
+        # Represents an error response from a create payment call.
         class DeclinedPaymentException < DeclinedTransactionException
 
           # Create a new DeclinedPaymentException.
           # @see ApiException#initialize
-          def initialize(status_code, response_body, errors)
-            if errors.nil?
-              super(status_code, response_body, nil, nil, build_message(errors))
-            else
-              super(status_code, response_body, errors.error_id, errors.errors, build_message(errors))
-            end
-            @errors = errors
+          def initialize(status_code, response_body, response)
+            super(status_code, response_body, response&.error_id, response&.errors, build_message(response))
+            @response = response
           end
 
-          # The declined payment result returned by the Worldline Global Collect platform.
-          # @return [Worldline::Connect::SDK::V1::Domain::CreatePaymentResult]
+          # The result of creating a payment
+          # @return [Worldline::Connect::SDK::V1::Domain::CreatePaymentResult, nil]
           def payment_result
-            if @errors.nil?
-              nil
-            else
-              @errors.payment_result
-            end
+            @response&.payment_result
           end
 
           private
 
-          def build_message(errors)
-            if !errors.nil? && !errors.payment_result.nil?
-              payment = errors.payment_result.payment
-            else
-              payment = nil
-            end
+          # @param response [Worldline::Connect::SDK::V1::Domain::PaymentErrorResponse, nil]
+          def build_message(response)
+            payment = response&.payment_result&.payment
             if payment.nil?
               'the Worldline Global Collect platform returned a declined payment response'
             else
-              "declined payment '" + payment.id + "' with status '" + payment.status + "'"
+              "declined payment '#{payment.id}' with status '#{payment.status}'"
             end
           end
         end

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

@@ -2,48 +2,37 @@
 # This class was auto-generated from the API references found at
 # https://apireference.connect.worldline-solutions.com/
 #
-require 'worldline/connect/sdk/v1/declined_transaction_exception'
+require_relative 'declined_transaction_exception'
 
 module Worldline
   module Connect
     module SDK
       module V1
-        # Indicates that a payout is declined by the Worldline Global Collect platform or one of its downstream partners/acquirers.
+        # Represents an error response from a payout call.
         class DeclinedPayoutException < DeclinedTransactionException
 
           # Create a new DeclinedPayoutException.
           # @see ApiException#initialize
-          def initialize(status_code, response_body, errors)
-            if errors.nil?
-              super(status_code, response_body, nil, nil, build_message(errors))
-            else
-              super(status_code, response_body, errors.error_id, errors.errors, build_message(errors))
-            end
-            @errors = errors
+          def initialize(status_code, response_body, response)
+            super(status_code, response_body, response&.error_id, response&.errors, build_message(response))
+            @response = response
           end
 
-          # The declined payout result as returned by the Worldline Global Collect platform.
-          # @return [Worldline::Connect::SDK::V1::Domain::PayoutResult]
+          # The result of creating a payout
+          # @return [Worldline::Connect::SDK::V1::Domain::PayoutResult, nil]
           def payout_result
-            if @errors.nil?
-              nil
-            else
-              @errors.payout_result
-            end
+            @response&.payout_result
           end
 
           private
 
-          def build_message(errors)
-            if !errors.nil?
-              payout = errors.payout_result
-            else
-              payout = nil
-            end
-            if payout.nil?
+          # @param response [Worldline::Connect::SDK::V1::Domain::PayoutErrorResponse, nil]
+          def build_message(response)
+            payout_result = response&.payout_result
+            if payout_result.nil?
               'the Worldline Global Collect platform returned a declined payout response'
             else
-              "declined payout '" + payout.id + "' with status '" + payout.status + "'"
+              "declined payout '#{payout_result.id}' with status '#{payout_result.status}'"
             end
           end
         end

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

@@ -2,48 +2,37 @@
 # This class was auto-generated from the API references found at
 # https://apireference.connect.worldline-solutions.com/
 #
-require 'worldline/connect/sdk/v1/declined_transaction_exception'
+require_relative 'declined_transaction_exception'
 
 module Worldline
   module Connect
     module SDK
       module V1
-        # Indicates that a refund is declined by the Worldline Global Collect platform or one of its downstream partners/acquirers.
+        # Represents an error response from a refund call.
         class DeclinedRefundException < DeclinedTransactionException
 
           # Create a new DeclinedRefundException.
           # @see ApiException#initialize
-          def initialize(status_code, response_body, errors)
-            if errors.nil?
-              super(status_code, response_body, nil, nil, build_message(errors))
-            else
-              super(status_code, response_body, errors.error_id, errors.errors, build_message(errors))
-            end
-            @errors = errors
+          def initialize(status_code, response_body, response)
+            super(status_code, response_body, response&.error_id, response&.errors, build_message(response))
+            @response = response
           end
 
-          # The declined refund result as returned by the Worldline Global Collect platform.
-          # @return [Worldline::Connect::SDK::V1::Domain::RefundResult]
+          # The result of creating a refund
+          # @return [Worldline::Connect::SDK::V1::Domain::RefundResult, nil]
           def refund_result
-            if @errors.nil?
-              nil
-            else
-              @errors.refund_result
-            end
+            @response&.refund_result
           end
 
           private
 
-          def build_message(errors)
-            if !errors.nil?
-              refund = errors.refund_result
-            else
-              refund = nil
-            end
-            if refund.nil?
+          # @param response [Worldline::Connect::SDK::V1::Domain::RefundErrorResponse, nil]
+          def build_message(response)
+            refund_result = response&.refund_result
+            if refund_result.nil?
               'the Worldline Global Collect platform returned a declined refund response'
             else
-              "declined refund '" + refund.id + "' with status '" + refund.status + "'"
+              "declined refund '#{refund_result.id}' with status '#{refund_result.status}'"
             end
           end
         end

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

@@ -2,13 +2,13 @@
 # This class was auto-generated from the API references found at
 # https://apireference.connect.worldline-solutions.com/
 #
-require 'worldline/connect/sdk/v1/api_exception'
+require_relative 'api_exception'
 
 module Worldline
   module Connect
     module SDK
       module V1
-        # Indicates that a transaction is declined by the Worldline Global Collect platform or one of its downstream partners/acquirers.
+        # Represents an error response from a create payment, payout or refund call.
         class DeclinedTransactionException < ApiException
 
           # Create a new DeclinedTransactionException.

data/lib/worldline/connect/sdk/v1/domain/abstract_card_payment_method_specific_input.rb

@@ -37,13 +37,11 @@ module Worldline
 
             attr_accessor :recurring
 
-            #
             # @deprecated Use recurring.recurringPaymentSequenceIndicator instead
             attr_accessor :recurring_payment_sequence_indicator
 
             attr_accessor :requires_approval
 
-            #
             # @deprecated Use threeDSecure.skipAuthentication instead
             attr_accessor :skip_authentication
 
@@ -55,7 +53,6 @@ module Worldline
 
             attr_accessor :transaction_channel
 
-            #
             # @deprecated Use unscheduledCardOnFileSequenceIndicator instead
             attr_accessor :unscheduled_card_on_file_indicator
 

data/lib/worldline/connect/sdk/v1/domain/abstract_sepa_direct_debit_payment_product771_specific_input.rb

@@ -12,7 +12,6 @@ module Worldline
           # @attr [String] mandate_reference
           class AbstractSepaDirectDebitPaymentProduct771SpecificInput < Worldline::Connect::SDK::Domain::DataObject
 
-            #
             # @deprecated Use existingUniqueMandateReference or mandate.uniqueMandateReference instead
             attr_accessor :mandate_reference
 

data/lib/worldline/connect/sdk/v1/domain/additional_order_input.rb

@@ -33,17 +33,14 @@ module Worldline
 
             attr_accessor :installments
 
-            #
             # @deprecated Use Order.shoppingCart.amountBreakdown instead
             attr_accessor :level3_summary_data
 
-            #
             # @deprecated No replacement
             attr_accessor :loan_recipient
 
             attr_accessor :lodging_data
 
-            #
             # @deprecated Use installments.numberOfInstallments instead
             attr_accessor :number_of_installments
 

data/lib/worldline/connect/sdk/v1/domain/airline_data.rb

@@ -50,7 +50,6 @@ module Worldline
 
             attr_accessor :is_e_ticket
 
-            #
             # @deprecated Use Order.customer.accountType instead
             attr_accessor :is_registered_customer
 

data/lib/worldline/connect/sdk/v1/domain/airline_flight_leg.rb

@@ -65,7 +65,6 @@ module Worldline
 
             attr_accessor :passenger_class
 
-            #
             # @deprecated Use passengerClass instead
             attr_accessor :service_class
 

data/lib/worldline/connect/sdk/v1/domain/bank_transfer_payout_method_specific_input.rb

@@ -24,7 +24,6 @@ module Worldline
 
             attr_accessor :bank_account_iban
 
-            #
             # @deprecated Moved to PayoutDetails
             attr_accessor :customer
 

data/lib/worldline/connect/sdk/v1/domain/card_payment_method_specific_input.rb

@@ -24,7 +24,6 @@ module Worldline
 
             attr_accessor :card
 
-            #
             # @deprecated Use threeDSecure.externalCardholderAuthenticationData instead
             attr_accessor :external_cardholder_authentication_data
 
@@ -34,7 +33,6 @@ module Worldline
 
             attr_accessor :network_token_data
 
-            #
             # @deprecated Use threeDSecure.redirectionData.returnUrl instead
             attr_accessor :return_url
 

data/lib/worldline/connect/sdk/v1/domain/card_payment_method_specific_output.rb

@@ -16,6 +16,7 @@ module Worldline
           # @attr [Worldline::Connect::SDK::V1::Domain::CardEssentials] card
           # @attr [Worldline::Connect::SDK::V1::Domain::CardFraudResults] fraud_results
           # @attr [String] initial_scheme_transaction_id
+          # @attr [true/false] network_token_used
           # @attr [String] scheme_transaction_id
           # @attr [Worldline::Connect::SDK::V1::Domain::ThreeDSecureResults] three_d_secure_results
           # @attr [String] token
@@ -29,6 +30,8 @@ module Worldline
 
             attr_accessor :initial_scheme_transaction_id
 
+            attr_accessor :network_token_used
+
             attr_accessor :scheme_transaction_id
 
             attr_accessor :three_d_secure_results
@@ -42,6 +45,7 @@ module Worldline
               hash['card'] = @card.to_h unless @card.nil?
               hash['fraudResults'] = @fraud_results.to_h unless @fraud_results.nil?
               hash['initialSchemeTransactionId'] = @initial_scheme_transaction_id unless @initial_scheme_transaction_id.nil?
+              hash['networkTokenUsed'] = @network_token_used unless @network_token_used.nil?
               hash['schemeTransactionId'] = @scheme_transaction_id unless @scheme_transaction_id.nil?
               hash['threeDSecureResults'] = @three_d_secure_results.to_h unless @three_d_secure_results.nil?
               hash['token'] = @token unless @token.nil?
@@ -64,6 +68,9 @@ module Worldline
               if hash.has_key? 'initialSchemeTransactionId'
                 @initial_scheme_transaction_id = hash['initialSchemeTransactionId']
               end
+              if hash.has_key? 'networkTokenUsed'
+                @network_token_used = hash['networkTokenUsed']
+              end
               if hash.has_key? 'schemeTransactionId'
                 @scheme_transaction_id = hash['schemeTransactionId']
               end

data/lib/worldline/connect/sdk/v1/domain/cash_payment_method_specific_input.rb

@@ -25,7 +25,6 @@ module Worldline
           # @attr [Worldline::Connect::SDK::V1::Domain::CashPaymentProduct1526SpecificInput] payment_product1526_specific_input
           class CashPaymentMethodSpecificInput < Worldline::Connect::SDK::V1::Domain::AbstractCashPaymentMethodSpecificInput
 
-            #
             # @deprecated No replacement
             attr_accessor :payment_product1503_specific_input
 

data/lib/worldline/connect/sdk/v1/domain/cash_payment_product1503_specific_input.rb

@@ -13,7 +13,6 @@ module Worldline
           # @deprecated No replacement
           class CashPaymentProduct1503SpecificInput < Worldline::Connect::SDK::Domain::DataObject
 
-            #
             # @deprecated No replacement, since Boleto Bancario no longer needs a return URL
             attr_accessor :return_url
 

data/lib/worldline/connect/sdk/v1/domain/create_payout_request.rb

@@ -32,15 +32,12 @@ module Worldline
           # @attr [String] swift_code
           class CreatePayoutRequest < Worldline::Connect::SDK::Domain::DataObject
 
-            #
             # @deprecated Moved to PayoutDetails
             attr_accessor :amount_of_money
 
-            #
             # @deprecated Moved to BankTransferPayoutMethodSpecificInput
             attr_accessor :bank_account_bban
 
-            #
             # @deprecated Moved to BankTransferPayoutMethodSpecificInput
             attr_accessor :bank_account_iban
 
@@ -48,27 +45,22 @@ module Worldline
 
             attr_accessor :card_payout_method_specific_input
 
-            #
             # @deprecated Moved to PayoutDetails
             attr_accessor :customer
 
             attr_accessor :merchant
 
-            #
             # @deprecated Moved to BankTransferPayoutMethodSpecificInput
             attr_accessor :payout_date
 
             attr_accessor :payout_details
 
-            #
             # @deprecated Moved to BankTransferPayoutMethodSpecificInput
             attr_accessor :payout_text
 
-            #
             # @deprecated Moved to PayoutDetails
             attr_accessor :references
 
-            #
             # @deprecated Moved to BankTransferPayoutMethodSpecificInput
             attr_accessor :swift_code
 

data/lib/worldline/connect/sdk/v1/domain/created_payment_output.rb

@@ -29,7 +29,6 @@ module Worldline
 
             attr_accessor :payment_creation_references
 
-            #
             # @deprecated Use Payment.statusOutput.statusCategory instead
             attr_accessor :payment_status_category
 

data/lib/worldline/connect/sdk/v1/domain/customer.rb

@@ -48,7 +48,6 @@ module Worldline
 
             attr_accessor :personal_information
 
-            #
             # @deprecated Use Order.shipping.address instead
             attr_accessor :shipping_address
 

data/lib/worldline/connect/sdk/v1/domain/customer_base.rb

@@ -19,7 +19,6 @@ module Worldline
 
             attr_accessor :merchant_customer_id
 
-            #
             # @deprecated Use companyInformation.vatNumber instead
             attr_accessor :vat_number
 

data/lib/worldline/connect/sdk/v1/domain/customer_risk_assessment.rb

@@ -42,7 +42,6 @@ module Worldline
 
             attr_accessor :personal_information
 
-            #
             # @deprecated Use Order.shipping.address instead
             attr_accessor :shipping_address
 

data/lib/worldline/connect/sdk/v1/domain/decrypted_payment_data.rb

@@ -19,7 +19,6 @@ module Worldline
           # @attr [String] payment_method
           class DecryptedPaymentData < Worldline::Connect::SDK::Domain::DataObject
 
-            #
             # @deprecated Use decryptedPaymentData.paymentMethod instead
             attr_accessor :auth_method
 

data/lib/worldline/connect/sdk/v1/domain/device_render_options.rb

@@ -16,7 +16,6 @@ module Worldline
 
             attr_accessor :sdk_interface
 
-            #
             # @deprecated Use deviceRenderOptions.sdkUiTypes instead
             attr_accessor :sdk_ui_type
 

data/lib/worldline/connect/sdk/v1/domain/external_cardholder_authentication_data.rb

@@ -38,7 +38,6 @@ module Worldline
 
             attr_accessor :three_d_secure_version
 
-            #
             # @deprecated No replacement
             attr_accessor :three_d_server_transaction_id