adyen-apimatic-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a5f3bdb667c68612f3625c59f0607ebb266e074dbedb5542a865a3b5fc66028
+  data.tar.gz: ce67edc51133bc75b85a071075566dd8981112511d6fcaba31fdb867257230ce
+SHA512:
+  metadata.gz: f49c8b28197c1627757cb481d64bcc595065ef1f046033c535cf489c30f97b798f8d48aa67c71e1ac0fdf6264a53a2715fa6efbba0acb2e738467511784b2a14
+  data.tar.gz: 6c377d9db0f288f17b24c83e4248056c21f4a6ff79a55527444f75b281d750bb07817a6b2e3a2cb629431db258d37153035d760be75a6d1bb1840931d3ae6e64

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,288 @@
+
+# Getting Started with Adyen APIs
+
+## Introduction
+
+Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).
+
+This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).
+
+### Authentication
+
+Each request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:
+
+```
+curl
+-H "Content-Type: application/json" \
+-H "X-API-Key: YOUR_API_KEY" \
+...
+```
+
+### Versioning
+
+Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
+
+For example:
+
+```
+https://checkout-test.adyen.com/v71/payments
+```
+
+### Server-side API libraries
+
+We provide open-source [server-side API libraries](https://docs.adyen.com/development-resources/libraries/) in several languages:
+
+- PHP
+- Java
+- Node.js
+- .NET
+- Go
+- Python
+- Ruby
+- Apex (beta)
+
+See our [integration examples](https://github.com/adyen-examples#%EF%B8%8F-official-integration-examples) for example uses of the libraries.
+
+### Developer resources
+
+Checkout API is available through a Postman collection. Click the button below to create a fork, then set the environment variables at **Environments** > **Adyen APIs**.
+
+[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/25716737-46ad970e-dc9e-4246-bac2-769c6083e7b5?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D25716737-46ad970e-dc9e-4246-bac2-769c6083e7b5%26entityType%3Dcollection%26workspaceId%3Da8d63f9f-cfc7-4810-90c5-9e0c60030d3e#?env%5BAdyen%20APIs%5D=W3sia2V5IjoiWC1BUEktS2V5IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0In0seyJrZXkiOiJZT1VSX01FUkNIQU5UX0FDQ09VTlQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0In0seyJrZXkiOiJZT1VSX0NPTVBBTllfQUNDT1VOVCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifSx7ImtleSI6IllPVVJfQkFMQU5DRV9QTEFURk9STSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifV0=)
+
+### Going live
+
+To access the live endpoints, you need an API key from your live Customer Area.
+
+The live endpoint URLs contain a prefix which is unique to your company account, for example:
+
+```
+https://{PREFIX}-checkout-live.adyenpayments.com/checkout/v71/payments
+```
+
+Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.
+
+When preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.
+
+### Release notes
+
+Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=71) to find out what changed in this version!, Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.
+
+### Authentication
+
+Each request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value.
+
+To access the live endpoints, you need to generate a new API key in your live Customer Area.
+
+### Versioning
+
+Management API handles versioning as part of the endpoint URL. For example, to send a request to this version of the `/companies/{companyId}/webhooks` endpoint, use:
+
+```text
+https://management-test.adyen.com/v3/companies/{companyId}/webhooks
+```
+
+### Going live
+
+To access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:
+
+```text
+https://management-live.adyen.com/v3
+```
+
+### Release notes
+
+Have a look at the [release notes](https://docs.adyen.com/release-notes/management-api) to find out what changed in this version!
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install adyen-apimatic-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'adyen-apimatic-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the adyen-apimatic-sdk gem](https://rubygems.org/gems/adyen-apimatic-sdk/versions/1.0.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'adyen_ap_is'
+include AdyenApIs
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/adyen_ap_is
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| api_key_auth_credentials | [`ApiKeyAuthCredentials`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'adyen_ap_is'
+include AdyenApIs
+
+client = Client.new(
+  api_key_auth_credentials: ApiKeyAuthCredentials.new(
+    x_api_key: 'X-API-Key'
+  ),
+  basic_auth_credentials: BasicAuthCredentials.new(
+    username: 'Username',
+    password: 'Password'
+  ),
+  environment: Environment::PRODUCTION,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'adyen_ap_is'
+include AdyenApIs
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`ApiKeyAuth (Custom Header Signature)`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/auth/basic-authentication.md)
+
+## List of APIs
+
+* [Paymentlinks](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/paymentlinks.md)
+* [Account-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/account-companylevel.md)
+* [Account-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/account-merchantlevel.md)
+* [Account-Storelevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/account-storelevel.md)
+* [Payoutsettings-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/payoutsettings-merchantlevel.md)
+* [Users-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/users-companylevel.md)
+* [Users-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/users-merchantlevel.md)
+* [My AP Icredential](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/my-ap-icredential.md)
+* [AP Icredentials-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/ap-icredentials-companylevel.md)
+* [AP Icredentials-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/ap-icredentials-merchantlevel.md)
+* [AP Ikey-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/ap-ikey-companylevel.md)
+* [AP Ikey-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/ap-ikey-merchantlevel.md)
+* [Clientkey-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/clientkey-companylevel.md)
+* [Clientkey-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/clientkey-merchantlevel.md)
+* [Allowedorigins-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/allowedorigins-companylevel.md)
+* [Allowedorigins-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/allowedorigins-merchantlevel.md)
+* [Webhooks-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/webhooks-companylevel.md)
+* [Webhooks-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/webhooks-merchantlevel.md)
+* [Paymentmethods-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/paymentmethods-merchantlevel.md)
+* [Terminals-Terminallevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminals-terminallevel.md)
+* [Terminalactions-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalactions-companylevel.md)
+* [Terminalactions-Terminallevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalactions-terminallevel.md)
+* [Terminalorders-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalorders-companylevel.md)
+* [Terminalorders-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalorders-merchantlevel.md)
+* [Terminalsettings-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalsettings-companylevel.md)
+* [Terminalsettings-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalsettings-merchantlevel.md)
+* [Terminalsettings-Storelevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalsettings-storelevel.md)
+* [Terminalsettings-Terminallevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminalsettings-terminallevel.md)
+* [Androidfiles-Companylevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/androidfiles-companylevel.md)
+* [Splitconfiguration-Merchantlevel](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/splitconfiguration-merchantlevel.md)
+* [Payments](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/payments.md)
+* [Donations](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/donations.md)
+* [Modifications](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/modifications.md)
+* [Recurring](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/recurring.md)
+* [Orders](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/orders.md)
+* [Utility](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/utility.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/adyen-apimatic-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'adyen_ap_is'
+
+puts 'AdyenApIs SDK loaded!'
+puts 'You can now create a client with: client = AdyenApIs::Client.new'
+puts 'Or use from_env: client = AdyenApIs::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/adyen_ap_is/api_helper.rb

@@ -0,0 +1,10 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/adyen_ap_is/apis/account_company_level_api.rb

@@ -0,0 +1,147 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # AccountCompanyLevelApi
+  class AccountCompanyLevelApi < BaseApi
+    # Returns the list of company accounts that your API credential has access
+    # to. The list is grouped into pages as defined by the query parameters.
+    # To make this request, your API credential must have the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Account read
+    # @param [Integer] page_number Optional parameter: The number of the page to
+    # fetch.
+    # @param [Integer] page_size Optional parameter: The number of items to have
+    # on a page, maximum 100. The default is 10 items on a page.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_companies(page_number: nil,
+                      page_size: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/companies',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(page_number, key: 'pageNumber'))
+                   .query_param(new_parameter(page_size, key: 'pageSize'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListCompanyResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Returns the company account specified in the path. Your API credential
+    # must have access to the company account.
+    # To make this request, your API credential must have the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Account read
+    # @param [String] company_id Required parameter: The unique identifier of
+    # the company account.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_companies_company_id(company_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/companies/{companyId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(company_id, key: 'companyId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Company2.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+
+    # Returns the list of merchant accounts under the company account specified
+    # in the path. The list only includes merchant accounts that your API
+    # credential has access to. The list is grouped into pages as defined by the
+    # query parameters.
+    # To make this request, your API credential must have the following
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#api-p
+    # ermissions):
+    # * Management API—Account read
+    # @param [String] company_id Required parameter: The unique identifier of
+    # the company account.
+    # @param [Integer] page_number Optional parameter: The number of the page to
+    # fetch.
+    # @param [Integer] page_size Optional parameter: The number of items to have
+    # on a page, maximum 100. The default is 10 items on a page.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_companies_company_id_merchants(company_id,
+                                           page_number: nil,
+                                           page_size: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/companies/{companyId}/merchants',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(company_id, key: 'companyId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page_number, key: 'pageNumber'))
+                   .query_param(new_parameter(page_size, key: 'pageSize'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('BasicAuth', 'ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListMerchantResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - a problem reading or understanding the request.',
+                                 RestServiceErrorException)
+                    .local_error('401',
+                                 'Unauthorized - authentication required.',
+                                 RestServiceErrorException)
+                    .local_error('403',
+                                 'Forbidden - insufficient permissions to process the request.',
+                                 RestServiceErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity - a request validation error.',
+                                 RestServiceErrorException)
+                    .local_error('500',
+                                 'Internal Server Error - the server could not process the'\
+                                  ' request.',
+                                 RestServiceErrorException))
+        .execute
+    end
+  end
+end