fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/configuration.rb

@@ -0,0 +1,203 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Financial Data Exchange V6 API (Data Provider / FI host)
+    # ENVIRONMENT2: FDX Registry host
+    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,
+      AUTH_SERVER = 'auth server'.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 'auth_server' then AUTH_SERVER
+
+      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, :oauth_fapi1_advanced_credentials,
+                :oauth_fapi1_baseline_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,
+      oauth_fapi1_advanced_credentials: nil,
+      oauth_fapi1_baseline_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 Authorization Code Grant credentials
+      @oauth_fapi1_advanced_credentials = oauth_fapi1_advanced_credentials
+
+      # The object holding OAuth 2 Client Credentials Grant credentials
+      @oauth_fapi1_baseline_credentials = oauth_fapi1_baseline_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, oauth_fapi1_advanced_credentials: nil,
+                   oauth_fapi1_baseline_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
+      oauth_fapi1_advanced_credentials ||= self.oauth_fapi1_advanced_credentials
+      oauth_fapi1_baseline_credentials ||= self.oauth_fapi1_baseline_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,
+        oauth_fapi1_advanced_credentials: oauth_fapi1_advanced_credentials,
+        oauth_fapi1_baseline_credentials: oauth_fapi1_baseline_credentials,
+        tax_basic_auth_credentials: tax_basic_auth_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.fi.com/fdx/v6',
+        Server::AUTH_SERVER => 'https://auth.fi.com/fdx/v6'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://api.registryhost.com/fdx/v6',
+        Server::AUTH_SERVER => 'https://auth.fi.com/fdx/v6'
+      }
+    }.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 ===
+      oauth_fapi1_advanced_credentials = OauthFapi1AdvancedCredentials.from_env
+      oauth_fapi1_baseline_credentials = OauthFapi1BaselineCredentials.from_env
+      tax_basic_auth_credentials = TaxBasicAuthCredentials.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,
+        oauth_fapi1_advanced_credentials: oauth_fapi1_advanced_credentials,
+        oauth_fapi1_baseline_credentials: oauth_fapi1_baseline_credentials,
+        tax_basic_auth_credentials: tax_basic_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/fdx_v660_api/controllers/account_information_controller.rb

