bk-apimatic-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 954682d807d726b7a325dabaa054658063aaa00d09af8f93240db63929995dcd
+  data.tar.gz: 72b1d8c04587d7a62504aa3a13b344d6d0eb877b99a147b7b9c0593de2e0528a
+SHA512:
+  metadata.gz: 1fa5a57fa39f05168ee7bb7c139f278ee5afe93f3d9c638860b1c383fb799c4e6e4343dad15b1fd11854cf008bf4cd453a290d9d89d43eb870aa8a3845c5e749
+  data.tar.gz: a14583ea1862d34cb37237d54a0527e5ff5767c4d673acf64f0c23542d65d1c4c953165c79d2bcfeae0cafe2e90ffc395edad08bb9ec36ac3acdc60405de5ba9

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,203 @@
+
+# Getting Started with Boku Direct Payments API
+
+## Introduction
+
+### API Security
+
+Security is a significant consideration for payment platforms. As part of the registration process for each registered merchant account, merchants receive a security key used to authenticate communications in either direction.
+
+Developers should consult the [Boku API Signature Authentication Guide](page:guides/api-signature-authentication-guide) for additional details with respect to implementing security on the Boku APIs.
+
+### API Usage
+
+When a consumer chooses to use a local payment-method (wallet), the consumer must go through an 'optin' flow to authenticate. This is accomplished using a redirect to the issuer's app or website where the consumer authenticates and completes the opt-in process.
+
+After the consumer adds their local payment-method (wallet), as their registered payment method, the 'charge' method is used to charge the consumer's local payment-method.
+
+If a customer decides to refund a transaction, the 'refund-charge' method can be used to refund the transaction.
+
+### API Versioning
+
+The Boku Payment Gateway API is versioned to provide support for changes to functionality without affecting existing integrations.  Each API URL includes version information that enables distinct functionality across different versions.
+
+There are several types of changes that could result in a new API version:
+
+1. New API functionality – new APIs, new parameters, additional information in responses, improved error reporting.
+2. Deprecated API functionality – deprecated APIs, deprecated parameters, deprecated error messages.
+3. Changes in functionality – existing functional behavior changes such as the returned result of a call. A warning is changed to an error.  Validation becomes stricter or more lenient.
+
+In these cases, Boku will release a new API version through a new endpoint(s). When new versions of existing APIs are added, support for existing versions is maintained.  Unless otherwise stated, as a rule, compatibility is maintained across versions.  Prior supported endpoints should have unchanged behavior. If an API is deprecated and scheduled to be removed, a notice of not less than 6 months will be given.  Requests for extensions to this period can be considered.
+
+Boku may make changes to the API within an existing version without changing the version number. An example of a non-versioning change would be the addition of an optional field to a request or to a response.
+
+### API Calls
+
+#### URL Scheme
+
+All the below API calls are against URLs that follow the pattern,
+
+`https://${api-node}.boku.com/${api-family}/${api-version}/${api-call}`
+
+Definitions for the above placeholders:
+
+* **api-node**: This follows the pattern '${country}-api4' (e.g. 'us-api4').
+  * 'country' is the two letter country code of the end-user's payment-method against which the call is made.
+  * The country code is required and is used for more efficient routing of the request.
+  * The country code in the url must match the country code supplied in the `optin-request`.`country` element.
+* **api-family**: Groups a family of related API methods.
+  * In this API, family is either one of:
+    * 'optin' - For interacting with the user or handset to obtain billing approval.
+    * 'billing' - For actually performing billing operations against the user.
+* **api-version**: In this version of the API, this value is always the string '3.0'.
+  * Calls under different version numbers may be used in the future to introduce non-compatible API changes.
+* **api-call**: The name particular API call or method to invoke, for example 'charge' or 'refund-charge'.
+  * This usually matches the XML root element name, sans the '-request' suffix.
+
+Fully qualified API call URLs are documented with each of the example calls detailed below.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install bk-apimatic-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'bk-apimatic-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the bk-apimatic-sdk gem](https://rubygems.org/gems/bk-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 'boku_direct_payments_api'
+include BokuDirectPaymentsApi
+```
+
+### 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/boku_direct_payments_api
+```
+
+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/
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| country | `String` | Country code in ISO 3166-1-alpha-2 standard<br>*Default*: `'gb'` |
+| environment | [`Environment`](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.MERCHANT_TEST_ENVIRONMENT`** |
+| 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: 60** |
+| 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/bk--ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'boku_direct_payments_api'
+include BokuDirectPaymentsApi
+
+client = Client.new(
+  environment: Environment::MERCHANT_TEST_ENVIRONMENT,
+  country: 'gb'
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'boku_direct_payments_api'
+include BokuDirectPaymentsApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/bk--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 |
+|  --- | --- |
+| MERCHANT_TEST_ENVIRONMENT | **Default** |
+| PRODUCTION_ENVIRONMENT | - |
+
+## List of APIs
+
+* [Consumer Registration](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/consumer-registration.md)
+* [Account Resources](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/account-resources.md)
+* [Config Resources](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/config-resources.md)
+* [Charge](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/charge.md)
+* [Refund](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/refund.md)
+* [Forex](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/forex.md)
+* [Fund-Check](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/fund-check.md)
+* [Seller of Record](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/controllers/seller-of-record.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/bk--ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/bk--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 'boku_direct_payments_api'
+
+puts 'BokuDirectPaymentsApi SDK loaded!'
+puts 'You can now create a client with: client = BokuDirectPaymentsApi::Client.new'
+puts 'Or use from_env: client = BokuDirectPaymentsApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/boku_direct_payments_api/api_helper.rb

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

data/lib/boku_direct_payments_api/client.rb

@@ -0,0 +1,99 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  #  boku_direct_payments_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to consumer_registration controller.
+    # @return [ConsumerRegistrationController] Returns the controller instance.
+    def consumer_registration
+      @consumer_registration ||= ConsumerRegistrationController.new @global_configuration
+    end
+
+    # Access to charge controller.
+    # @return [ChargeController] Returns the controller instance.
+    def charge
+      @charge ||= ChargeController.new @global_configuration
+    end
+
+    # Access to refund controller.
+    # @return [RefundController] Returns the controller instance.
+    def refund
+      @refund ||= RefundController.new @global_configuration
+    end
+
+    # Access to account_resources controller.
+    # @return [AccountResourcesController] Returns the controller instance.
+    def account_resources
+      @account_resources ||= AccountResourcesController.new @global_configuration
+    end
+
+    # Access to forex controller.
+    # @return [ForexController] Returns the controller instance.
+    def forex
+      @forex ||= ForexController.new @global_configuration
+    end
+
+    # Access to fund_check controller.
+    # @return [FundCheckController] Returns the controller instance.
+    def fund_check
+      @fund_check ||= FundCheckController.new @global_configuration
+    end
+
+    # Access to config_resources controller.
+    # @return [ConfigResourcesController] Returns the controller instance.
+    def config_resources
+      @config_resources ||= ConfigResourcesController.new @global_configuration
+    end
+
+    # Access to seller_of_record controller.
+    # @return [SellerOfRecordController] Returns the controller instance.
+    def seller_of_record
+      @seller_of_record ||= SellerOfRecordController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::MERCHANT_TEST_ENVIRONMENT, country: 'gb',
+      config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(connection: connection, adapter: adapter,
+                                    timeout: timeout, max_retries: max_retries,
+                                    retry_interval: retry_interval,
+                                    backoff_factor: backoff_factor,
+                                    retry_statuses: retry_statuses,
+                                    retry_methods: retry_methods,
+                                    http_callback: http_callback,
+                                    proxy_settings: proxy_settings,
+                                    environment: environment, country: country)
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

data/lib/boku_direct_payments_api/configuration.rb

@@ -0,0 +1,168 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      MERCHANT_TEST_ENVIRONMENT = 'Merchant Test Environment'.freeze,
+      PRODUCTION_ENVIRONMENT = 'Production Environment'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = MERCHANT_TEST_ENVIRONMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'merchant_test_environment' then MERCHANT_TEST_ENVIRONMENT
+      when 'production_environment' then PRODUCTION_ENVIRONMENT
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :country
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::MERCHANT_TEST_ENVIRONMENT, country: 'gb'
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings
+
+      # Current API environment
+      @environment = String(environment)
+
+      # Country code in ISO 3166-1-alpha-2 standard
+      @country = country
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, environment: nil, country: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      environment ||= self.environment
+      country ||= self.country
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        environment: environment, country: country)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::MERCHANT_TEST_ENVIRONMENT => {
+        Server::DEFAULT => 'https://{country}-api4-stage.boku.com'
+      },
+      Environment::PRODUCTION_ENVIRONMENT => {
+        Server::DEFAULT => 'https://{country}-api4.boku.com'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'country' => { 'value' => country, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'merchant_test_environment'))
+      country = ENV.fetch('COUNTRY', 'gb')
+      timeout = (ENV['TIMEOUT'] || 60).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      Configuration.new(
+        environment: environment,
+        country: country,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        proxy_settings: proxy_settings
+      )
+    end
+  end
+end

data/lib/boku_direct_payments_api/controllers/account_resources_controller.rb

@@ -0,0 +1,45 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # AccountResourcesController
+  class AccountResourcesController < BaseController
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of our payment product. Please disregard unless otherwise
+    # directed to include in your integration.**
+    # The account profile is designed to be a batch API (i.e. each call can
+    # request and return multiple account-profile records) but it can also be
+    # used for single account-profile record requests.
+    # For each input `selector` element in the request, there is always exactly
+    # one `record` element in the response even if no corresponding account
+    # profile was found. Each `record` element in the response contains the
+    # exact `selector` element from the request that was used to process that
+    # record. The ordering of elements in the response always corresponds
+    # directly to the ordering of elements in the request, i.e.
+    # response.records[42].selector equals request.selectors[42].
+    # @param [AccountProfileRequest] body Required parameter: TODO: type
+    # description here
+    # @return [AccountProfileResponse] Response from the API call.
+    def get_optin_account_profile(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/account/3.0/query-account-profile',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'Content-Type'))
+                   .xml_attributes(XmlAttributes.new
+                                                .value(body)
+                                                .root_element_name('account-profile-request'))
+                   .header_param(new_parameter('application/xml', key: 'accept'))
+                   .body_serializer(XmlUtilities.method(:serialize_to_xml)))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(AccountProfileResponse)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('account-profile-response')))
+        .execute
+    end
+  end
+end

data/lib/boku_direct_payments_api/controllers/base_controller.rb

@@ -0,0 +1,60 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    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