apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/mortgage_property_address.rb

@@ -0,0 +1,114 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Object containing fields describing property address.
+  class MortgagePropertyAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The city name.
+    # @return [String]
+    attr_accessor :city
+
+    # The ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # The five or nine digit postal code.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The region or state (example "NC").
+    # @return [String]
+    attr_accessor :region
+
+    # The full street address (example "564 Main Street, Apt 15").
+    # @return [String]
+    attr_accessor :street
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['region'] = 'region'
+      @_hash['street'] = 'street'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        city
+        country
+        postal_code
+        region
+        street
+      ]
+    end
+
+    def initialize(city:, country:, postal_code:, region:, street:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @city = city
+      @country = country
+      @postal_code = postal_code
+      @region = region
+      @street = street
+      @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.
+      city = hash.key?('city') ? hash['city'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      region = hash.key?('region') ? hash['region'] : nil
+      street = hash.key?('street') ? hash['street'] : 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.
+      MortgagePropertyAddress.new(city: city,
+                                  country: country,
+                                  postal_code: postal_code,
+                                  region: region,
+                                  street: street,
+                                  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} city: #{@city}, country: #{@country}, postal_code: #{@postal_code}, region:"\
+      " #{@region}, street: #{@street}, 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} city: #{@city.inspect}, country: #{@country.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, region: #{@region.inspect}, street: #{@street.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/net_pay.rb

@@ -0,0 +1,96 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing information about the net pay amount on the paystub.
+  class NetPay < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[DistributionDetails]]
+    attr_accessor :distribution_details
+
+    # An object representing both the current pay period and year to date amount
+    # for a category.
+    # @return [Total]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['distribution_details'] = 'distribution_details'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        distribution_details
+        total
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(distribution_details: SKIP, total: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @distribution_details = distribution_details unless distribution_details == SKIP
+      @total = total unless total == 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.
+      # Parameter is an array, so we need to iterate through it
+      distribution_details = nil
+      unless hash['distribution_details'].nil?
+        distribution_details = []
+        hash['distribution_details'].each do |structure|
+          distribution_details << (DistributionDetails.from_hash(structure) if structure)
+        end
+      end
+
+      distribution_details = SKIP unless hash.key?('distribution_details')
+      total = Total.from_hash(hash['total']) if hash['total']
+
+      # 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.
+      NetPay.new(distribution_details: distribution_details,
+                 total: total,
+                 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} distribution_details: #{@distribution_details}, total: #{@total},"\
+      " 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} distribution_details: #{@distribution_details.inspect}, total:"\
+      " #{@total.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/new_accounts_available_webhook.rb

@@ -0,0 +1,115 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when Plaid detects a new account for Items created or updated with
+  # [Account Select
+  # v2](https://plaid.com/docs/link/customization/#account-select). Upon
+  # receiving this webhook, you can prompt your users to share new accounts with
+  # you through [Account Select v2 update
+  # mode](https://plaid.com/docs/link/update-mode/#using-update-mode-to-request-
+  # new-accounts).
+  class NewAccountsAvailableWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `ITEM`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `NEW_ACCOUNTS_AVAILABLE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # We use standard HTTP response codes for success and failure notifications,
+    # and our errors are further classified by `error_type`. In general, 200
+    # HTTP codes correspond to success, 40X codes are for developer- or
+    # user-related failures, and 50X codes are for Plaid-related issues.  Error
+    # fields will be `null` if no error has occurred.
+    # @return [Error]
+    attr_accessor :error
+
+    # 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['item_id'] = 'item_id'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        webhook_type
+        webhook_code
+        item_id
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type: SKIP, webhook_code: SKIP, item_id: SKIP,
+                   error: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type unless webhook_type == SKIP
+      @webhook_code = webhook_code unless webhook_code == SKIP
+      @item_id = item_id unless item_id == SKIP
+      @error = error unless error == 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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : SKIP
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : SKIP
+      item_id = hash.key?('item_id') ? hash['item_id'] : SKIP
+      error = Error.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      NewAccountsAvailableWebhook.new(webhook_type: webhook_type,
+                                      webhook_code: webhook_code,
+                                      item_id: item_id,
+                                      error: error,
+                                      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}, item_id:"\
+      " #{@item_id}, error: #{@error}, 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}, item_id: #{@item_id.inspect}, error: #{@error.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/new_payment_status.rb

@@ -0,0 +1,73 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The new 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 NewPaymentStatus
+    NEW_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/numbers.rb

@@ -0,0 +1,157 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Account and bank identifier number data used to configure the test account.
+  # All values are optional.
+  class Numbers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Will be used for the account number.
+    # @return [String]
+    attr_accessor :account
+
+    # Must be a valid ACH routing number.
+    # @return [String]
+    attr_accessor :ach_routing
+
+    # Must be a valid wire transfer routing number.
+    # @return [String]
+    attr_accessor :ach_wire_routing
+
+    # EFT institution number. Must be specified alongside `eft_branch`.
+    # @return [String]
+    attr_accessor :eft_institution
+
+    # EFT branch number. Must be specified alongside `eft_institution`.
+    # @return [String]
+    attr_accessor :eft_branch
+
+    # Bank identifier code (BIC). Must be specified alongside
+    # `international_iban`.
+    # @return [String]
+    attr_accessor :international_bic
+
+    # International bank account number (IBAN). If no account number is
+    # specified via `account`, will also be used as the account number by
+    # default. Must be specified alongside `international_bic`.
+    # @return [String]
+    attr_accessor :international_iban
+
+    # BACS sort code
+    # @return [String]
+    attr_accessor :bacs_sort_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['ach_routing'] = 'ach_routing'
+      @_hash['ach_wire_routing'] = 'ach_wire_routing'
+      @_hash['eft_institution'] = 'eft_institution'
+      @_hash['eft_branch'] = 'eft_branch'
+      @_hash['international_bic'] = 'international_bic'
+      @_hash['international_iban'] = 'international_iban'
+      @_hash['bacs_sort_code'] = 'bacs_sort_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        ach_routing
+        ach_wire_routing
+        eft_institution
+        eft_branch
+        international_bic
+        international_iban
+        bacs_sort_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account: SKIP, ach_routing: SKIP, ach_wire_routing: SKIP,
+                   eft_institution: SKIP, eft_branch: SKIP,
+                   international_bic: SKIP, international_iban: SKIP,
+                   bacs_sort_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account = account unless account == SKIP
+      @ach_routing = ach_routing unless ach_routing == SKIP
+      @ach_wire_routing = ach_wire_routing unless ach_wire_routing == SKIP
+      @eft_institution = eft_institution unless eft_institution == SKIP
+      @eft_branch = eft_branch unless eft_branch == SKIP
+      @international_bic = international_bic unless international_bic == SKIP
+      @international_iban = international_iban unless international_iban == SKIP
+      @bacs_sort_code = bacs_sort_code unless bacs_sort_code == 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 = hash.key?('account') ? hash['account'] : SKIP
+      ach_routing = hash.key?('ach_routing') ? hash['ach_routing'] : SKIP
+      ach_wire_routing =
+        hash.key?('ach_wire_routing') ? hash['ach_wire_routing'] : SKIP
+      eft_institution =
+        hash.key?('eft_institution') ? hash['eft_institution'] : SKIP
+      eft_branch = hash.key?('eft_branch') ? hash['eft_branch'] : SKIP
+      international_bic =
+        hash.key?('international_bic') ? hash['international_bic'] : SKIP
+      international_iban =
+        hash.key?('international_iban') ? hash['international_iban'] : SKIP
+      bacs_sort_code =
+        hash.key?('bacs_sort_code') ? hash['bacs_sort_code'] : 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.
+      Numbers.new(account: account,
+                  ach_routing: ach_routing,
+                  ach_wire_routing: ach_wire_routing,
+                  eft_institution: eft_institution,
+                  eft_branch: eft_branch,
+                  international_bic: international_bic,
+                  international_iban: international_iban,
+                  bacs_sort_code: bacs_sort_code,
+                  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: #{@account}, ach_routing: #{@ach_routing}, ach_wire_routing:"\
+      " #{@ach_wire_routing}, eft_institution: #{@eft_institution}, eft_branch: #{@eft_branch},"\
+      " international_bic: #{@international_bic}, international_iban: #{@international_iban},"\
+      " bacs_sort_code: #{@bacs_sort_code}, 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: #{@account.inspect}, ach_routing: #{@ach_routing.inspect},"\
+      " ach_wire_routing: #{@ach_wire_routing.inspect}, eft_institution:"\
+      " #{@eft_institution.inspect}, eft_branch: #{@eft_branch.inspect}, international_bic:"\
+      " #{@international_bic.inspect}, international_iban: #{@international_iban.inspect},"\
+      " bacs_sort_code: #{@bacs_sort_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/numbers_ach.rb

@@ -0,0 +1,113 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Identifying information for transferring money to or from a US account via
+  # ACH or wire transfer.
+  class NumbersAch < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Plaid account ID associated with the account numbers
+    # @return [String]
+    attr_accessor :account_id
+
+    # The ACH account number for the account.
+    # Note that when using OAuth with Chase Bank (`ins_56`), Chase will issue
+    # "tokenized" routing and account numbers, which are not the user's actual
+    # account and routing numbers. These tokenized numbers should work
+    # identically to normal account and routing numbers. The digits returned in
+    # the mask field will continue to reflect the actual account number, rather
+    # than the tokenized account number. If a user revokes their permissions to
+    # your app, the tokenized numbers will continue to work for ACH deposits,
+    # but not withdrawals.
+    # @return [String]
+    attr_accessor :account
+
+    # The ACH routing number for the account. If the institution is `ins_56`,
+    # this may be a tokenized routing number. For more information, see the
+    # description of the `account` field.
+    # @return [String]
+    attr_accessor :routing
+
+    # The wire transfer routing number for the account, if available
+    # @return [String]
+    attr_accessor :wire_routing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['account'] = 'account'
+      @_hash['routing'] = 'routing'
+      @_hash['wire_routing'] = 'wire_routing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        wire_routing
+      ]
+    end
+
+    def initialize(account_id:, account:, routing:, wire_routing:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @account = account
+      @routing = routing
+      @wire_routing = wire_routing
+      @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
+      account = hash.key?('account') ? hash['account'] : nil
+      routing = hash.key?('routing') ? hash['routing'] : nil
+      wire_routing = hash.key?('wire_routing') ? hash['wire_routing'] : 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.
+      NumbersAch.new(account_id: account_id,
+                     account: account,
+                     routing: routing,
+                     wire_routing: wire_routing,
+                     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}, account: #{@account}, routing: #{@routing},"\
+      " wire_routing: #{@wire_routing}, 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}, account: #{@account.inspect}, routing:"\
+      " #{@routing.inspect}, wire_routing: #{@wire_routing.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end