apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/auth_supported_methods.rb

@@ -0,0 +1,94 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Metadata specifically related to which auth methods an institution supports.
+  class AuthSupportedMethods < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates if instant auth is supported.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :instant_auth
+
+    # Indicates if instant match is supported.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :instant_match
+
+    # Indicates if automated microdeposits are supported.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :automated_micro_deposits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['instant_auth'] = 'instant_auth'
+      @_hash['instant_match'] = 'instant_match'
+      @_hash['automated_micro_deposits'] = 'automated_micro_deposits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(instant_auth:, instant_match:, automated_micro_deposits:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @instant_auth = instant_auth
+      @instant_match = instant_match
+      @automated_micro_deposits = automated_micro_deposits
+      @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.
+      instant_auth = hash.key?('instant_auth') ? hash['instant_auth'] : nil
+      instant_match = hash.key?('instant_match') ? hash['instant_match'] : nil
+      automated_micro_deposits =
+        hash.key?('automated_micro_deposits') ? hash['automated_micro_deposits'] : nil
+
+      # 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.
+      AuthSupportedMethods.new(instant_auth: instant_auth,
+                               instant_match: instant_match,
+                               automated_micro_deposits: automated_micro_deposits,
+                               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} instant_auth: #{@instant_auth}, instant_match: #{@instant_match},"\
+      " automated_micro_deposits: #{@automated_micro_deposits}, 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} instant_auth: #{@instant_auth.inspect}, instant_match:"\
+      " #{@instant_match.inspect}, automated_micro_deposits: #{@automated_micro_deposits.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/automatically_verified_webhook.rb

