apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/old_payment_status.rb

@@ -0,0 +1,73 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The previous status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is
+  # the initial state of all payments. It indicates that the payment is waiting
+  # on user input to continue processing. A payment may re-enter this state
+  # later on if further input is needed. `PAYMENT_STATUS_PROCESSING`: The
+  # payment is currently being processed. The payment will automatically exit
+  # this state when processing is complete. `PAYMENT_STATUS_INITIATED`: The
+  # payment has been successfully initiated and is considered complete.
+  # `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been
+  # successfully established. This state is only used for standing orders.
+  # `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to
+  # insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be
+  # initiated. This error is retryable once the root cause is resolved.
+  # `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable
+  # error. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
+  class OldPaymentStatus
+    OLD_PAYMENT_STATUS = [
+      # TODO: Write general description for PAYMENT_STATUS_INPUT_NEEDED
+      PAYMENT_STATUS_INPUT_NEEDED = 'PAYMENT_STATUS_INPUT_NEEDED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_PROCESSING
+      PAYMENT_STATUS_PROCESSING = 'PAYMENT_STATUS_PROCESSING'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_INITIATED
+      PAYMENT_STATUS_INITIATED = 'PAYMENT_STATUS_INITIATED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_COMPLETED
+      PAYMENT_STATUS_COMPLETED = 'PAYMENT_STATUS_COMPLETED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_INSUFFICIENT_FUNDS
+      PAYMENT_STATUS_INSUFFICIENT_FUNDS = 'PAYMENT_STATUS_INSUFFICIENT_FUNDS'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_FAILED
+      PAYMENT_STATUS_FAILED = 'PAYMENT_STATUS_FAILED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_BLOCKED
+      PAYMENT_STATUS_BLOCKED = 'PAYMENT_STATUS_BLOCKED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_UNKNOWN
+      PAYMENT_STATUS_UNKNOWN = 'PAYMENT_STATUS_UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PAYMENT_STATUS_INPUT_NEEDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payment_status_input_needed' then PAYMENT_STATUS_INPUT_NEEDED
+      when 'payment_status_processing' then PAYMENT_STATUS_PROCESSING
+      when 'payment_status_initiated' then PAYMENT_STATUS_INITIATED
+      when 'payment_status_completed' then PAYMENT_STATUS_COMPLETED
+      when 'payment_status_insufficient_funds' then PAYMENT_STATUS_INSUFFICIENT_FUNDS
+      when 'payment_status_failed' then PAYMENT_STATUS_FAILED
+      when 'payment_status_blocked' then PAYMENT_STATUS_BLOCKED
+      when 'payment_status_unknown' then PAYMENT_STATUS_UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/override_account_type.rb

@@ -0,0 +1,56 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # `investment:` Investment account `credit:` Credit card `depository:`
+  # Depository account `loan:` Loan account `payroll:` Payroll acccount `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.
+  class OverrideAccountType
+    OVERRIDE_ACCOUNT_TYPE = [
+      # TODO: Write general description for INVESTMENT
+      INVESTMENT = 'investment'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for DEPOSITORY
+      DEPOSITORY = 'depository'.freeze,
+
+      # TODO: Write general description for LOAN
+      LOAN = 'loan'.freeze,
+
+      # TODO: Write general description for PAYROLL
+      PAYROLL = 'payroll'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INVESTMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'investment' then INVESTMENT
+      when 'credit' then CREDIT
+      when 'depository' then DEPOSITORY
+      when 'loan' then LOAN
+      when 'payroll' then PAYROLL
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/override_accounts.rb

@@ -0,0 +1,230 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Data to use to set values of test accounts. Some values cannot be specified
+  # in the schema and will instead will be calculated from other test data in
+  # order to achieve more consistent, realistic test data.
+  class OverrideAccounts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `investment:` Investment account
+    # `credit:` Credit card
+    # `depository:` Depository account
+    # `loan:` Loan account
+    # `payroll:` Payroll acccount
+    # `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 [OverrideAccountType]
+    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
+
+    # If provided, the account will start with this amount as the current
+    # balance.
+    # @return [Float]
+    attr_accessor :starting_balance
+
+    # If provided, the account will always have this amount as its  available
+    # balance, regardless of current balance or changes in transactions over
+    # time.
+    # @return [Float]
+    attr_accessor :force_available_balance
+
+    # ISO-4217 currency code. If provided, the account will be denominated in
+    # the given currency. Transactions will also be in this currency by default.
+    # @return [String]
+    attr_accessor :currency
+
+    # Allows specifying the metadata of the test account
+    # @return [Meta]
+    attr_accessor :meta
+
+    # Account and bank identifier number data used to configure the test
+    # account. All values are optional.
+    # @return [Numbers]
+    attr_accessor :numbers
+
+    # Specify the list of transactions on the account.
+    # @return [Array[TransactionOverride]]
+    attr_accessor :transactions
+
+    # Specify the holdings on the account.
+    # @return [HoldingsOverride]
+    attr_accessor :holdings
+
+    # Specify the list of investments transactions on the account.
+    # @return [InvestmentsTransactionsOverride]
+    attr_accessor :investment_transactions
+
+    # Data about the owner or owners of an account. Any fields not specified
+    # will be filled in with default Sandbox information.
+    # @return [OwnerOverride]
+    attr_accessor :identity
+
+    # Used to configure Sandbox test data for the Liabilities product
+    # @return [LiabilityOverride]
+    attr_accessor :liability
+
+    # The `inflow_model` allows you to model a test account that receives
+    # regular income or make regular payments on a loan. Any transactions
+    # generated by the `inflow_model` will appear in addition to randomly
+    # generated test data or transactions specified by `override_accounts`.
+    # @return [InflowModel]
+    attr_accessor :inflow_model
+
+    # Specify payroll data on the account.
+    # @return [IncomeOverride]
+    attr_accessor :income
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['subtype'] = 'subtype'
+      @_hash['starting_balance'] = 'starting_balance'
+      @_hash['force_available_balance'] = 'force_available_balance'
+      @_hash['currency'] = 'currency'
+      @_hash['meta'] = 'meta'
+      @_hash['numbers'] = 'numbers'
+      @_hash['transactions'] = 'transactions'
+      @_hash['holdings'] = 'holdings'
+      @_hash['investment_transactions'] = 'investment_transactions'
+      @_hash['identity'] = 'identity'
+      @_hash['liability'] = 'liability'
+      @_hash['inflow_model'] = 'inflow_model'
+      @_hash['income'] = 'income'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        holdings
+        investment_transactions
+        income
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, subtype:, starting_balance:, force_available_balance:,
+                   currency:, meta:, numbers:, transactions:, identity:,
+                   liability:, inflow_model:, holdings: SKIP,
+                   investment_transactions: SKIP, income: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @subtype = subtype
+      @starting_balance = starting_balance
+      @force_available_balance = force_available_balance
+      @currency = currency
+      @meta = meta
+      @numbers = numbers
+      @transactions = transactions
+      @holdings = holdings unless holdings == SKIP
+      @investment_transactions = investment_transactions unless investment_transactions == SKIP
+      @identity = identity
+      @liability = liability
+      @inflow_model = inflow_model
+      @income = income unless income == 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.
+      type = hash.key?('type') ? hash['type'] : nil
+      subtype = hash.key?('subtype') ? hash['subtype'] : nil
+      starting_balance =
+        hash.key?('starting_balance') ? hash['starting_balance'] : nil
+      force_available_balance =
+        hash.key?('force_available_balance') ? hash['force_available_balance'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      meta = Meta.from_hash(hash['meta']) if hash['meta']
+      numbers = Numbers.from_hash(hash['numbers']) if hash['numbers']
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (TransactionOverride.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = nil unless hash.key?('transactions')
+      identity = OwnerOverride.from_hash(hash['identity']) if hash['identity']
+      liability = LiabilityOverride.from_hash(hash['liability']) if hash['liability']
+      inflow_model = InflowModel.from_hash(hash['inflow_model']) if hash['inflow_model']
+      holdings = HoldingsOverride.from_hash(hash['holdings']) if hash['holdings']
+      if hash['investment_transactions']
+        investment_transactions = InvestmentsTransactionsOverride.from_hash(hash['investment_transactions'])
+      end
+      income = IncomeOverride.from_hash(hash['income']) if hash['income']
+
+      # 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.
+      OverrideAccounts.new(type: type,
+                           subtype: subtype,
+                           starting_balance: starting_balance,
+                           force_available_balance: force_available_balance,
+                           currency: currency,
+                           meta: meta,
+                           numbers: numbers,
+                           transactions: transactions,
+                           identity: identity,
+                           liability: liability,
+                           inflow_model: inflow_model,
+                           holdings: holdings,
+                           investment_transactions: investment_transactions,
+                           income: income,
+                           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} type: #{@type}, subtype: #{@subtype}, starting_balance:"\
+      " #{@starting_balance}, force_available_balance: #{@force_available_balance}, currency:"\
+      " #{@currency}, meta: #{@meta}, numbers: #{@numbers}, transactions: #{@transactions},"\
+      " holdings: #{@holdings}, investment_transactions: #{@investment_transactions}, identity:"\
+      " #{@identity}, liability: #{@liability}, inflow_model: #{@inflow_model}, income:"\
+      " #{@income}, 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} type: #{@type.inspect}, subtype: #{@subtype.inspect}, starting_balance:"\
+      " #{@starting_balance.inspect}, force_available_balance:"\
+      " #{@force_available_balance.inspect}, currency: #{@currency.inspect}, meta:"\
+      " #{@meta.inspect}, numbers: #{@numbers.inspect}, transactions: #{@transactions.inspect},"\
+      " holdings: #{@holdings.inspect}, investment_transactions:"\
+      " #{@investment_transactions.inspect}, identity: #{@identity.inspect}, liability:"\
+      " #{@liability.inspect}, inflow_model: #{@inflow_model.inspect}, income: #{@income.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/owner.rb

@@ -0,0 +1,141 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Data returned from the financial institution about the owner or owners of an
+  # account. Only the `names` array must be non-empty.
+  class Owner < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of names associated with the account by the financial institution.
+    # These should always be the names of individuals, even for business
+    # accounts. If the name of a business is reported, please contact Plaid
+    # Support. In the case of a joint account, Plaid will make a best effort to
+    # report the names of all account holders.
+    # If an Item contains multiple accounts with different owner names, some
+    # institutions will report all names associated with the Item in each
+    # account's `names` array.
+    # @return [Array[String]]
+    attr_accessor :names
+
+    # A list of phone numbers associated with the account by the financial
+    # institution. May be an empty array if no relevant information is returned
+    # from the financial institution.
+    # @return [Array[PhoneNumber]]
+    attr_accessor :phone_numbers
+
+    # A list of email addresses associated with the account by the financial
+    # institution. May be an empty array if no relevant information is returned
+    # from the financial institution.
+    # @return [Array[Email]]
+    attr_accessor :emails
+
+    # Data about the various addresses associated with the account by the
+    # financial institution. May be an empty array if no relevant information is
+    # returned from the financial institution.
+    # @return [Array[Address]]
+    attr_accessor :addresses
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['names'] = 'names'
+      @_hash['phone_numbers'] = 'phone_numbers'
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(names:, phone_numbers:, emails:, addresses:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @names = names
+      @phone_numbers = phone_numbers
+      @emails = emails
+      @addresses = addresses
+      @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.
+      names = hash.key?('names') ? hash['names'] : nil
+      # Parameter is an array, so we need to iterate through it
+      phone_numbers = nil
+      unless hash['phone_numbers'].nil?
+        phone_numbers = []
+        hash['phone_numbers'].each do |structure|
+          phone_numbers << (PhoneNumber.from_hash(structure) if structure)
+        end
+      end
+
+      phone_numbers = nil unless hash.key?('phone_numbers')
+      # Parameter is an array, so we need to iterate through it
+      emails = nil
+      unless hash['emails'].nil?
+        emails = []
+        hash['emails'].each do |structure|
+          emails << (Email.from_hash(structure) if structure)
+        end
+      end
+
+      emails = nil unless hash.key?('emails')
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (Address.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = nil unless hash.key?('addresses')
+
+      # 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.
+      Owner.new(names: names,
+                phone_numbers: phone_numbers,
+                emails: emails,
+                addresses: addresses,
+                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} names: #{@names}, phone_numbers: #{@phone_numbers}, emails: #{@emails},"\
+      " addresses: #{@addresses}, 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} names: #{@names.inspect}, phone_numbers: #{@phone_numbers.inspect}, emails:"\
+      " #{@emails.inspect}, addresses: #{@addresses.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/owner_override.rb

@@ -0,0 +1,131 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Data about the owner or owners of an account. Any fields not specified will
+  # be filled in with default Sandbox information.
+  class OwnerOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of names associated with the account by the financial institution.
+    # These should always be the names of individuals, even for business
+    # accounts. Note that the same name data will be used for all accounts
+    # associated with an Item.
+    # @return [Array[String]]
+    attr_accessor :names
+
+    # A list of phone numbers associated with the account.
+    # @return [Array[PhoneNumber]]
+    attr_accessor :phone_numbers
+
+    # A list of email addresses associated with the account.
+    # @return [Array[Email]]
+    attr_accessor :emails
+
+    # Data about the various addresses associated with the account.
+    # @return [Array[Address]]
+    attr_accessor :addresses
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['names'] = 'names'
+      @_hash['phone_numbers'] = 'phone_numbers'
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(names:, phone_numbers:, emails:, addresses:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @names = names
+      @phone_numbers = phone_numbers
+      @emails = emails
+      @addresses = addresses
+      @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.
+      names = hash.key?('names') ? hash['names'] : nil
+      # Parameter is an array, so we need to iterate through it
+      phone_numbers = nil
+      unless hash['phone_numbers'].nil?
+        phone_numbers = []
+        hash['phone_numbers'].each do |structure|
+          phone_numbers << (PhoneNumber.from_hash(structure) if structure)
+        end
+      end
+
+      phone_numbers = nil unless hash.key?('phone_numbers')
+      # Parameter is an array, so we need to iterate through it
+      emails = nil
+      unless hash['emails'].nil?
+        emails = []
+        hash['emails'].each do |structure|
+          emails << (Email.from_hash(structure) if structure)
+        end
+      end
+
+      emails = nil unless hash.key?('emails')
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (Address.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = nil unless hash.key?('addresses')
+
+      # 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.
+      OwnerOverride.new(names: names,
+                        phone_numbers: phone_numbers,
+                        emails: emails,
+                        addresses: addresses,
+                        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} names: #{@names}, phone_numbers: #{@phone_numbers}, emails: #{@emails},"\
+      " addresses: #{@addresses}, 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} names: #{@names.inspect}, phone_numbers: #{@phone_numbers.inspect}, emails:"\
+      " #{@emails.inspect}, addresses: #{@addresses.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end