@@ -0,0 +1,181 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_client_public_key Optional parameter: Public key
+    # for data provider to encrypt sensitive response data
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @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. Deprecated in v6.5, transactions fields were
+    # deprecated by RFCs 0309 and 0367
+    # @param [Array[Date]] end_time Optional parameter: End time for use in
+    # retrieval of transactions. Deprecated in v6.5, transactions fields were
+    # deprecated by RFCs 0309 and 0367
+    # @param [Date] start_date Optional parameter: Start date for use in
+    # retrieval of transactions. Deprecated in v6.5, transactions fields were
+    # deprecated by RFCs 0309 and 0367
+    # @param [Date] end_date Optional parameter: End date for use in retrieval
+    # of transactions. Deprecated in v6.5, transactions fields were deprecated
+    # by RFCs 0309 and 0367
+    # @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. Deprecated in favor of
+    # PageKeyQuery, will be removed with a future major release
+    # @param [String] page_key Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records. Pagination can be implemented
+    # per provider's preference
+    # @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,
+                            fdx_api_client_public_key: nil,
+                            fdx_api_data_provider_id: nil,
+                            fdx_api_data_recipient_id: nil,
+                            account_ids: nil,
+                            start_time: nil,
+                            end_time: nil,
+                            start_date: nil,
+                            end_date: nil,
+                            result_type: ResultType::LIGHTWEIGHT,
+                            offset: nil,
+                            page_key: nil,
+                            limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts',
+                                     Server::DEFAULT)
+                   .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'))
+                   .header_param(new_parameter(fdx_api_client_public_key, key: 'FDX-API-Client-Public-Key'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .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(start_date, key: 'startDate'))
+                   .query_param(new_parameter(end_date, key: 'endDate'))
+                   .query_param(new_parameter(result_type, key: 'resultType'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .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',
+                                 '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
+
+    # Retrieve full details about the account identified by `{accountId}`
+    # parameter
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @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
+    # @param [String] fdx_api_client_public_key Optional parameter: Public key
+    # for data provider to encrypt sensitive response data
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @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,
+                    fdx_api_client_public_key: nil,
+                    fdx_api_data_provider_id: nil,
+                    fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{accountId}',
+                                     Server::DEFAULT)
+                   .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(fdx_api_client_public_key, key: 'FDX-API-Client-Public-Key'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .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

data/lib/fdx_v660_api/controllers/account_statements_controller.rb

@@ -0,0 +1,208 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # AccountStatementsController
+  class AccountStatementsController < BaseController
+    # Get account statements. Example: GET
+    # /accounts/{accountId}/statements?startTime=value1&endTime=value2
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @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
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [Date] start_time Optional parameter: Start time for use in
+    # retrieval of elements (ISO 8601). Will support filtering by time in a
+    # future major release. To support filtering by date only, see
+    # StartDateQuery
+    # @param [Date] end_time Optional parameter: End time for use in retrieval
+    # of elements (ISO 8601). Will support filtering by time in a future major
+    # release. To support filtering by date only, see EndDateQuery
+    # @param [Date] start_date Optional parameter: Start date for use in
+    # retrieval of elements (ISO 8601 format). Provider to define the date
+    # ranges and behaviors they will support. Example of defined behavior:   -
+    # Recipients need to either specify both start date and end date or neither.
+    #     If both start date and end date are not specified; default provided.
+    #   Default range: 7 Days of past data. (Today's date - 6 days both dates
+    # are inclusive)   - Recipient can specify the same start date and end date.
+    #     The returned data will reflect transactions from that date   - If
+    # start date and end date both are specified and if start date is later than
+    # end date,     return 'invalid date range' error code: 703, HTTPS 400 per
+    # the FDX spec   - If start Date and end date both are specified and if
+    # start date is older than what the Data Provider supports,     then the
+    # Data Provider should return 'invalid date range' error code: 703, HTTPS
+    # 400 per the FDX spec.     Example: If today is 5/14/2024 and the DP
+    # supports 24 months, the start date should be 5/14/2022 and newer;     it
+    # should not be 5/13/2022 or older   - If start date is specified but end
+    # date is not specified or vice versa;     Data Provider should return
+    # 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    # @param [Date] end_date Optional parameter: End date for use in retrieval
+    # of elements (ISO 8601 format). Provider to define the date ranges and
+    # behaviors they will support. Example of defined behavior:   - Recipients
+    # need to either specify both start date and end date or neither.     If
+    # both start date and end date are not specified; default provided.
+    # Default range: 7 Days of past data. (Today's date - 6 days both dates are
+    # inclusive)   - Recipient can specify the same start date and end date. The
+    # returned data will reflect transactions from that date   - If start date
+    # and end date both are specified and if start date is later than end date,
+    #    return 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    #   - If start Date and end date both are specified and if start date is
+    # older than what the Data Provider supports,     then the Data Provider
+    # should return 'invalid date range' error code: 703, HTTPS 400 per the FDX
+    # spec.     Example: If today is 5/14/2024 and the DP supports 24 months,
+    # the start date should be 5/14/2022 and newer;     it should not be
+    # 5/13/2022 or older   - If start date is specified but end date is not
+    # specified or vice versa;     Data Provider should return 'invalid date
+    # range' error code: 703, HTTPS 400 per the FDX spec   - If end date is
+    # today's date, the most recent transactions from the time the request is
+    # received will be returned
+    # @param [String] offset Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records. Deprecated in favor of
+    # PageKeyQuery, will be removed with a future major release
+    # @param [String] page_key Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records. Pagination can be implemented
+    # per provider's preference
+    # @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_account_statements(x_fapi_interaction_id,
+                                      account_id,
+                                      fdx_api_actor_type: nil,
+                                      fdx_api_data_provider_id: nil,
+                                      fdx_api_data_recipient_id: nil,
+                                      start_time: nil,
+                                      end_time: nil,
+                                      start_date: nil,
+                                      end_date: nil,
+                                      offset: nil,
+                                      page_key: nil,
+                                      limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{accountId}/statements',
+                                     Server::DEFAULT)
+                   .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(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .query_param(new_parameter(start_time, key: 'startTime'))
+                   .query_param(new_parameter(end_time, key: 'endTime'))
+                   .query_param(new_parameter(start_date, key: 'startDate'))
+                   .query_param(new_parameter(end_date, key: 'endDate'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnArrayOfStatements.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',
+                                 '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
+
+    # Gets an account statement image file. Use [HTTP Accept
+    # request-header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
+    # to specify desired content types. See ContentTypes definition for typical
+    # values
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] account_id Required parameter: Account Identifier
+    # @param [String] statement_id Required parameter: Statement Identifier
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_client_public_key Optional parameter: Public key
+    # for data provider to encrypt sensitive response data
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_account_statement(x_fapi_interaction_id,
+                              account_id,
+                              statement_id,
+                              fdx_api_actor_type: nil,
+                              fdx_api_client_public_key: nil,
+                              fdx_api_data_provider_id: nil,
+                              fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{accountId}/statements/{statementId}',
+                                     Server::DEFAULT)
+                   .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))
+                   .template_param(new_parameter(statement_id, key: 'statementId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_client_public_key, key: 'FDX-API-Client-Public-Key'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(StatementEncodedEntity1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Statement is processing and is not yet available',
+                                 ErrorException)
+                    .local_error('404',
+                                 'When account is present with no statements in it',
+                                 ErrorException)
+                    .local_error('406',
+                                 'Content Type not Supported',
+                                 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