mt-sdk 0.0.1

data/lib/modern_treasury/configuration.rb

@@ -0,0 +1,206 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # An enum for SDK environments.
+  class Environment
+    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
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    def basic_auth_user_name
+      @basic_auth_credentials.username
+    end
+
+    def basic_auth_password
+      @basic_auth_credentials.password
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :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,
+      environment: Environment::PRODUCTION, basic_auth_user_name: nil,
+      basic_auth_password: nil, 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
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The username to use with basic authentication
+      @basic_auth_user_name = basic_auth_user_name
+
+      # The password to use with basic authentication
+      @basic_auth_password = basic_auth_password
+
+      # Initializing Basic Authentication credentials with the provided auth parameters
+      @basic_auth_credentials = create_auth_credentials_object(
+        basic_auth_user_name, basic_auth_password, 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, environment: nil,
+                   basic_auth_user_name: nil, basic_auth_password: nil,
+                   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
+      environment ||= self.environment
+      basic_auth_credentials = create_auth_credentials_object(
+        basic_auth_user_name, basic_auth_password,
+        basic_auth_credentials || self.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,
+                        environment: environment,
+                        basic_auth_credentials: basic_auth_credentials)
+    end
+
+    def create_auth_credentials_object(basic_auth_user_name,
+                                       basic_auth_password,
+                                       basic_auth_credentials)
+      return basic_auth_credentials if basic_auth_user_name.nil? && basic_auth_password.nil?
+
+      warn('The \'basic_auth_user_name\', \'basic_auth_password\' params are d'\
+           'eprecated. Use \'basic_auth_credentials\' param instead.')
+
+      unless basic_auth_credentials.nil?
+        return basic_auth_credentials.clone_with(
+          username: basic_auth_user_name,
+          password: basic_auth_password
+        )
+      end
+
+      BasicAuthCredentials.new(username: basic_auth_user_name,
+                               password: basic_auth_password)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'http://localhost:3000'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://app.moderntreasury.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
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      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,
+        proxy_settings: proxy_settings
+      )
+    end
+  end
+end

data/lib/modern_treasury/controllers/account_collection_flow_controller.rb