@@ -0,0 +1,102 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when an Item is verified via automated micro-deposits. We recommend
+  # communicating to your users when this event is received to notify them that
+  # their account is verified and ready for use.
+  class AutomaticallyVerifiedWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `AUTH`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `AUTOMATICALLY_VERIFIED`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `account_id` of the account associated with the webhook
+    # @return [String]
+    attr_accessor :account_id
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash['account_id'] = 'account_id'
+      @_hash['item_id'] = 'item_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, account_id:, item_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @account_id = account_id
+      @item_id = item_id
+      @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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+
+      # 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.
+      AutomaticallyVerifiedWebhook.new(webhook_type: webhook_type,
+                                       webhook_code: webhook_code,
+                                       account_id: account_id,
+                                       item_id: item_id,
+                                       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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, account_id:"\
+      " #{@account_id}, item_id: #{@item_id}, 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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, account_id: #{@account_id.inspect}, item_id:"\
+      " #{@item_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/available_balance.rb

@@ -0,0 +1,39 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The sign of the available balance for the receiver bank account associated
+  # with the receiver event at the time the matching transaction was found. Can
+  # be `positive`, `negative`, or null if the balance was not available at the
+  # time.
+  class AvailableBalance
+    AVAILABLE_BALANCE = [
+      # TODO: Write general description for POSITIVE
+      POSITIVE = 'positive'.freeze,
+
+      # TODO: Write general description for NEGATIVE
+      NEGATIVE = 'negative'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = POSITIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'positive' then POSITIVE
+      when 'negative' then NEGATIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/bank_initiated_return_risk.rb

@@ -0,0 +1,96 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The object contains a risk score and a risk tier that evaluate the
+  # transaction return risk because an account is overdrawn or because an
+  # ineligible account is used. Common return codes in this category include:
+  # "R01", "R02", "R03", "R04", "R06", “R08”,  "R09", "R13", "R16", "R17",
+  # "R20", "R23". These returns have a turnaround time of 2 banking days.
+  class BankInitiatedReturnRisk < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A score from 0-99 that indicates the transaction return risk: a higher
+    # risk score suggests a higher return likelihood.
+    # @return [Integer]
+    attr_accessor :score
+
+    # In the `bank_initiated_return_risk` object, there are eight risk tiers
+    # corresponding to the scores:
+    #   1: Predicted bank-initiated return incidence rate between 0.0% - 0.5%
+    #   2: Predicted bank-initiated return incidence rate between 0.5% - 1.5%
+    #   3: Predicted bank-initiated return incidence rate between 1.5% - 3%
+    #   4: Predicted bank-initiated return incidence rate between 3% - 5%
+    #   5: Predicted bank-initiated return incidence rate between 5% - 10%
+    #   6: Predicted bank-initiated return incidence rate between 10% - 15%
+    #   7: Predicted bank-initiated return incidence rate between 15% and 50%
+    #   8: Predicted bank-initiated return incidence rate greater than 50%
+    # @return [Integer]
+    attr_accessor :risk_tier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['score'] = 'score'
+      @_hash['risk_tier'] = 'risk_tier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(score:, risk_tier:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @score = score
+      @risk_tier = risk_tier
+      @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.
+      score = hash.key?('score') ? hash['score'] : nil
+      risk_tier = hash.key?('risk_tier') ? hash['risk_tier'] : nil
+
+      # 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.
+      BankInitiatedReturnRisk.new(score: score,
+                                  risk_tier: risk_tier,
+                                  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} score: #{@score}, risk_tier: #{@risk_tier}, 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} score: #{@score.inspect}, risk_tier: #{@risk_tier.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer.rb

@@ -0,0 +1,263 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Represents a bank transfer within the Bank Transfers API.
+  class BankTransfer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plaid’s unique identifier for a bank transfer.
+    # @return [String]
+    attr_accessor :id
+
+    # Specifies the use case of the transfer.  Required for transfers on an ACH
+    # network.
+    # `"arc"` - Accounts Receivable Entry
+    # `"cbr`" - Cross Border Entry
+    # `"ccd"` - Corporate Credit or Debit - fund transfer between two corporate
+    # bank accounts
+    # `"cie"` - Customer Initiated Entry
+    # `"cor"` - Automated Notification of Change
+    # `"ctx"` - Corporate Trade Exchange
+    # `"iat"` - International
+    # `"mte"` - Machine Transfer Entry
+    # `"pbr"` - Cross Border Entry
+    # `"pop"` - Point-of-Purchase Entry
+    # `"pos"` - Point-of-Sale Entry
+    # `"ppd"` - Prearranged Payment or Deposit - the transfer is part of a
+    # pre-existing relationship with a consumer, eg. bill payment
+    # `"rck"` - Re-presented Check Entry
+    # `"tel"` - Telephone-Initiated Entry
+    # `"web"` - Internet-Initiated Entry - debits from a consumer’s account
+    # where their authorization is obtained over the Internet
+    # @return [AchClass]
+    attr_accessor :ach_class
+
+    # The account ID that should be credited/debited for this bank transfer.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The type of bank transfer. This will be either `debit` or `credit`.  A
+    # `debit` indicates a transfer of money into the origination account; a
+    # `credit` indicates a transfer of money out of the origination account.
+    # @return [BankTransferType]
+    attr_accessor :type
+
+    # The legal name and other information for the account holder.
+    # @return [BankTransferUser]
+    attr_accessor :user
+
+    # The amount of the bank transfer (decimal string with two digits of
+    # precision e.g. “10.00”).
+    # @return [String]
+    attr_accessor :amount
+
+    # The currency of the transfer amount, e.g. "USD"
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The description of the transfer.
+    # @return [String]
+    attr_accessor :description
+
+    # The datetime when this bank transfer was created. This will be of the form
+    # `2006-01-02T15:04:05Z`
+    # @return [DateTime]
+    attr_accessor :created
+
+    # The status of the transfer.
+    # @return [BankTransferStatus]
+    attr_accessor :status
+
+    # The network or rails used for the transfer. Valid options are `ach`,
+    # `same-day-ach`, or `wire`.
+    # @return [BankTransferNetwork]
+    attr_accessor :network
+
+    # When `true`, you can still cancel this bank transfer.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cancellable
+
+    # The failure reason if the type of this transfer is `"failed"` or
+    # `"reversed"`. Null value otherwise.
+    # @return [BankTransferFailure]
+    attr_accessor :failure_reason
+
+    # A string containing the custom tag provided by the client in the create
+    # request. Will be null if not provided.
+    # @return [String]
+    attr_accessor :custom_tag
+
+    # The Metadata object is a mapping of client-provided string fields to any
+    # string value. The following limitations apply:
+    # - The JSON values must be Strings (no nested JSON objects allowed)
+    # - Only ASCII characters may be used
+    # - Maximum of 50 key/value pairs
+    # - Maximum key length of 40 characters
+    # - Maximum value length of 500 characters
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # Plaid’s unique identifier for the origination account that was used for
+    # this transfer.
+    # @return [String]
+    attr_accessor :origination_account_id
+
+    # Indicates the direction of the transfer: `outbound` for API-initiated
+    # transfers, or `inbound` for payments received by the FBO account.
+    # @return [BankTransferDirection]
+    attr_accessor :direction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['ach_class'] = 'ach_class'
+      @_hash['account_id'] = 'account_id'
+      @_hash['type'] = 'type'
+      @_hash['user'] = 'user'
+      @_hash['amount'] = 'amount'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['description'] = 'description'
+      @_hash['created'] = 'created'
+      @_hash['status'] = 'status'
+      @_hash['network'] = 'network'
+      @_hash['cancellable'] = 'cancellable'
+      @_hash['failure_reason'] = 'failure_reason'
+      @_hash['custom_tag'] = 'custom_tag'
+      @_hash['metadata'] = 'metadata'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash['direction'] = 'direction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        custom_tag
+      ]
+    end
+
+    def initialize(id:, ach_class:, account_id:, type:, user:, amount:,
+                   iso_currency_code:, description:, created:, status:,
+                   network:, cancellable:, failure_reason:, custom_tag:,
+                   metadata:, origination_account_id:, direction:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @ach_class = ach_class
+      @account_id = account_id
+      @type = type
+      @user = user
+      @amount = amount
+      @iso_currency_code = iso_currency_code
+      @description = description
+      @created = created
+      @status = status
+      @network = network
+      @cancellable = cancellable
+      @failure_reason = failure_reason
+      @custom_tag = custom_tag
+      @metadata = metadata
+      @origination_account_id = origination_account_id
+      @direction = direction
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      ach_class = hash.key?('ach_class') ? hash['ach_class'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      user = BankTransferUser.from_hash(hash['user']) if hash['user']
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      created = if hash.key?('created')
+                  (DateTimeHelper.from_rfc3339(hash['created']) if hash['created'])
+                end
+      status = hash.key?('status') ? hash['status'] : nil
+      network = hash.key?('network') ? hash['network'] : nil
+      cancellable = hash.key?('cancellable') ? hash['cancellable'] : nil
+      failure_reason = BankTransferFailure.from_hash(hash['failure_reason']) if
+        hash['failure_reason']
+      custom_tag = hash.key?('custom_tag') ? hash['custom_tag'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      origination_account_id =
+        hash.key?('origination_account_id') ? hash['origination_account_id'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+
+      # 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.
+      BankTransfer.new(id: id,
+                       ach_class: ach_class,
+                       account_id: account_id,
+                       type: type,
+                       user: user,
+                       amount: amount,
+                       iso_currency_code: iso_currency_code,
+                       description: description,
+                       created: created,
+                       status: status,
+                       network: network,
+                       cancellable: cancellable,
+                       failure_reason: failure_reason,
+                       custom_tag: custom_tag,
+                       metadata: metadata,
+                       origination_account_id: origination_account_id,
+                       direction: direction,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_created
+      DateTimeHelper.to_rfc3339(created)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, ach_class: #{@ach_class}, account_id: #{@account_id}, type:"\
+      " #{@type}, user: #{@user}, amount: #{@amount}, iso_currency_code: #{@iso_currency_code},"\
+      " description: #{@description}, created: #{@created}, status: #{@status}, network:"\
+      " #{@network}, cancellable: #{@cancellable}, failure_reason: #{@failure_reason}, custom_tag:"\
+      " #{@custom_tag}, metadata: #{@metadata}, origination_account_id:"\
+      " #{@origination_account_id}, direction: #{@direction}, 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} id: #{@id.inspect}, ach_class: #{@ach_class.inspect}, account_id:"\
+      " #{@account_id.inspect}, type: #{@type.inspect}, user: #{@user.inspect}, amount:"\
+      " #{@amount.inspect}, iso_currency_code: #{@iso_currency_code.inspect}, description:"\
+      " #{@description.inspect}, created: #{@created.inspect}, status: #{@status.inspect},"\
+      " network: #{@network.inspect}, cancellable: #{@cancellable.inspect}, failure_reason:"\
+      " #{@failure_reason.inspect}, custom_tag: #{@custom_tag.inspect}, metadata:"\
+      " #{@metadata.inspect}, origination_account_id: #{@origination_account_id.inspect},"\
+      " direction: #{@direction.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_balance.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # BankTransferBalance Model.
+  class BankTransferBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total available balance - the sum of all successful debit transfer
+    # amounts minus all credit transfer amounts.
+    # @return [String]
+    attr_accessor :available
+
+    # The transactable balance shows the amount in your account that you are
+    # able to use for transfers, and is essentially your available balance minus
+    # your minimum balance.
+    # @return [String]
+    attr_accessor :transactable
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available'] = 'available'
+      @_hash['transactable'] = 'transactable'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(available:, transactable:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @available = available
+      @transactable = transactable
+      @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.
+      available = hash.key?('available') ? hash['available'] : nil
+      transactable = hash.key?('transactable') ? hash['transactable'] : nil
+
+      # 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.
+      BankTransferBalance.new(available: available,
+                              transactable: transactable,
+                              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} available: #{@available}, transactable: #{@transactable},"\
+      " 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} available: #{@available.inspect}, transactable: #{@transactable.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end