apimatic-plaid-sdk 0.0.1

data/lib/plaid/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['REQUEST_LOG_BODY']
+      log_headers = ENV['REQUEST_LOG_HEADERS']
+      headers_to_include = ENV['REQUEST_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['REQUEST_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['REQUEST_HEADERS_TO_UNMASK']
+      include_query_in_path = ENV['REQUEST_INCLUDE_QUERY_IN_PATH']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        REQUEST_LOG_BODY
+        REQUEST_LOG_HEADERS
+        REQUEST_HEADERS_TO_INCLUDE
+        REQUEST_HEADERS_TO_EXCLUDE
+        REQUEST_HEADERS_TO_UNMASK
+        REQUEST_INCLUDE_QUERY_IN_PATH
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['RESPONSE_LOG_BODY']
+      log_headers = ENV['RESPONSE_LOG_HEADERS']
+      headers_to_include = ENV['RESPONSE_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['RESPONSE_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['RESPONSE_HEADERS_TO_UNMASK']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        RESPONSE_LOG_BODY
+        RESPONSE_LOG_HEADERS
+        RESPONSE_HEADERS_TO_INCLUDE
+        RESPONSE_HEADERS_TO_EXCLUDE
+        RESPONSE_HEADERS_TO_UNMASK
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers ||= self.mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(
+        logger: logger,
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: request_logging_config,
+        response_logging_config: response_logging_config
+      )
+    end
+
+    def self.from_env
+      log_level = ENV['LOG_LEVEL']
+      mask_sensitive_headers = ENV['MASK_SENSITIVE_HEADERS']
+
+      new(
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: RequestLoggingConfiguration.from_env,
+        response_logging_config: ResponseLoggingConfiguration.from_env
+      )
+    end
+
+    def self.any_logging_configured?
+      RequestLoggingConfiguration.any_logging_configured? ||
+        ResponseLoggingConfiguration.any_logging_configured? ||
+        ENV.key?('LOG_LEVEL') ||
+        ENV.key?('MASK_SENSITIVE_HEADERS')
+    end
+  end
+end

data/lib/plaid/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/plaid/models/account.rb

@@ -0,0 +1,185 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A single account at a financial institution.
+  class Account < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plaid’s unique identifier for the account. This value will not change
+    # unless Plaid can't reconcile the account with the data returned by the
+    # financial institution. This may occur, for example, when the name of the
+    # account changes. If this happens a new `account_id` will be assigned to
+    # the account.
+    # The `account_id` can also change if the `access_token` is deleted and the
+    # same credentials that were used to generate that `access_token` are used
+    # to generate a new `access_token` on a later date. In that case, the new
+    # `account_id` will be different from the old `account_id`.
+    # If an account with a specific `account_id` disappears instead of changing,
+    # the account is likely closed. Closed accounts are not returned by the
+    # Plaid API.
+    # Like all Plaid identifiers, the `account_id` is case sensitive.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A set of fields describing the balance for an account. Balance information
+    # may be cached unless the balance object was returned by
+    # `/accounts/balance/get`.
+    # @return [AccountBalance]
+    attr_accessor :balances
+
+    # The last 2-4 alphanumeric characters of an account's official account
+    # number. Note that the mask may be non-unique between an Item's accounts,
+    # and it may also not match the mask that the bank displays to the user.
+    # @return [String]
+    attr_accessor :mask
+
+    # The name of the account, either assigned by the user or by the financial
+    # institution itself
+    # @return [String]
+    attr_accessor :name
+
+    # The official name of the account as given by the financial institution
+    # @return [String]
+    attr_accessor :official_name
+
+    # `investment:` Investment account
+    # `credit:` Credit card
+    # `depository:` Depository account
+    # `loan:` Loan account
+    # `brokerage`: An investment account. Used for `/assets/` endpoints only;
+    # other endpoints use `investment`.
+    # `other:` Non-specified account type
+    # See the [Account type
+    # schema](https://plaid.com/docs/api/accounts#account-type-schema) for a
+    # full listing of account types and corresponding subtypes.
+    # @return [AccountType]
+    attr_accessor :type
+
+    # See the [Account type
+    # schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a
+    # full listing of account types and corresponding subtypes.
+    # @return [AccountSubtype]
+    attr_accessor :subtype
+
+    # The current verification status of an Auth Item initiated through
+    # Automated or Manual micro-deposits.  Returned for Auth Items only.
+    # `pending_automatic_verification`: The Item is pending automatic
+    # verification
+    # `pending_manual_verification`: The Item is pending manual micro-deposit
+    # verification. Items remain in this state until the user successfully
+    # verifies the two amounts.
+    # `automatically_verified`: The Item has successfully been automatically
+    # verified	
+    # `manually_verified`: The Item has successfully been manually verified
+    # `verification_expired`: Plaid was unable to automatically verify the
+    # deposit within 7 calendar days and will no longer attempt to validate the
+    # Item. Users may retry by submitting their information again through Link.
+    # `verification_failed`: The Item failed manual micro-deposit verification
+    # because the user exhausted all 3 verification attempts. Users may retry by
+    # submitting their information again through Link.
+    # @return [VerificationStatus4]
+    attr_accessor :verification_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['balances'] = 'balances'
+      @_hash['mask'] = 'mask'
+      @_hash['name'] = 'name'
+      @_hash['official_name'] = 'official_name'
+      @_hash['type'] = 'type'
+      @_hash['subtype'] = 'subtype'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        verification_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mask
+        official_name
+      ]
+    end
+
+    def initialize(account_id:, balances:, mask:, name:, official_name:, type:,
+                   subtype:, verification_status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @balances = balances
+      @mask = mask
+      @name = name
+      @official_name = official_name
+      @type = type
+      @subtype = subtype
+      @verification_status = verification_status unless verification_status == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      balances = AccountBalance.from_hash(hash['balances']) if hash['balances']
+      mask = hash.key?('mask') ? hash['mask'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      official_name = hash.key?('official_name') ? hash['official_name'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      subtype = hash.key?('subtype') ? hash['subtype'] : nil
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Account.new(account_id: account_id,
+                  balances: balances,
+                  mask: mask,
+                  name: name,
+                  official_name: official_name,
+                  type: type,
+                  subtype: subtype,
+                  verification_status: verification_status,
+                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, balances: #{@balances}, mask: #{@mask}, name:"\
+      " #{@name}, official_name: #{@official_name}, type: #{@type}, subtype: #{@subtype},"\
+      " verification_status: #{@verification_status}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, balances: #{@balances.inspect}, mask:"\
+      " #{@mask.inspect}, name: #{@name.inspect}, official_name: #{@official_name.inspect}, type:"\
+      " #{@type.inspect}, subtype: #{@subtype.inspect}, verification_status:"\
+      " #{@verification_status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/account_access.rb

@@ -0,0 +1,89 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Allow or disallow product access by account. Unlisted (e.g. missing)
+  # accounts will be considered `new_accounts`.
+  class AccountAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique account identifier for this account. This value must match that
+    # returned by the data access API for this account.
+    # @return [String]
+    attr_accessor :unique_id
+
+    # Allow the application to see this account (and associated details,
+    # including balance) in the list of accounts. If unset, defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :authorized
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['unique_id'] = 'unique_id'
+      @_hash['authorized'] = 'authorized'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authorized
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        authorized
+      ]
+    end
+
+    def initialize(unique_id:, authorized: true, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @unique_id = unique_id
+      @authorized = authorized unless authorized == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      unique_id = hash.key?('unique_id') ? hash['unique_id'] : nil
+      authorized = hash['authorized'] ||= true
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountAccess.new(unique_id: unique_id,
+                        authorized: authorized,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} unique_id: #{@unique_id}, authorized: #{@authorized},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} unique_id: #{@unique_id.inspect}, authorized: #{@authorized.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end