fdx-api-sdk-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7a0b7b534fd3cfd4a9decab00d74e4b300eee2f644e6756285312d60bb7a32a
+  data.tar.gz: 0df2ac2d31ca903ca13ba7e479d8f05847c40347fc80b0c7edfa1731b2ed7011
+SHA512:
+  metadata.gz: 4069a58fa782425742ac0b74484788970821a3a431284a1f55189ddc71f00f9cdca9f97f6dbbd98ec11d8d089f1eff8d72f69cb20e65dd4568784863b1f23ba2
+  data.tar.gz: 2d19bd2b7dcc6ff668a825825095e1c718974a7dcda14c8f2ff9e16da6d435740c9c08ae64256b4725675d8e8781173bd1069bb63f43158cc0b36400014b3f7f

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2025 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,125 @@
+
+# Getting Started with FDX API
+
+## Introduction
+
+Financial Data Exchange V6.2.0 Consent API
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install fdx-api-sdk-ruby -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'fdx-api-sdk-ruby', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the fdx-api-sdk-ruby gem](https://rubygems.org/gems/fdx-api-sdk-ruby/versions/1.0.0).
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | `Environment` | 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/fdx-api-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/fdx-api-ruby-sdk/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+| tax_basic_auth_credentials | [`TaxBasicAuthCredentials`](https://www.github.com/sdks-io/fdx-api-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:
+
+```ruby
+require 'fdx_api'
+include FdxApi
+
+client = Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  tax_basic_auth_credentials: TaxBasicAuthCredentials.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
+    )
+  )
+)
+```
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)
+* [`TaxBasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/auth/basic-authentication.md)
+
+## List of APIs
+
+* [User Consent](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/user-consent.md)
+* [Account Information](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/account-information.md)
+* [Account Statements](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/account-statements.md)
+* [Account Transactions](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/account-transactions.md)
+* [Money Movement](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/money-movement.md)
+* [Personal Information](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/personal-information.md)
+* [Reward Program Categories](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/reward-program-categories.md)
+* [Reward Program Information](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/reward-program-information.md)
+* [Event Notifications](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/event-notifications.md)
+* [Fraud Notification](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/fraud-notification.md)
+* [Internal Transfers](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/internal-transfers.md)
+* [Payee Management](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/payee-management.md)
+* [Payment Initiation Parties](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/payment-initiation-parties.md)
+* [Recurring Payments](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/recurring-payments.md)
+* [Payroll Information](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/payroll-information.md)
+* [Submit Tax Forms](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/submit-tax-forms.md)
+* [Tax Forms](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/tax-forms.md)
+* [Resource Information](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/resource-information.md)
+* [Meta](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/meta.md)
+* [Payments](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/payments.md)
+* [Recipients](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/controllers/recipients.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [AbstractLogger](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/fdx-api-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/lib/fdx_api/api_helper.rb

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

data/lib/fdx_api/client.rb

@@ -0,0 +1,187 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  #  fdx_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Access to user_consent controller.
+    # @return [UserConsentController] Returns the controller instance.
+    def user_consent
+      @user_consent ||= UserConsentController.new @global_configuration
+    end
+
+    # Access to account_information controller.
+    # @return [AccountInformationController] Returns the controller instance.
+    def account_information
+      @account_information ||= AccountInformationController.new @global_configuration
+    end
+
+    # Access to account_statements controller.
+    # @return [AccountStatementsController] Returns the controller instance.
+    def account_statements
+      @account_statements ||= AccountStatementsController.new @global_configuration
+    end
+
+    # Access to account_transactions controller.
+    # @return [AccountTransactionsController] Returns the controller instance.
+    def account_transactions
+      @account_transactions ||= AccountTransactionsController.new @global_configuration
+    end
+
+    # Access to money_movement controller.
+    # @return [MoneyMovementController] Returns the controller instance.
+    def money_movement
+      @money_movement ||= MoneyMovementController.new @global_configuration
+    end
+
+    # Access to personal_information controller.
+    # @return [PersonalInformationController] Returns the controller instance.
+    def personal_information
+      @personal_information ||= PersonalInformationController.new @global_configuration
+    end
+
+    # Access to reward_program_categories controller.
+    # @return [RewardProgramCategoriesController] Returns the controller instance.
+    def reward_program_categories
+      @reward_program_categories ||= RewardProgramCategoriesController.new @global_configuration
+    end
+
+    # Access to reward_program_information controller.
+    # @return [RewardProgramInformationController] Returns the controller instance.
+    def reward_program_information
+      @reward_program_information ||= RewardProgramInformationController.new @global_configuration
+    end
+
+    # Access to event_notifications controller.
+    # @return [EventNotificationsController] Returns the controller instance.
+    def event_notifications
+      @event_notifications ||= EventNotificationsController.new @global_configuration
+    end
+
+    # Access to fraud_notification controller.
+    # @return [FraudNotificationController] Returns the controller instance.
+    def fraud_notification
+      @fraud_notification ||= FraudNotificationController.new @global_configuration
+    end
+
+    # Access to meta controller.
+    # @return [MetaController] Returns the controller instance.
+    def meta
+      @meta ||= MetaController.new @global_configuration
+    end
+
+    # Access to internal_transfers controller.
+    # @return [InternalTransfersController] Returns the controller instance.
+    def internal_transfers
+      @internal_transfers ||= InternalTransfersController.new @global_configuration
+    end
+
+    # Access to payee_management controller.
+    # @return [PayeeManagementController] Returns the controller instance.
+    def payee_management
+      @payee_management ||= PayeeManagementController.new @global_configuration
+    end
+
+    # Access to payment_initiation_parties controller.
+    # @return [PaymentInitiationPartiesController] Returns the controller instance.
+    def payment_initiation_parties
+      @payment_initiation_parties ||= PaymentInitiationPartiesController.new @global_configuration
+    end
+
+    # Access to payments controller.
+    # @return [PaymentsController] Returns the controller instance.
+    def payments
+      @payments ||= PaymentsController.new @global_configuration
+    end
+
+    # Access to recurring_payments controller.
+    # @return [RecurringPaymentsController] Returns the controller instance.
+    def recurring_payments
+      @recurring_payments ||= RecurringPaymentsController.new @global_configuration
+    end
+
+    # Access to payroll_information controller.
+    # @return [PayrollInformationController] Returns the controller instance.
+    def payroll_information
+      @payroll_information ||= PayrollInformationController.new @global_configuration
+    end
+
+    # Access to recipients controller.
+    # @return [RecipientsController] Returns the controller instance.
+    def recipients
+      @recipients ||= RecipientsController.new @global_configuration
+    end
+
+    # Access to submit_tax_forms controller.
+    # @return [SubmitTaxFormsController] Returns the controller instance.
+    def submit_tax_forms
+      @submit_tax_forms ||= SubmitTaxFormsController.new @global_configuration
+    end
+
+    # Access to tax_forms controller.
+    # @return [TaxFormsController] Returns the controller instance.
+    def tax_forms
+      @tax_forms ||= TaxFormsController.new @global_configuration
+    end
+
+    # Access to resource_information controller.
+    # @return [ResourceInformationController] Returns the controller instance.
+    def resource_information
+      @resource_information ||= ResourceInformationController.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,
+      bearer_auth_credentials: nil, tax_basic_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,
+                    bearer_auth_credentials: bearer_auth_credentials,
+                    tax_basic_auth_credentials: tax_basic_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[bearerAuth TaxBasicAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['bearerAuth'] = BearerAuth.new(http_client_config.bearer_auth_credentials)
+      @auth_managers['TaxBasicAuth'] = TaxBasicAuth.new(
+        http_client_config.tax_basic_auth_credentials
+      )
+    end
+  end
+end

data/lib/fdx_api/configuration.rb

@@ -0,0 +1,133 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      CONSENT = 'Consent'.freeze,
+      CORE = 'Core'.freeze,
+      CUSTOMER = 'Customer'.freeze,
+      EVENTNOTIFICATIONS = 'EventNotifications'.freeze,
+      FRAUD = 'Fraud'.freeze,
+      META = 'Meta'.freeze,
+      MONEYMOVEMENT = 'MoneyMovement'.freeze,
+      PAYROLL = 'Payroll'.freeze,
+      RECIPIENTREGISTRATION = 'RecipientRegistration'.freeze,
+      REGISTRY = 'Registry'.freeze,
+      USTAX = 'USTax'.freeze,
+      RESOURCE = 'Resource'.freeze
+    ].freeze
+  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, :bearer_auth_credentials,
+                :tax_basic_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,
+      bearer_auth_credentials: nil, tax_basic_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 OAuth 2 Bearer token credentials
+      @bearer_auth_credentials = bearer_auth_credentials
+
+      # The object holding Basic Authentication credentials
+      @tax_basic_auth_credentials = tax_basic_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, bearer_auth_credentials: nil,
+                   tax_basic_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
+      bearer_auth_credentials ||= self.bearer_auth_credentials
+      tax_basic_auth_credentials ||= self.tax_basic_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,
+                        bearer_auth_credentials: bearer_auth_credentials,
+                        tax_basic_auth_credentials: tax_basic_auth_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::CONSENT => 'https://financialdataexchange-prod.apigee.net/fdx-consent-api-v6.2.0',
+        Server::CORE => 'https://financialdataexchange-prod.apigee.net/fdx-core-api-v6.2.0',
+        Server::CUSTOMER => 'https://financialdataexchange-prod.apigee.net/fdx-customer-api-v6.2.0',
+        Server::EVENTNOTIFICATIONS => 'https://financialdataexchange-prod.apigee.net/fdx-event-notifications-api-v6.2.0',
+        Server::FRAUD => 'https://financialdataexchange-prod.apigee.net/fdx-fraud-api-v6.2.0',
+        Server::META => 'https://financialdataexchange-prod.apigee.net/fdx-meta-api-v6.2.0',
+        Server::MONEYMOVEMENT => 'https://financialdataexchange-prod.apigee.net/fdx-money-movement-api-v6.2.0',
+        Server::PAYROLL => 'https://financialdataexchange-prod.apigee.net/fdx-payroll-api-v6.2.0',
+        Server::RECIPIENTREGISTRATION => 'https://financialdataexchange-prod.apigee.net/fdx-recipient-registration-api-v6.1.0',
+        Server::REGISTRY => 'https://financialdataexchange-prod.apigee.net/fdx-registry-api-v6.1.0',
+        Server::USTAX => 'https://financialdataexchange-prod.apigee.net/fdx-tax-api-v6.1.0',
+        Server::RESOURCE => 'https://financialdataexchange-prod.apigee.net/fdx-resource-api-v6.1.0'
+      }
+    }.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::CONSENT)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/fdx_api/controllers/account_information_controller.rb

@@ -0,0 +1,135 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # AccountInformationController
+  class AccountInformationController < BaseController
+    # Return information for all of the customer's consented accounts or just
+    # those accounts identified in the `accountIds` request parameter. Use
+    # `ResultTypeQuery` parameter value of `lightweight` to retrieve minimal
+    # descriptive information and the `accountId` for each account. The
+    # `accountId` can then be used in the `getAccount` operation's path
+    # `/accounts/{accountId}` to retrieve full details about each account
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [Array[String]] account_ids Optional parameter: Comma separated
+    # list of account ids
+    # @param [Array[Date]] start_time Optional parameter: Start time for use in
+    # retrieval of transactions
+    # @param [Array[Date]] end_time Optional parameter: End time for use in
+    # retrieval of transactions
+    # @param [ResultType] result_type Optional parameter: Flag to indicate if
+    # you want a lightweight array of metadata (AccountDescriptor or Tax or
+    # Operations) or full item details (Account or a Tax subclass or
+    # Availability details). If set to 'lightweight', should only return the
+    # fields associated with the metadata entity. This field is not required,
+    # defaults to lightweight
+    # @param [String] offset Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records
+    # @param [Integer] limit Optional parameter: Number of elements that the
+    # consumer wishes to receive. Providers should implement reasonable
+    # default/maximum/minimum values based on their internal architecture and
+    # update their documentation accordingly
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_for_accounts(x_fapi_interaction_id,
+                            fdx_api_actor_type: nil,
+                            account_ids: nil,
+                            start_time: nil,
+                            end_time: nil,
+                            result_type: ResultType::LIGHTWEIGHT,
+                            offset: nil,
+                            limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts',
+                                     Server::CORE)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .query_param(new_parameter(account_ids, key: 'accountIds'))
+                   .query_param(new_parameter(start_time, key: 'startTime'))
+                   .query_param(new_parameter(end_time, key: 'endTime'))
+                   .query_param(new_parameter(result_type, key: 'resultType'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountsEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Start or end date value is not in the ISO 8601 format',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Data not found for request parameters',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Retrieve full details about the account identified by `{accountId}`
+    # parameter
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] account_id Required parameter: Account Identifier
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_account(x_fapi_interaction_id,
+                    account_id,
+                    fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{accountId}',
+                                     Server::CORE)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:AccountWithDetails),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'Account with id not found',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+  end
+end