@@ -0,0 +1,130 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # AccountCollectionFlowController
+  class AccountCollectionFlowController < BaseController
+    # TODO: type endpoint description here
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @param [String] client_token Optional parameter: TODO: type description
+    # here
+    # @param [String] status Optional parameter: TODO: type description here
+    # @param [String] counterparty_id Optional parameter: TODO: type description
+    # here
+    # @param [String] external_account_id Optional parameter: TODO: type
+    # description here
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @return [Array[AccountCollectionFlow]] Response from the API call.
+    def list_account_collection_flows(per_page: nil,
+                                      client_token: nil,
+                                      status: nil,
+                                      counterparty_id: nil,
+                                      external_account_id: nil,
+                                      after_cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/account_collection_flows',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(client_token, key: 'client_token'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(counterparty_id, key: 'counterparty_id'))
+                   .query_param(new_parameter(external_account_id, key: 'external_account_id'))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountCollectionFlow.method(:from_hash))
+                    .is_response_array(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @param [AccountCollectionFlowCreateRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [AccountCollectionFlow] Response from the API call.
+    def create_account_collection_flow(idempotency_key: nil,
+                                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/account_collection_flows',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountCollectionFlow.method(:from_hash))
+                    .local_error('422',
+                                 'unsuccessful',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: id
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @return [AccountCollectionFlow] Response from the API call.
+    def get_account_collection_flow(id,
+                                    idempotency_key: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/account_collection_flows/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountCollectionFlow.method(:from_hash)))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: id
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @param [AccountCollectionFlowUpdateRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [AccountCollectionFlow] Response from the API call.
+    def update_account_collection_flow(id,
+                                       idempotency_key: nil,
+                                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/api/account_collection_flows/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountCollectionFlow.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException)
+                    .local_error('422',
+                                 'unsuccessful',
+                                 ErrorMessageException))
+        .execute
+    end
+  end
+end

data/lib/modern_treasury/controllers/account_detail_controller.rb

@@ -0,0 +1,131 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # AccountDetailController
+  class AccountDetailController < BaseController
+    # Get a list of account details for a single internal or external account.
+    # @param [AccountsTypeEnum] accounts_type Required parameter: Example:
+    # @param [String] account_id Required parameter: The ID of the account.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @return [Array[AccountDetail]] Response from the API call.
+    def list_account_details(accounts_type,
+                             account_id,
+                             after_cursor: nil,
+                             per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/{accounts_type}/{account_id}/account_details',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountDetail.method(:from_hash))
+                    .is_response_array(true))
+        .execute
+    end
+
+    # Create an account detail for an external account.
+    # @param [AccountsType1Enum] accounts_type Required parameter: Example:
+    # @param [String] account_id Required parameter: The ID of the account.
+    # @param [String] idempotency_key Optional parameter: This key should be
+    # something unique, preferably something like an UUID.
+    # @param [AccountDetailCreateRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [AccountDetail] Response from the API call.
+    def create_account_detail(accounts_type,
+                              account_id,
+                              idempotency_key: nil,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/{accounts_type}/{account_id}/account_details',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountDetail.method(:from_hash))
+                    .local_error('404',
+                                 'unsuccessful',
+                                 ErrorMessageException)
+                    .local_error('422',
+                                 'unsuccessful',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Get a single account detail for a single internal or external account.
+    # @param [AccountsTypeEnum] accounts_type Required parameter: Example:
+    # @param [String] account_id Required parameter: The ID of the account.
+    # @param [String] id Required parameter: The ID of the account detail.
+    # @return [AccountDetail] Response from the API call.
+    def get_account_detail(accounts_type,
+                           account_id,
+                           id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/{accounts_type}/{account_id}/account_details/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountDetail.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Delete a single account detail for an external account.
+    # @param [AccountsType1Enum] accounts_type Required parameter: Example:
+    # @param [String] account_id Required parameter: The ID of the account.
+    # @param [String] id Required parameter: The ID of the account detail.
+    # @return [void] Response from the API call.
+    def delete_account_detail(accounts_type,
+                              account_id,
+                              id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/api/{accounts_type}/{account_id}/account_details/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(accounts_type, key: 'accounts_type')
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+  end
+end

data/lib/modern_treasury/controllers/balance_report_controller.rb

@@ -0,0 +1,76 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # BalanceReportController
+  class BalanceReportController < BaseController
+    # Get all balance reports for a given internal account.
+    # @param [String] internal_account_id Required parameter: TODO: type
+    # description here
+    # @param [Date] as_of_date Optional parameter: The date of the balance
+    # report in local time.
+    # @param [BalanceReportType1Enum] balance_report_type Optional parameter:
+    # The specific type of balance report. One of `intraday`, `previous_day`,
+    # `real_time`, or `other`.
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @return [Array[BalanceReport]] Response from the API call.
+    def list_balance_reports(internal_account_id,
+                             as_of_date: nil,
+                             balance_report_type: nil,
+                             after_cursor: nil,
+                             per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/internal_accounts/{internal_account_id}/balance_reports',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(internal_account_id, key: 'internal_account_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(as_of_date, key: 'as_of_date'))
+                   .query_param(new_parameter(balance_report_type, key: 'balance_report_type'))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BalanceReport.method(:from_hash))
+                    .is_response_array(true)
+                    .local_error('403',
+                                 'forbidden',
+                                 ErrorMessageException))
+        .execute
+    end
+
+    # Get a single balance report for a given internal account.
+    # @param [String] internal_account_id Required parameter: TODO: type
+    # description here
+    # @param [String] id Required parameter: Either the unique identifier of the
+    # balance report or latest for the latest balance report.
+    # @return [BalanceReport] Response from the API call.
+    def get_balance_report(internal_account_id,
+                           id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/internal_accounts/{internal_account_id}/balance_reports/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(internal_account_id, key: 'internal_account_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BalanceReport.method(:from_hash))
+                    .local_error('404',
+                                 'not found',
+                                 ErrorMessageException))
+        .execute
+    end
+  end
+end

data/lib/modern_treasury/controllers/base_controller.rb

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

data/lib/modern_treasury/controllers/connection_controller.rb

@@ -0,0 +1,40 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ConnectionController
+  class ConnectionController < BaseController
+    # Get a list of all connections.
+    # @param [Integer] per_page Optional parameter: TODO: type description
+    # here
+    # @param [UUID | String] vendor_customer_id Optional parameter: An
+    # identifier assigned by the vendor to your organization.
+    # @param [String] entity Optional parameter: A string code representing the
+    # vendor (i.e. bank).
+    # @param [String] after_cursor Optional parameter: TODO: type description
+    # here
+    # @return [Array[Connection]] Response from the API call.
+    def list_connections(per_page: nil,
+                         vendor_customer_id: nil,
+                         entity: nil,
+                         after_cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/connections',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(vendor_customer_id, key: 'vendor_customer_id'))
+                   .query_param(new_parameter(entity, key: 'entity'))
+                   .query_param(new_parameter(after_cursor, key: 'after_cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basic_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Connection.method(:from_hash))
+                    .is_response_array(true))
+        .execute
+    end
+  end
+end