adyen-ruby-api-library 11.1.0 → 11.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b51bd749bf2197660b344467eb810e18fc85c595313444b25b0b1c6e5efd4e
-  data.tar.gz: fe1566a9a57a0be999ca83dc1704893050f13756f07529526fa457aa270bec6c
+  metadata.gz: 10f1c74499bd2f3448b7e4dbf1705bcb4def1719a63f4e23390eca41ff7adcfd
+  data.tar.gz: eb5f39decf49d935ad0b949be13684754af64da9cabaf1f08f98bdd3560188de
 SHA512:
-  metadata.gz: acf09d5e10e31179b243638b37e9c5528193fad0b3bb0fcb6d667f8a75a045a79efeb8dec96338bbec1bc3f13efd608c9c4c231325c76123a98afb342155c830
-  data.tar.gz: e5e9e834d79ef4a52e8ecb5d863394dbdce70050f3f0e72577fa0cfdc39b1475bf984adbb1a02ef4d0376f3cd2aeb99ef976922e02e2c31b3ce207fe82c5cde3
+  metadata.gz: 5bba85b9828d293d97c44eceecfae49755d34496977755b40be3d0569840c093010dd1916203ecafb5adf2e19be578dc89cf6484195568f6e70b4296876975b9
+  data.tar.gz: f1285563c2abeaf38e4aa8260cba67250a992b30508cfc226eeb627d05a1fc0bafecf04f131d7ca84d20b6b8533f8bf768d8d0a1c9f6d3f38e0ab75800a70900

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@v5
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4
         with:
           languages: ${{ matrix.language }}
           queries: +security-and-quality
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
+        uses: github/codeql-action/autobuild@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4
         with:
           category: "/language:${{ matrix.language }}"

data/.github/workflows/label_new_issues.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Add 'needs response' label to new issues
-        uses: actions-ecosystem/action-add-labels@v1
+        uses: actions-ecosystem/action-add-labels@18f1af5e3544586314bbe15c0273249c770b2daf # v1
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           labels: 'needs response'

data/.github/workflows/release.yml

@@ -28,9 +28,9 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Prepare the next main release
-        uses: Adyen/release-automation-action@v1.4.0
+        uses: Adyen/release-automation-action@3e5694d5b365f344a62436e84049511ef318ecf5 # v1.4.0
         with:
           token: ${{ secrets.ADYEN_AUTOMATION_BOT_ACCESS_TOKEN }}
           develop-branch: main

data/.github/workflows/ruby.yml

@@ -1,6 +1,14 @@
 name: ruby
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  merge_group:    
+  workflow_dispatch: {}
 
 jobs:
   test:
@@ -12,8 +20,8 @@ jobs:
         ruby: [2.7, '3.0', 3.1, 3.2, head]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v5
-    - uses: ruby/setup-ruby@v1
+    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+    - uses: ruby/setup-ruby@8a836efbcebe5de0fe86b48a775b7a31b5c70c93 # v1
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/.github/workflows/rubygems_release.yml

@@ -9,10 +9,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Release Gem on RubyGems
         if: contains(github.ref, 'refs/tags/v')
-        uses: cadwallion/publish-rubygems-action@v1.1.0
+        uses: cadwallion/publish-rubygems-action@94a6f4cd5350581749c569b5001eecc864e3ad0b # v1.1.0
         env:
           GITHUB_TOKEN: ${{secrets.TOKEN_RUBYGEMS_RELEASES_WITH_EXPIRATION}}
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.github/workflows/stale.yml

@@ -7,7 +7,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v9
+      - 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/AGENTS.md

