adyen-ruby-api-library 11.2.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbeb4e469ee9b14dfa153a16e0873e8a539db369c9c06eea43918fb03e5b7b99
-  data.tar.gz: 9ca4161c2c61c51f684d91ab31516660c418fb96df34c396c9565bec4595de19
+  metadata.gz: 693741925d32762e26160e80b884e798c099defd6a9c9f6cbcc237c0bb11ed59
+  data.tar.gz: cd90bd20010dfe6b74e25286790e7ce5a03e822e9763e26cc2d3d9cb8467d939
 SHA512:
-  metadata.gz: c2dbe3e238e9a7f2778dbd3e2fd6d7a49644d3c78da3514b947a2f4e10edd16afeab10ce85f48c6a4c326e5e41e8af0da08a7ba744e43dc62864ea18f04fe1bb
-  data.tar.gz: 05f49063c1d4250c3af8d3dc04ab381c5fa01eace21133d9429fdf4f0756789d05d814276eeac493d351bced3476014f68a7bef61013f6ef760c47b5dc290135
+  metadata.gz: 3dd7cfdc8e6d5100689d09906e12450f4c545cb994e55c3e7613ca7b0b179782b9a67d960ed0c4bccb1dade3a7aa0f7c6b49843da675c88047900ac3ffcc2224
+  data.tar.gz: eed28c652c5086aed7d9c60a97fa97002070bd8c78d60a885fb5b79776e2debdda38a6f2bb2bb1f60d7756e0a538041fade7a8c1743fde940d3735aff33bd2e5

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @Adyen/developer-relations @Adyen/api-library-maintainers
+* @Adyen/api-library-maintainers

data/.github/workflows/codeql.yml

@@ -20,18 +20,18 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4
+        uses: github/codeql-action/init@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4
         with:
           languages: ${{ matrix.language }}
           queries: +security-and-quality
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4
+        uses: github/codeql-action/autobuild@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4
+        uses: github/codeql-action/analyze@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4
         with:
           category: "/language:${{ matrix.language }}"

data/.github/workflows/release.yml

@@ -28,7 +28,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Prepare the next main release
         uses: Adyen/release-automation-action@3e5694d5b365f344a62436e84049511ef318ecf5 # v1.4.0
         with:

data/.github/workflows/ruby.yml

@@ -16,11 +16,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.7, '3.0', 3.1, 3.2, head]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '4.0'
+        ruby: [3.3, 3.4, '4.0', head]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
     - uses: ruby/setup-ruby@8a836efbcebe5de0fe86b48a775b7a31b5c70c93 # v1
       with:
         ruby-version: ${{ matrix.ruby }}

data/.github/workflows/rubygems_release.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Release Gem on RubyGems
         if: contains(github.ref, 'refs/tags/v')
         uses: cadwallion/publish-rubygems-action@94a6f4cd5350581749c569b5001eecc864e3ad0b # v1.1.0

data/.github/workflows/stale.yml

@@ -7,7 +7,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10
+      - uses: actions/stale@b5d41d4e1d5dceea10e7104786b73624c18a190f # v10
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           stale-issue-message: 'This issue has been automatically marked as stale due to inactivity and will be closed in 7 days if no further activity occurs.'

data/Gemfile

@@ -2,9 +2,9 @@
 
 source 'https://rubygems.org'
 
-ruby '>= 2.7.0'
+ruby '>= 3.3.0'
 
-gem 'faraday', '2.8.1'
+gem 'faraday', '2.14.3'
 
 gem 'activesupport', group: :development
 gem 'bundler', group: :development

data/README.md

