dna-apimatic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d11d5009c8ff74b649a0c46999e1bcb77480c1270a99b2c37036701660e9346d
+  data.tar.gz: 97318444e193780588f19b2a3b686c6914e681e4a7ac19a1743a59207419d002
+SHA512:
+  metadata.gz: f9cabe0dd0d7ce53a16fff17930f485e0970b69390e3734d725f17d1cffd6674b40f81221ab7c3b8927a360ef1648fd2d8277e6b5ca85fb8f967569366df8a17
+  data.tar.gz: 7c924250aba308df43dd7b0e360ecbe3f9842cb9bf587eb1945dcb3dce3e4583003943250949a587d6a4448ac2380fafde03ac89eb458eb383c3aa54f87d344b

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,172 @@
+
+# Getting Started with DNA Payments Partner Reporting & Settlement APIs
+
+## Introduction
+
+Combined OpenAPI 3.0 specification for DNA Payments' Partner Tools: the Reporting API (Ecommerce & POS transaction reporting, Merchants) and the Settlement API. Generated from https://developer.dnapayments.com/docs/partner-tools/reporting/ documentation.
+
+NOTE: The 'Reference' page (https://developer.dnapayments.com/docs/partner-tools/reporting/reporting-api/ecommerce/reference) which defines the full canonical enumerations of Transaction Statuses, Transaction Types, and Payment Methods for the Ecommerce endpoints could not be retrieved (the page returned a redirect error). Fields that rely on that reference (status, type, paymentMethod, cardType on Ecommerce transactions) are therefore modeled as free-form strings with illustrative examples rather than strict enums. Supply that page's content to tighten these definitions.
+
+All URLs shown are the TEST/sandbox environment URLs published in the documentation; no production base URLs were provided in the source documentation.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install dna-apimatic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'dna-apimatic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the dna-apimatic-sdk gem](https://rubygems.org/gems/dna-apimatic-sdk/versions/0.0.1).
+
+## 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 'dna_payments_partner_reporting_settlement_ap_is'
+include DnaPaymentsPartnerReportingSettlementApIs
+```
+
+### 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/dna_payments_partner_reporting_settlement_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/dna-apimatic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/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/dna-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'dna_payments_partner_reporting_settlement_ap_is'
+include DnaPaymentsPartnerReportingSettlementApIs
+
+client = Client.new(
+  client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
+    oauth_client_id: 'OAuthClientId',
+    oauth_client_secret: 'OAuthClientSecret',
+    oauth_scopes: [
+      OauthScope::PARTNERS_REPORTING
+    ]
+  ),
+  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 'dna_payments_partner_reporting_settlement_ap_is'
+include DnaPaymentsPartnerReportingSettlementApIs
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/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** Test/Sandbox API server (Reporting & Settlement APIs) |
+| ENVIRONMENT2 | Test/Sandbox OAuth2 authorization server |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`BearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md)
+
+## List of APIs
+
+* [Ecommerce Transactions](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/ecommerce-transactions.md)
+* [POS Transactions](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/pos-transactions.md)
+* [Authentication](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/authentication.md)
+* [Merchants](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/merchants.md)
+* [Settlements](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/settlements.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/dna-apimatic-ruby-sdk/tree/0.0.1/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 'dna_payments_partner_reporting_settlement_ap_is'
+
+puts 'DnaPaymentsPartnerReportingSettlementApIs SDK loaded!'
+puts 'You can now create a client with: client = DnaPaymentsPartnerReportingSettlementApIs::Client.new'
+puts 'Or use from_env: client = DnaPaymentsPartnerReportingSettlementApIs::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/dna_payments_partner_reporting_settlement_ap_is/api_helper.rb

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

data/lib/dna_payments_partner_reporting_settlement_ap_is/apis/authentication_api.rb

@@ -0,0 +1,53 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # AuthenticationApi
+  class AuthenticationApi < BaseApi
+    # Prior to querying any Reporting or Settlement API endpoint, an access
+    # token must be obtained. This endpoint is shared by both the Reporting API
+    # and the Settlement API (both use the `partners_reporting` scope).
+    # @param [GrantType] grant_type Required parameter: Authorisation type
+    # required to confirm the action required.
+    # @param [Scope] scope Required parameter: Scope of the action to be
+    # performed with the credentials.
+    # @param [String] client_id Required parameter: Provided to the integrator
+    # following successful creation of a test account.
+    # @param [String] client_secret Required parameter: Provided to the
+    # integrator following successful creation of a test account.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_access_token(grant_type,
+                         scope,
+                         client_id,
+                         client_secret)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/oauth2/token',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(grant_type, key: 'grant_type')
+                                .is_required(true))
+                   .form_param(new_parameter(scope, key: 'scope')
+                                .is_required(true))
+                   .form_param(new_parameter(client_id, key: 'client_id')
+                                .is_required(true))
+                   .form_param(new_parameter(client_secret, key: 'client_secret')
+                                .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuthTokenResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request — request format is invalid.',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Unauthorized — invalid authentication credentials have been'\
+                                  ' supplied.',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/apis/base_api.rb

@@ -0,0 +1,67 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/apis/ecommerce_transactions_api.rb

@@ -0,0 +1,113 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # EcommerceTransactionsApi
+  class EcommerceTransactionsApi < BaseApi
+    # Query Ecommerce transactions processed by your merchants. Transactions are
+    # available for 365 days; a maximum span of 30 days can be specified per
+    # request via `from`/`to`.
+    # @param [DateTime] from Required parameter: Start date/time for
+    # transactions. Transactions are available for 365 days and a maximum of 30
+    # days can be specified per request. ISO 8601 format.
+    # @param [DateTime] to Required parameter: End date/time for transactions.
+    # Transactions are available for 365 days and a maximum of 30 days can be
+    # specified per request. ISO 8601 format.
+    # @param [Integer] page Optional parameter: Page number required.
+    # @param [Integer] size Optional parameter: Number of records to return.
+    # @param [String] merchant_id Optional parameter: Unique id(s) for the
+    # merchant, allocated by DNA Payments and returned in GET Merchants. Up to
+    # 10 IDs may be submitted, comma separated. Specifying an id will only
+    # return results for that merchant.
+    # @param [String] status Optional parameter: Filter by transaction status.
+    # Multiple statuses may be supplied, comma separated. See the Ecommerce
+    # Reference documentation for the full list of statuses (not available at
+    # spec-generation time).
+    # @param [Processor] processor Optional parameter: Filter transactions by
+    # the platform responsible for processing the transaction.
+    # @param [String] search_by Optional parameter: Allows filtering of
+    # transactions by the field used to match the from/to date range (as
+    # documented, this parameter mirrors the processor filtering behaviour
+    # described in the source docs).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_ecommerce_transactions(from,
+                                   to,
+                                   page: 1,
+                                   size: 50,
+                                   merchant_id: nil,
+                                   status: nil,
+                                   processor: nil,
+                                   search_by: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/partners/transactions',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(from, key: 'from')
+                                 .is_required(true))
+                   .query_param(new_parameter(to, key: 'to')
+                                 .is_required(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(size, key: 'size'))
+                   .query_param(new_parameter(merchant_id, key: 'merchantId'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(processor, key: 'processor'))
+                   .query_param(new_parameter(search_by, key: 'searchBy'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EcommerceTransactionsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request — request format is invalid.',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Unauthorized — invalid authentication credentials have been'\
+                                  ' supplied.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'Forbidden — authorisation has failed due to insufficient'\
+                                  ' permissions.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Query a single Ecommerce transaction processed by any of your merchants,
+    # using the transaction ID returned from a previous list query.
+    # @param [String] transaction_id Required parameter: Unique transaction ID,
+    # as returned by GET Transactions.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_ecommerce_transaction_by_id(transaction_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/partners/transactions/{transactionId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transactionId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EcommerceTransaction.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request — request format is invalid.',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Unauthorized — invalid authentication credentials have been'\
+                                  ' supplied.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'Forbidden — authorisation has failed due to insufficient'\
+                                  ' permissions.',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Not Found — the requested resource does not exist.',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/apis/merchants_api.rb

@@ -0,0 +1,79 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # MerchantsApi
+  class MerchantsApi < BaseApi
+    # Returns the merchants available to the authenticated partner.
+    # **Deprecated** — use V2 (`/v2/partners/merchants`) instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_v1
+      warn 'Endpoint get_merchants_v1 in MerchantsApi is deprecated'
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/partners/merchants',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MerchantV1.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Bad Request — request format is invalid.',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Unauthorized — invalid authentication credentials have been'\
+                                  ' supplied.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'Forbidden — authorisation has failed due to insufficient'\
+                                  ' permissions.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Returns the merchants available to the authenticated partner, including
+    # terminal configuration for each merchant. Supports pagination and
+    # filtering by processor.
+    # @param [Processor] processor Optional parameter: Filter merchants by the
+    # processor used for transactions.
+    # @param [Integer] page Optional parameter: Specifies which set of records
+    # to retrieve.
+    # @param [Integer] size Optional parameter: Specifies how many records per
+    # page will be returned.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_merchants_v2(processor: nil,
+                         page: 1,
+                         size: 1000)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/partners/merchants',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(processor, key: 'processor'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(size, key: 'size'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MerchantsV2Response.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request — request format is invalid.',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Unauthorized — invalid authentication credentials have been'\
+                                  ' supplied.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'Forbidden — authorisation has failed due to insufficient'\
+                                  ' permissions.',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/apis/oauth_authorization_api.rb

@@ -0,0 +1,44 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # OauthAuthorizationApi
+  class OauthAuthorizationApi < BaseApi
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def request_token(authorization,
+                      scope: nil,
+                      _field_parameters: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/oauth2/token',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter('client_credentials', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OauthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OauthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OauthProviderException))
+        .execute
+    end
+  end
+end