@@ -0,0 +1,73 @@
+## Overview
+
+This is the Adyen Ruby API Library, providing Ruby developers with an easy way to interact with the Adyen API. The library is a wrapper around the Adyen API, with services generated from OpenAPI specifications.
+
+## Code Generation
+
+A significant portion of this library, particularly the API services, is automatically generated.
+
+- **Engine**: We use [OpenAPI Generator](https://openapi-generator.tech/) with custom [Mustache](https://mustache.github.io/) templates to convert Adyen's OpenAPI specifications into Ruby code.
+- **Templates**: The custom templates are located in the `/templates` directory. These templates are tailored to fit our custom HTTP client and service structure.
+- **Automation**:
+    - **Centralized**: The primary generation process is managed in a separate repository, [`adyen-sdk-automation`](https://github.com/Adyen/adyen-sdk-automation). Changes to the OpenAPI specs trigger a GitHub workflow in that repository, which generates the code and opens Pull Requests in this library.
+    - **Local**: For development and testing, you must use the [`adyen-sdk-automation`](https://github.com/Adyen/adyen-sdk-automation) repository.
+
+### Local Code Generation
+
+To test new features or changes to the templates, you must run the generation process from a local clone of the `adyen-sdk-automation` repository.
+
+1.  **Clone the automation repository**:
+    ```bash
+    git clone https://github.com/Adyen/adyen-sdk-automation.git
+    ```
+
+2.  **Link this library**: The automation project needs to target your local clone of `adyen-ruby-api-library`. From inside the `adyen-sdk-automation` directory, run the following commands. This will replace the `ruby/repo` directory with a symlink to your local project.
+    ```bash
+    rm -rf ruby/repo
+    ln -s /path/to/your/adyen-ruby-api-library ruby/repo
+    ```
+
+3.  **Run the generator**: You can now run the Gradle commands to generate code.
+    - **To generate all services for the Ruby library**:
+      ```bash
+      ./gradlew :ruby:services
+      ```
+    - **To generate a single service (e.g., Checkout)**:
+      ```bash
+      ./gradlew :ruby:checkout
+      ```
+    - **To clean the repository before generating**:
+      ```bash
+      ./gradlew :ruby:cleanRepo :ruby:checkout
+      ```
+
+## Core Components
+
+- **`Adyen::Client`**: The main class in `lib/adyen/client.rb` that provides easy access to all API services and handles configuration (API key, environment, etc.).
+- **`Adyen::Service`**: The base class located in `lib/adyen/services/service.rb` from which all generated services inherit. It contains the logic for making API calls.
+- **`lib/adyen/services/`**: This directory contains the generated service classes (e.g., `Checkout`, `Management`) that expose methods for specific API endpoints. This library does not use generated models for requests and responses; standard Ruby Hashes are used instead.
+
+## Development Workflow
+
+### Setup
+
+To install the library and its development dependencies, run:
+```bash
+bundle config set with development
+bundle install
+```
+
+### Running Tests
+
+To run the RSpec test suite, use the following command:
+```bash
+bundle exec rspec
+```
+This is the command used in our GitHub Actions workflow to ensure code quality and correctness.
+
+## Release Process
+
+The release process is automated via GitHub Actions and involves two main workflows:
+
+1.  **Release PR Creation**: After a pull request is merged to `main`, the `release.yml` workflow automatically creates a new pull request that bumps the version number in `lib/adyen/version.rb`.
+2.  **Publishing to RubyGems**: Once the version bump PR is merged, a maintainer can create a GitHub Release. This can be done by manually running the `Release` workflow with the `github-release` option. The creation of a published release on GitHub triggers the `rubygems_release.yml` workflow, which publishes the new version of the gem to RubyGems.

data/README.md

@@ -13,6 +13,7 @@ This library supports the following:
 |-------------------------------------------------------------------------------------------------------------------------------|:-----------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
 | [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) |
 | [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) |
@@ -70,6 +71,8 @@ require 'adyen-ruby-api-library'
 adyen = Adyen::Client.new
 
 adyen.api_key = 'AF5XXXXXXXXXXXXXXXXXXXX'
+# If applicable, set application name (for tracking purposes)
+# adyen.application_name = 'MyTestApp'
 
 ~~~~
 

data/VERSION

@@ -1,2 +1,2 @@
-11.1.0
+11.3.0
 

data/lib/adyen/client.rb

@@ -12,16 +12,18 @@ require_relative './result'
 
 module Adyen
   class Client
-    attr_accessor :ws_user, :ws_password, :api_key, :oauth_token, :client, :adapter
+    attr_accessor :ws_user, :ws_password, :api_key, :oauth_token, :client, :adapter, :application_name
     attr_reader :env, :connection_options, :adapter_options, :terminal_region
 
     def initialize(ws_user: nil, ws_password: nil, api_key: nil, oauth_token: nil, env: :live, adapter: nil, mock_port: 3001,
-                   live_url_prefix: nil, mock_service_url_base: nil, connection_options: nil, adapter_options: nil, terminal_region: nil)
+                   live_url_prefix: nil, mock_service_url_base: nil, connection_options: nil, adapter_options: nil, terminal_region: nil,
+                   application_name: nil)
       @ws_user = ws_user
       @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')
         # for faraday 2.1 and higher
@@ -31,7 +33,7 @@ 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
+      self.live_url_prefix = live_url_prefix
       if RUBY_VERSION >= '3.2'
         # set default timeouts
         @connection_options = connection_options || Faraday::ConnectionOptions.new(
@@ -49,7 +51,7 @@ module Adyen
 
     # 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
 
@@ -58,8 +60,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
@@ -95,6 +96,9 @@ module Adyen
         when 'Transfers'
           url = "https://balanceplatform-api-#{@env}.adyen.com/btl"
           supports_live_url_prefix = false
+        when 'Capital'
+          url = "https://balanceplatform-api-#{@env}.adyen.com/capital"
+          supports_live_url_prefix = false
         when 'Management'
           url = "https://management-#{@env}.adyen.com"
           supports_live_url_prefix = false
@@ -152,7 +156,9 @@ module Adyen
       conn = Faraday.new(url, @connection_options) do |faraday|
         faraday.adapter @adapter, **@adapter_options
         faraday.headers['Content-Type'] = 'application/json'
-        faraday.headers['User-Agent'] = "#{Adyen::NAME}/#{Adyen::VERSION}"
+        user_agent = "#{Adyen::NAME}/#{Adyen::VERSION}"
+        user_agent = "#{@application_name} #{user_agent}" if @application_name && !@application_name.strip.empty?
+        faraday.headers['User-Agent'] = user_agent
 
         # set header based on auth_type and service
         auth_header(auth_type, faraday)
@@ -327,6 +333,10 @@ module Adyen
       @balance_control ||= Adyen::BalanceControl.new(self)
     end
 
+    def capital
+      @capital ||= Adyen::Capital.new(self)
+    end
+
   
     private
 

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

@@ -16,9 +16,7 @@ module Adyen
     #
     # Deprecated since Adyen Balance Control API v1
     def balance_transfer(request, headers: {})
-      endpoint = '/balanceTransfer'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint)
+      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,9 +14,7 @@ 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)
@@ -24,9 +22,7 @@ module Adyen
 
     # 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)
+      endpoint = build_endpoint('/balanceAccounts/{balanceAccountId}/sweeps', balance_account_id)
       
       action = { method: 'post', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
@@ -34,9 +30,7 @@ module Adyen
 
     # 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)
+      endpoint = build_endpoint('/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}', balance_account_id, sweep_id)
       
       action = { method: 'delete', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -44,9 +38,7 @@ module Adyen
 
     # 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 = build_endpoint('/balanceAccounts/{balanceAccountId}/sweeps', balance_account_id)
       endpoint += create_query_string(query_params)
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -54,9 +46,7 @@ module Adyen
 
     # 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 +54,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,9 +62,7 @@ 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)
@@ -84,9 +70,7 @@ module Adyen
 
     # 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)
+      endpoint = build_endpoint('/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}', balance_account_id, sweep_id)
       
       action = { method: 'get', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)
@@ -94,9 +78,7 @@ module Adyen
 
     # Update a balance account
     def update_balance_account(request, id, headers: {})
-      endpoint = '/balanceAccounts/{id}'.gsub(/{.+?}/, '%s')
-      endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, id)
+      endpoint = build_endpoint('/balanceAccounts/{id}', id)
       
       action = { method: 'patch', url: endpoint }
       @client.call_adyen_api(@service, action, request, headers, @version)
@@ -104,9 +86,7 @@ module Adyen
 
     # 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/{balanceAccountId}/sweeps/{sweepId}', balance_account_id, sweep_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)