@@ -12,23 +12,28 @@ This library supports the following:
 | API name                                                                                                                      | API version | Description                                                                                                                                                                                                                                                                                                                             | API object                                                           |
 |-------------------------------------------------------------------------------------------------------------------------------|:-----------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
 | [BIN lookup API](https://docs.adyen.com/api-explorer/BinLookup/54/overview)                                                   |     v54     | The BIN Lookup API provides endpoints for retrieving information based on a given BIN.                                                                                                                                                                                                                                                  | [BinLookup](lib/adyen/services/binLookup.rb)                         |
-| [Checkout API](https://docs.adyen.com/api-explorer/Checkout/71/overview)                                                      |     v71     | Our latest integration for accepting online payments.                                                                                                                                                                                                                                                                                   | [CheckoutAPI](lib/adyen/services/checkout.rb)                        |
-| [Capital API](https://docs.adyen.com/api-explorer/capital/1/overview) | v1 | Provides endpoints for embedding Adyen Capital into your marketplace or platform. | [Capital](lib/adyen/services/capital.rb) |
+| [Checkout API](https://docs.adyen.com/api-explorer/Checkout/72/overview)                                                      |     v72     | Our latest integration for accepting online payments.                                                                                                                                                                                                                                                                                   | [CheckoutAPI](lib/adyen/services/checkout.rb)                        |
+| [Capital API](https://docs.adyen.com/api-explorer/capital/1/overview) |     v1      | Provides endpoints for embedding Adyen Capital into your marketplace or platform. | [Capital](lib/adyen/services/capital.rb) |
 | [Configuration API](https://docs.adyen.com/api-explorer/balanceplatform/2/overview)                                           |     v2      | The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts.                                                                                                                                                                   | [BalancePlatform](lib/adyen/services/balancePlatform.rb)             |
 | [DataProtection API](https://docs.adyen.com/development-resources/data-protection-api)                                        |     v1      | Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email)                       | [DataProtection](lib/adyen/services/dataProtection.rb)               |
-| [Legal Entity Management API](https://docs.adyen.com/api-explorer/legalentity/3/overview)                                     |     v4      | Manage legal entities that contain information required for verification.                                                                                                                                                                                                                                                               | [LegalEntityManagement](lib/adyen/services/legalEntityManagement.rb) |
+| [Legal Entity Management API](https://docs.adyen.com/api-explorer/legalentity/4/overview)                                     |     v4      | Manage legal entities that contain information required for verification.                                                                                                                                                                                                                                                               | [LegalEntityManagement](lib/adyen/services/legalEntityManagement.rb) |
 | [Management API](https://docs.adyen.com/api-explorer/Management/3/overview)                                     |     v3      | Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.                                                                                                                                                                                                                                           | [Management](lib/adyen/services/management.rb)                       |
 | [OpenBanking API](https://docs.adyen.com/api-explorer/open-banking/1/overview)                                                |     v1      |  Securely share financial data and services with third parties.                                                                                                                                                                                                                                                  | [OpenBanking](lib/adyen/services/openBanking.rb)                     |
 | [SessionAuthentication API](https://docs.adyen.com/api-explorer/sessionauthentication/1/overview)                                                |     v1      |  The Session authentication API enables you to create and manage the JSON Web Tokens (JWT) required for integrating components.                                                                                                                                                                                                                                                  | [SessionAuthentication](lib/adyen/services/sessionAuthentication.rb)                     |
 | [Payments API](https://docs.adyen.com/api-explorer/Payment/68/overview)                                                       |     v68     | Our classic integration for online payments.                                                                                                                                                                                                                                                                                            | [Classic Integration API](lib/adyen/services/payment.rb)             |
 | [Payouts API](https://docs.adyen.com/api-explorer/Payout/68/overview)                                                         |     v68     | Endpoints for sending funds to your customers.                                                                                                                                                                                                                                                                                          | [Payout](lib/adyen/services/payout.rb)                               |
-| [POS Terminal Management API](https://docs.adyen.com/api-explorer/postfmapi/1/overview)                                       |     ~~v1~~      | ~~Endpoints for managing your point-of-sale payment terminals.~~ ‼️ **Deprecated**: use instead the [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview) for the management of your terminal fleet.                                                                                                                                                                                                                                                                                | ~~[TerminalManagement](lib/adyen/services/posTerminalManagement.rb)~~    || [Recurring API](https://docs.adyen.com/api-explorer/Recurring/68/overview)                                                    |     v68     | Endpoints for managing saved payment details.                                                                                                                                                                                                                                                                                           | [Recurring](lib/adyen/services/recurring.rb)                         |
+| [POS Terminal Management API](https://docs.adyen.com/api-explorer/postfmapi/1/overview)                                       |   ~~v1~~    | ~~Endpoints for managing your point-of-sale payment terminals.~~ ‼️ **Deprecated**: use instead the [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview) for the management of your terminal fleet.                                                                                                                                                                                                                                                                                | ~~[TerminalManagement](lib/adyen/services/posTerminalManagement.rb)~~    |
+| [Recurring API](https://docs.adyen.com/api-explorer/Recurring/68/overview)                                                    |     v68     | Endpoints for managing saved payment details.                                                                                                                                                                                                                                                                                           | [Recurring](lib/adyen/services/recurring.rb)                         |
 | [Stored Value API](https://docs.adyen.com/payment-methods/gift-cards/stored-value-api)                                        |     v46     | Manage both online and point-of-sale gift cards and other stored-value cards.                                                                                                                                                                                                                                                           | [StoredValue](lib/adyen/services/storedValue.rb)                     |
 | [Transfers API](https://docs.adyen.com/api-explorer/transfers/4/overview)                                                     |     v4      | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument.                                                                                                                        | [Transfers](lib/adyen/services/transfers.rb)                         |
 | [Cloud-based Terminal API](https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/) |      -      | Our point-of-sale integration.                                                                                                                                                                                                                                                                                                          | [TerminalCloudAPI](lib/adyen/services/terminalCloudAPI.rb)           |
 | [Disputes API](https://docs.adyen.com/api-explorer/Disputes/30/overview)                                                      |     v30     | You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. | [Disputes](lib/adyen/services/disputes.rb)                                                                                      |
-| [POS Mobile API](https://docs.adyen.com/api-explorer/possdk/68/overview) |    v68     | The POS Mobile API is used in the mutual authentication flow between an Adyen Android or iOS [POS Mobile SDK](https://docs.adyen.com/point-of-sale/ipp-mobile/) and the Adyen payments platform. The POS Mobile SDK for Android or iOS devices enables businesses to accept in-person payments using a commercial off-the-shelf (COTS) device like a phone. For example, Tap to Pay transactions, or transactions on a mobile device in combination with a card reader. | [POS Mobile](lib/adyen/services/posMobile.rb) |
-| [Payments App API](https://docs.adyen.com/api-explorer/payments-app/1/overview) | v1 | The Payments App API is used to Board and manage the Adyen Payments App on your Android mobile devices. | [paymentsApp](lib/adyen/services/paymentsApp.rb) |
+| [POS Mobile API](https://docs.adyen.com/api-explorer/possdk/68/overview) |     v68     | The POS Mobile API is used in the mutual authentication flow between an Adyen Android or iOS [POS Mobile SDK](https://docs.adyen.com/point-of-sale/ipp-mobile/) and the Adyen payments platform. The POS Mobile SDK for Android or iOS devices enables businesses to accept in-person payments using a commercial off-the-shelf (COTS) device like a phone. For example, Tap to Pay transactions, or transactions on a mobile device in combination with a card reader. | [POS Mobile](lib/adyen/services/posMobile.rb) |
+| [Payments App API](https://docs.adyen.com/api-explorer/payments-app/1/overview) |     v1      | The Payments App API is used to Board and manage the Adyen Payments App on your Android mobile devices. | [paymentsApp](lib/adyen/services/paymentsApp.rb) |
+| [Classic Platforms Account API](https://docs.adyen.com/api-explorer/Account/6/overview) |     v6      | This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead. | [Marketpay::Account](lib/adyen/services/marketpay.rb) |
+| [Classic Platforms Fund API](https://docs.adyen.com/api-explorer/Fund/6/overview) |     v6      | This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead. | [Marketpay::Fund](lib/adyen/services/marketpay.rb) |
+| [Classic Platforms Hosted Onboarding Page API](https://docs.adyen.com/api-explorer/Hop/6/overview) |     v6      | This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead. | [Marketpay::Hop](lib/adyen/services/marketpay.rb) |
+| [Classic Platforms Notification Configuration API](https://docs.adyen.com/api-explorer/NotificationConfiguration/6/overview) |     v6      | This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead. | [Marketpay::Notification](lib/adyen/services/marketpay.rb) |
 
 
 
@@ -37,7 +42,7 @@ For more information, refer to our [documentation](https://docs.adyen.com/) or t
 ## Prerequisites
 - [Adyen test account](https://docs.adyen.com/get-started-with-adyen)
 - [API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). For testing, your API credential needs to have the [API PCI Payments role](https://docs.adyen.com/development-resources/api-credentials#roles).
-- Ruby >= 2.7
+- Ruby >= 3.3
 
 ## Installation
 
@@ -60,6 +65,24 @@ rspec
 
 Follow the rest of our guides from the [documentation](https://adyen.github.io/adyen-ruby-api-library/) on how to use this library.
 
+## Deprecations
+
+Deprecated API methods emit Ruby deprecation warnings with the `:deprecated` warning category. These warnings are hidden by default in modern Ruby versions. To see them, enable the category in your application:
+
+~~~~ruby
+Warning[:deprecated] = true
+~~~~
+
+or run Ruby with the `-w` flag. Each warning names the deprecated method, the version it was deprecated since, and the recommended alternative when available.
+
+To silence only this library's deprecation warnings (while keeping the category enabled for the rest of your application), use the attribute or the environment variable:
+
+~~~~ruby
+Adyen::Deprecation.silenced = true
+~~~~
+
+or set `ADYEN_SILENCE_DEPRECATIONS` to `1`, `true`, or `yes`. Explicitly setting the attribute (`true` or `false`) takes precedence over the environment variable. Silenced warnings never appear, even when the category is enabled.
+
 ## Using the library
 
 ### General use with API key

data/VERSION

@@ -1,2 +1,2 @@
-11.2.0
+12.0.0
 

data/adyen-ruby-api-library.gemspec

@@ -3,7 +3,7 @@ require_relative 'lib/adyen/version'
 Gem::Specification.new do |spec|
   spec.name = 'adyen-ruby-api-library'
   spec.version = Adyen::VERSION
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.3.0'
   spec.authors = ['Adyen']
   spec.email = ['support@adyen.com']
 

data/lib/adyen/client.rb

@@ -22,7 +22,7 @@ module Adyen
       @ws_password = ws_password
       @api_key = api_key
       @oauth_token = oauth_token
-      @env = env
+      self.env = env
       @application_name = application_name
       @adapter = adapter || Faraday.default_adapter
       if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.1')
@@ -33,25 +33,20 @@ module Adyen
         @adapter_options = adapter_options || {}
       end
       @mock_service_url_base = mock_service_url_base || "http://localhost:#{mock_port}"
-      @live_url_prefix = live_url_prefix
-      if RUBY_VERSION >= '3.2'
-        # set default timeouts
-        @connection_options = connection_options || Faraday::ConnectionOptions.new(
-          request: Faraday::RequestOptions.new(
-            open_timeout: 30,
-            timeout: 60
-          )
+      self.live_url_prefix = live_url_prefix
+      # set default timeouts
+      @connection_options = connection_options || Faraday::ConnectionOptions.new(
+        request: Faraday::RequestOptions.new(
+          open_timeout: 30,
+          timeout: 60
         )
-      else
-        @connection_options = connection_options || Faraday::ConnectionOptions.new
-      end
-
+      )
       @terminal_region = terminal_region
     end
 
     # make sure that env can only be :live, :test, or :mock
     def env=(value)
-      raise ArgumentError, "Invalid value for Client.env: '#{value}'' - must be one of [:live, :test, :mock]" unless %i[
+      raise ArgumentError, "Invalid value for Client.env: '#{value}' - must be one of [:live, :test, :mock]" unless %i[
         live test mock
       ].include? value
 
@@ -60,8 +55,7 @@ module Adyen
 
     # remove 'https' from live_url_prefix if necessary
     def live_url_prefix=(value)
-      value['https://'] = '' unless value['https://'].nil?
-      @live_url_prefix = value
+      @live_url_prefix = value.nil? ? value : value.sub('https://', '')
     end
 
     # base URL for API given service and @env

data/lib/adyen/deprecation.rb

@@ -0,0 +1,34 @@
+module Adyen
+  # Helper module for emitting deprecation warnings for deprecated API methods.
+  module Deprecation
+    # Set to true to silence all Adyen deprecation warnings, regardless of
+    # Warning[:deprecated]. Explicitly setting this attribute (true or false)
+    # overrides the ADYEN_SILENCE_DEPRECATIONS environment variable.
+    def self.silenced=(value)
+      @silenced = value
+    end
+
+    # True when deprecation warnings are silenced, either via the attribute or,
+    # when the attribute was never set, via the ADYEN_SILENCE_DEPRECATIONS
+    # environment variable ("1", "true" or "yes", case-insensitive).
+    def self.silenced?
+      return @silenced unless @silenced.nil?
+
+      %w[1 true yes].include?(ENV.fetch('ADYEN_SILENCE_DEPRECATIONS', '').downcase)
+    end
+
+    # Emits a deprecation warning for a deprecated method.
+    #
+    # @param method_name [Symbol, String] name of the deprecated method
+    # @param since [String, nil] e.g. "Adyen Checkout API v67"
+    # @param message [String, nil] additional guidance, e.g. the alternative to use
+    def self.warn(method_name, since: nil, message: nil)
+      return if silenced?
+
+      text = "[DEPRECATED] `#{method_name}` is deprecated"
+      text += " since #{since}" if since
+      text += ". #{message}" if message
+      Kernel.warn(text, category: :deprecated, uplevel: 2)
+    end
+  end
+end

data/lib/adyen/services/balanceControl/balance_control_api.rb

@@ -15,10 +15,10 @@ module Adyen
     # Start a balance transfer
     #
     # Deprecated since Adyen Balance Control API v1
+    # @deprecated
     def balance_transfer(request, headers: {})
-      endpoint = '/balanceTransfer'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint)
+      Adyen::Deprecation.warn(:balance_transfer, since: 'Adyen Balance Control API v1')
+      endpoint = build_endpoint('/balanceTransfer')
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)

data/lib/adyen/services/balancePlatform/account_holders_api.rb

@@ -14,9 +14,7 @@ module Adyen
 
     # Create an account holder
     def create_account_holder(request, headers: {})
-      endpoint = '/accountHolders'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint)
+      endpoint = build_endpoint('/accountHolders')
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
@@ -24,9 +22,7 @@ module Adyen
 
     # Get an account holder
     def get_account_holder(id, headers: {})
-      endpoint = '/accountHolders/{id}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/accountHolders/{id}', id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -34,9 +30,7 @@ module Adyen
 
     # Get all balance accounts of an account holder
     def get_all_balance_accounts_of_account_holder(id, headers: {}, query_params: {})
-      endpoint = '/accountHolders/{id}/balanceAccounts'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/accountHolders/{id}/balanceAccounts', id)
       endpoint += create_query_string(query_params)
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -44,9 +38,7 @@ module Adyen
 
     # Get all transaction rules for an account holder
     def get_all_transaction_rules_for_account_holder(id, headers: {})
-      endpoint = '/accountHolders/{id}/transactionRules'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/accountHolders/{id}/transactionRules', id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -54,9 +46,15 @@ module Adyen
 
     # Get a tax form
     def get_tax_form(id, headers: {}, query_params: {})
-      endpoint = '/accountHolders/{id}/taxForms'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/accountHolders/{id}/taxForms', id)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    # Get summary of tax forms for an account holder
+    def get_tax_form_summary(id, headers: {}, query_params: {})
+      endpoint = build_endpoint('/accountHolders/{id}/taxFormSummary', id)
       endpoint += create_query_string(query_params)
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -64,9 +62,7 @@ module Adyen
 
     # Update an account holder
     def update_account_holder(request, id, headers: {})
-      endpoint = '/accountHolders/{id}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/accountHolders/{id}', id)
       
       action = { method: 'patch', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)

data/lib/adyen/services/balancePlatform/authorized_card_users_api.rb

@@ -14,9 +14,7 @@ module Adyen
 
     # Create authorized users for a card.
     def create_authorised_card_users(request, payment_instrument_id, headers: {})
-      endpoint = '/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, payment_instrument_id)
+      endpoint = build_endpoint('/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers', payment_instrument_id)
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
@@ -24,9 +22,7 @@ module Adyen
 
     # Delete the authorized users for a card.
     def delete_authorised_card_users(payment_instrument_id, headers: {})
-      endpoint = '/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, payment_instrument_id)
+      endpoint = build_endpoint('/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers', payment_instrument_id)
       
       action = { method: 'delete', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -34,9 +30,7 @@ module Adyen
 
     # Get authorized users for a card.
     def get_all_authorised_card_users(payment_instrument_id, headers: {})
-      endpoint = '/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, payment_instrument_id)
+      endpoint = build_endpoint('/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers', payment_instrument_id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -44,9 +38,7 @@ module Adyen
 
     # Update the authorized users for a card.
     def update_authorised_card_users(request, payment_instrument_id, headers: {})
-      endpoint = '/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, payment_instrument_id)
+      endpoint = build_endpoint('/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers', payment_instrument_id)
       
       action = { method: 'patch', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)

data/lib/adyen/services/balancePlatform/balance_accounts_api.rb

@@ -14,49 +14,15 @@ module Adyen
 
     # Create a balance account
     def create_balance_account(request, headers: {})
-      endpoint = '/balanceAccounts'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint)
+      endpoint = build_endpoint('/balanceAccounts')
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
     end
 
-    # Create a sweep
-    def create_sweep(request, balance_account_id, headers: {})
-      endpoint = '/balanceAccounts/{balanceAccountId}/sweeps'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_account_id)
-      
-      action = { method: 'post', url: endpoint }
-      @client.call_adyen_api(@service, action, request, headers, @version)
-    end
-
-    # Delete a sweep
-    def delete_sweep(balance_account_id, sweep_id, headers: {})
-      endpoint = '/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_account_id, sweep_id)
-      
-      action = { method: 'delete', url: endpoint }
-      @client.call_adyen_api(@service, action, {}, headers, @version)
-    end
-
-    # Get all sweeps for a balance account
-    def get_all_sweeps_for_balance_account(balance_account_id, headers: {}, query_params: {})
-      endpoint = '/balanceAccounts/{balanceAccountId}/sweeps'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_account_id)
-      endpoint += create_query_string(query_params)
-      action = { method: 'get', url: endpoint }
-      @client.call_adyen_api(@service, action, {}, headers, @version)
-    end
-
     # Get all transaction rules for a balance account
     def get_all_transaction_rules_for_balance_account(id, headers: {})
-      endpoint = '/balanceAccounts/{id}/transactionRules'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/balanceAccounts/{id}/transactionRules', id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -64,9 +30,7 @@ module Adyen
 
     # Get a balance account
     def get_balance_account(id, headers: {})
-      endpoint = '/balanceAccounts/{id}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/balanceAccounts/{id}', id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -74,39 +38,15 @@ module Adyen
 
     # Get payment instruments linked to a balance account
     def get_payment_instruments_linked_to_balance_account(id, headers: {}, query_params: {})
-      endpoint = '/balanceAccounts/{id}/paymentInstruments'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/balanceAccounts/{id}/paymentInstruments', id)
       endpoint += create_query_string(query_params)
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 
-    # Get a sweep
-    def get_sweep(balance_account_id, sweep_id, headers: {})
-      endpoint = '/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_account_id, sweep_id)
-      
-      action = { method: 'get', url: endpoint }
-      @client.call_adyen_api(@service, action, {}, headers, @version)
-    end
-
     # Update a balance account
     def update_balance_account(request, id, headers: {})
-      endpoint = '/balanceAccounts/{id}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
-      
-      action = { method: 'patch', url: endpoint }
-      @client.call_adyen_api(@service, action, request, headers, @version)
-    end
-
-    # Update a sweep
-    def update_sweep(request, balance_account_id, sweep_id, headers: {})
-      endpoint = '/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_account_id, sweep_id)
+      endpoint = build_endpoint('/balanceAccounts/{id}', id)
       
       action = { method: 'patch', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)

data/lib/adyen/services/balancePlatform/balances_api.rb

@@ -14,9 +14,7 @@ module Adyen
 
     # Create a balance webhook setting
     def create_webhook_setting(request, balance_platform_id, webhook_id, headers: {})
-      endpoint = '/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_platform_id, webhook_id)
+      endpoint = build_endpoint('/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings', balance_platform_id, webhook_id)
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
@@ -24,9 +22,7 @@ module Adyen
 
     # Delete a balance webhook setting by id
     def delete_webhook_setting(balance_platform_id, webhook_id, setting_id, headers: {})
-      endpoint = '/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_platform_id, webhook_id, setting_id)
+      endpoint = build_endpoint('/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}', balance_platform_id, webhook_id, setting_id)
       
       action = { method: 'delete', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -34,9 +30,7 @@ module Adyen
 
     # Get all balance webhook settings
     def get_all_webhook_settings(balance_platform_id, webhook_id, headers: {})
-      endpoint = '/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_platform_id, webhook_id)
+      endpoint = build_endpoint('/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings', balance_platform_id, webhook_id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -44,9 +38,7 @@ module Adyen
 
     # Get a balance webhook setting by id
     def get_webhook_setting(balance_platform_id, webhook_id, setting_id, headers: {})
-      endpoint = '/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_platform_id, webhook_id, setting_id)
+      endpoint = build_endpoint('/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}', balance_platform_id, webhook_id, setting_id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -54,9 +46,7 @@ module Adyen
 
     # Update a balance webhook setting by id
     def update_webhook_setting(request, balance_platform_id, webhook_id, setting_id, headers: {})
-      endpoint = '/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, balance_platform_id, webhook_id, setting_id)
+      endpoint = build_endpoint('/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}', balance_platform_id, webhook_id, setting_id)
       
       action = { method: 'patch', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)

data/lib/adyen/services/balancePlatform/bank_account_validation_api.rb

@@ -14,9 +14,7 @@ module Adyen
 
     # Validate a bank account
     def validate_bank_account_identification(request, headers: {})
-      endpoint = '/validateBankAccountIdentification'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint)
+      endpoint = build_endpoint('/validateBankAccountIdentification')
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)

data/lib/adyen/services/balancePlatform/card_orders_api.rb

@@ -14,9 +14,7 @@ module Adyen
 
     # Get card order items
     def get_card_order_items(id, headers: {}, query_params: {})
-      endpoint = '/cardorders/{id}/items'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/cardorders/{id}/items', id)
       endpoint += create_query_string(query_params)
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -24,9 +22,7 @@ module Adyen
 
     # Get a list of card orders
     def list_card_orders(headers: {}, query_params: {})
-      endpoint = '/cardorders'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint)
+      endpoint = build_endpoint('/cardorders')
       endpoint += create_query_string(query_params)
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)