apimatic-ak-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6a94449d48e44a1f094ac91168e23a80e10a2665e51fda3df438ee583c0ce24
+  data.tar.gz: ce62dbba9555bea1eaa2d3983d372415d47449b43428b039334be8999bf02b9b
+SHA512:
+  metadata.gz: 2050e37cc0eb2ab392bd3cc23e8a6aaf929965b507b8e5846b49d905988953228df1e6aa135a79033e9b41d93d69f7cccf45bc0c89aae2fdc95a87fb8106f795
+  data.tar.gz: c14099d225ca6bddae0528dbd503d7fce2127a1c816e56f6f6f505a334ea4d53eb4d5bb5c0c3f28f17fc0170ac1c09cc22391368343736ba1a280caec568a88f

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,190 @@
+
+# Getting Started with Akoya
+
+## Introduction
+
+Akoya product APIs for data access. Default servers are set for the Akoya sandbox environment.
+
+Akoya APIs include the following updates:
+
+- v2.2.2
+  - Added mode query parameter to Account Information, Balances, Investments, and Transactions to support standard mode.
+  - Edited callouts for Account Holder endpoint
+- v2.2.1
+  - Fixed typo in `accountIds` query parameter for `/accounts-info`, `/balances`, `/accounts`
+  - Added security method for `Account holder information` to bear token. Missing method defaulted to basic auth.
+  - Added examples and descriptions to some schemas
+  - Added HTTP status `429` FDX error `1207`.
+- v2.2 Additions
+  - Added optional `x-akoya-interaction-type` header to all endpoints to specify if a request is part of a batch process
+  - Update of tags to organize endpoints by Akoya product
+  - `206` response added to `/accounts-info`, `/balances`, `/accounts`
+- v2.1 New Statements product and Customers product updated with additional endpoint, `Account holder information`.
+- v2.0 Launch of Akoya products: Account Info, Balances, Investments, Transactions, Payments, Customers.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-ak-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-ak-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-ak-sdk gem](https://rubygems.org/gems/apimatic-ak-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 'akoya'
+include Akoya
+```
+
+### 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/akoya
+```
+
+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/apimatic-ak-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/apimatic-ak-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: 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/apimatic-ak-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/apimatic-ak-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'akoya'
+include Akoya
+
+client = Client.new(
+  basic_auth_credentials: BasicAuthCredentials.new(
+    username: 'Username',
+    password: 'Password'
+  ),
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  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 'akoya'
+include Akoya
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-ak-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** Sandbox server |
+| ENVIRONMENT2 | Products server |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`basicAuth (Basic Authentication)`](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md)
+* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Accountinformation](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/accountinformation.md)
+* [Balances](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/balances.md)
+* [Customers](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/customers.md)
+* [Investments](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/investments.md)
+* [Payments](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/payments.md)
+* [Statements](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/statements.md)
+* [Transactions](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/transactions.md)
+* [Tokens](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/controllers/tokens.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-ak-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-ak-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 'akoya'
+
+puts 'Akoya SDK loaded!'
+puts 'You can now create a client with: client = Akoya::Client.new'
+puts 'Or use from_env: client = Akoya::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/akoya/api_helper.rb

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

data/lib/akoya/client.rb

@@ -0,0 +1,117 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  #  akoya client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to account_information controller.
+    # @return [AccountInformationController] Returns the controller instance.
+    def account_information
+      @account_information ||= AccountInformationController.new @global_configuration
+    end
+
+    # Access to balances controller.
+    # @return [BalancesController] Returns the controller instance.
+    def balances
+      @balances ||= BalancesController.new @global_configuration
+    end
+
+    # Access to customers controller.
+    # @return [CustomersController] Returns the controller instance.
+    def customers
+      @customers ||= CustomersController.new @global_configuration
+    end
+
+    # Access to investments controller.
+    # @return [InvestmentsController] Returns the controller instance.
+    def investments
+      @investments ||= InvestmentsController.new @global_configuration
+    end
+
+    # Access to payments controller.
+    # @return [PaymentsController] Returns the controller instance.
+    def payments
+      @payments ||= PaymentsController.new @global_configuration
+    end
+
+    # Access to statements controller.
+    # @return [StatementsController] Returns the controller instance.
+    def statements
+      @statements ||= StatementsController.new @global_configuration
+    end
+
+    # Access to transactions controller.
+    # @return [TransactionsController] Returns the controller instance.
+    def transactions
+      @transactions ||= TransactionsController.new @global_configuration
+    end
+
+    # Access to tokens controller.
+    # @return [TokensController] Returns the controller instance.
+    def tokens
+      @tokens ||= TokensController.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,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      basic_auth_credentials: nil, bearer_auth_credentials: nil, 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,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    basic_auth_credentials: basic_auth_credentials,
+                    bearer_auth_credentials: bearer_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseController.user_agent_parameters
+
+      @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,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[basicAuth bearerAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['basicAuth'] = BasicAuth.new(http_client_config.basic_auth_credentials)
+      @auth_managers['bearerAuth'] = BearerAuth.new(http_client_config.bearer_auth_credentials)
+    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/akoya/configuration.rb

@@ -0,0 +1,195 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Sandbox server
+    # ENVIRONMENT2: Products server
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'production' then PRODUCTION
+      when 'environment2' then ENVIRONMENT2
+
+      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,
+      DEFAULT1 = 'default1'.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?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'default' then DEFAULT
+      when 'default1' then DEFAULT1
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    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, :basic_auth_credentials, :bearer_auth_credentials
+
+    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,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      basic_auth_credentials: nil, bearer_auth_credentials: nil
+    )
+      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,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding Basic Authentication credentials
+      @basic_auth_credentials = basic_auth_credentials
+
+      # The object holding OAuth 2 Bearer token credentials
+      @bearer_auth_credentials = bearer_auth_credentials
+
+      # 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, logging_configuration: nil,
+                   environment: nil, basic_auth_credentials: nil,
+                   bearer_auth_credentials: 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
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      basic_auth_credentials ||= self.basic_auth_credentials
+      bearer_auth_credentials ||= self.bearer_auth_credentials
+
+      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,
+                        logging_configuration: logging_configuration,
+                        environment: environment,
+                        basic_auth_credentials: basic_auth_credentials,
+                        bearer_auth_credentials: bearer_auth_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://sandbox-products.ddp.akoya.com',
+        Server::DEFAULT1 => 'https://sandbox-idp.ddp.akoya.com'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://products.ddp.akoya.com',
+        Server::DEFAULT1 => 'https://idp.ddp.akoya.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)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      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
+
+      # === Authentication credentials ===
+      basic_auth_credentials = BasicAuthCredentials.from_env
+      bearer_auth_credentials = BearerAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        basic_auth_credentials: basic_auth_credentials,
+        bearer_auth_credentials: bearer_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/akoya/controllers/account_information_controller.rb

@@ -0,0 +1,93 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # AccountInformationController
+  class AccountInformationController < BaseController
+    # Get basic account information including accountId, masked account number,
+    # type, description, etc.
+    # To view the response schema, select the `200` response below. Then pick an
+    # option for annuity, deposit, insurance, investment, loan, and line of
+    # credit account types.
+    # For an example payload response, see the `200` example response below the
+    # `Try it` feature. The example is from a deposit account but all account
+    # types are supported by this endpoint.
+    # > 🛑
+    # >
+    # > The *id_token* should be used as the bearer token with this call.
+    # Use the `mode` query param to receive FDX-aligned, standardized data
+    # values (Beta). For example:
+    # `https://sandbox-products.ddp.akoya.com/accounts-info/v2/mikomo?mode=stand
+    # ard`
+    # `mode` is available in both sandbox and production.
+    # `mode` is supported by a subset of providers. Log into the [Data Recipient
+    # Hub](https://recipient.ddp.akoya.com/login) and click
+    # [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI)
+    # to view a list of all providers supporting the `mode` parameter.
+    # @param [String] version Required parameter: Akoya major version number. Do
+    # not use minor version numbers. For instance, use v2 and not v2.2
+    # @param [String] provider_id Required parameter: Id of provider
+    # @param [String] account_ids Optional parameter: Comma separated list of
+    # account ids
+    # @param [XAkoyaInteractionType] x_akoya_interaction_type Optional
+    # parameter: Optional but recommended header to include with each data
+    # request.  Allowed values are `user` or `batch`.  `user` indicates a
+    # request is prompted by an end-user action. `batch` indicates the request
+    # is part of a batch process.
+    # @param [Mode] mode Optional parameter: BETA. Default is raw. Use standard
+    # for FDX-aligned, standardized data values.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_accounts_info(version,
+                          provider_id,
+                          account_ids: ':accountId',
+                          x_akoya_interaction_type: nil,
+                          mode: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts-info/{version}/{providerId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(provider_id, key: 'providerId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(account_ids, key: 'accountIds'))
+                   .header_param(new_parameter(x_akoya_interaction_type, key: 'x-akoya-interaction-type'))
+                   .query_param(new_parameter(mode, key: 'mode'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AkoyaAccountInfoProduct.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 '401 - Invalid input',
+                                 ErrorEntityException)
+                    .local_error('401',
+                                 '602 - Customer not authorized',
+                                 ErrorEntityException)
+                    .local_error('404',
+                                 '701 - Account not found',
+                                 ErrorEntityException)
+                    .local_error('406',
+                                 '1203 - Content Type not Supported',
+                                 ErrorEntityException)
+                    .local_error('429',
+                                 '1207 - Too many requests',
+                                 ErrorEntityException)
+                    .local_error('500',
+                                 '500 - Internal server error',
+                                 ErrorEntityException)
+                    .local_error('501',
+                                 '1106 - Version not supported or not implemented',
+                                 ErrorEntityException)
+                    .local_error('503',
+                                 '503 - System is down for maintenance',
+                                 ErrorEntityException))
+        .execute
+    end
+  end
+end