apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/income_verification_webhook_status.rb

@@ -0,0 +1,72 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationWebhookStatus Model.
+  class IncomeVerificationWebhookStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = 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.
+      id = hash.key?('id') ? hash['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.
+      IncomeVerificationWebhookStatus.new(id: 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} id: #{@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} id: #{@id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/inflow_model.rb

@@ -0,0 +1,136 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # 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`.
+  class InflowModel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Inflow model. One of the following:
+    # `none`: No income
+    # `monthly-income`: Income occurs once per month `monthly-balance-payment`:
+    # Pays off the balance on a liability account at the given statement day of
+    # month
+    # `monthly-interest-only-payment`: Makes an interest-only payment on a
+    # liability account at the given statement day of month. Note that account
+    # types supported by Liabilities will accrue interest in the Sandbox. The
+    # types are account type `credit` with subtype `credit` or `paypal`, and
+    # account type `loan` with subtype `student` or `mortgage`.
+    # @return [String]
+    attr_accessor :type
+
+    # Amount of income per month. This value is required if `type` is
+    # `monthly-income`.
+    # @return [Float]
+    attr_accessor :income_amount
+
+    # Number between 1 and 28, or `last` meaning the last day of the month. The
+    # day of the month on which the income transaction will appear. The name of
+    # the income transaction. This field is required if `type` is
+    # `monthly-income`, `monthly-balance-payment` or
+    # `monthly-interest-only-payment`.
+    # @return [Float]
+    attr_accessor :payment_day_of_month
+
+    # The name of the income transaction. This field is required if `type` is
+    # `monthly-income`, `monthly-balance-payment` or
+    # `monthly-interest-only-payment`.
+    # @return [String]
+    attr_accessor :transaction_name
+
+    # Number between 1 and 28, or `last` meaning the last day of the month. The
+    # day of the month on which the balance is calculated for the next payment.
+    # The name of the income transaction. This field is required if `type` is
+    # `monthly-balance-payment` or `monthly-interest-only-payment`.
+    # @return [String]
+    attr_accessor :statement_day_of_month
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['income_amount'] = 'income_amount'
+      @_hash['payment_day_of_month'] = 'payment_day_of_month'
+      @_hash['transaction_name'] = 'transaction_name'
+      @_hash['statement_day_of_month'] = 'statement_day_of_month'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, income_amount:, payment_day_of_month:,
+                   transaction_name:, statement_day_of_month:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @income_amount = income_amount
+      @payment_day_of_month = payment_day_of_month
+      @transaction_name = transaction_name
+      @statement_day_of_month = statement_day_of_month
+      @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
+      income_amount = hash.key?('income_amount') ? hash['income_amount'] : nil
+      payment_day_of_month =
+        hash.key?('payment_day_of_month') ? hash['payment_day_of_month'] : nil
+      transaction_name =
+        hash.key?('transaction_name') ? hash['transaction_name'] : nil
+      statement_day_of_month =
+        hash.key?('statement_day_of_month') ? hash['statement_day_of_month'] : 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.
+      InflowModel.new(type: type,
+                      income_amount: income_amount,
+                      payment_day_of_month: payment_day_of_month,
+                      transaction_name: transaction_name,
+                      statement_day_of_month: statement_day_of_month,
+                      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}, income_amount: #{@income_amount}, payment_day_of_month:"\
+      " #{@payment_day_of_month}, transaction_name: #{@transaction_name}, statement_day_of_month:"\
+      " #{@statement_day_of_month}, 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}, income_amount: #{@income_amount.inspect},"\
+      " payment_day_of_month: #{@payment_day_of_month.inspect}, transaction_name:"\
+      " #{@transaction_name.inspect}, statement_day_of_month: #{@statement_day_of_month.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/initial_update_webhook.rb

@@ -0,0 +1,121 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when an Item's initial transaction pull is completed. Once this
+  # webhook has been fired, transaction data for the most recent 30 days can be
+  # fetched for the Item. If [Account Select
+  # v2](https://plaid.com/docs/link/customization/#account-select) is enabled,
+  # this webhook will also be fired if account selections for the Item are
+  # updated, with `num_transactions` set to the number of net new transactions
+  # pulled after the account selection update.
+  class InitialUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `TRANSACTIONS`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `INITIAL_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The error code associated with the webhook.
+    # @return [String]
+    attr_accessor :error
+
+    # The number of new, unfetched transactions available.
+    # @return [Float]
+    attr_accessor :new_transactions
+
+    # 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['error'] = 'error'
+      @_hash['new_transactions'] = 'new_transactions'
+      @_hash['item_id'] = 'item_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        error
+      ]
+    end
+
+    def initialize(webhook_type:, webhook_code:, new_transactions:, item_id:,
+                   error: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @error = error unless error == SKIP
+      @new_transactions = new_transactions
+      @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
+      new_transactions =
+        hash.key?('new_transactions') ? hash['new_transactions'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      error = hash.key?('error') ? hash['error'] : 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.
+      InitialUpdateWebhook.new(webhook_type: webhook_type,
+                               webhook_code: webhook_code,
+                               new_transactions: new_transactions,
+                               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}, error:"\
+      " #{@error}, new_transactions: #{@new_transactions}, 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}, error: #{@error.inspect}, new_transactions:"\
+      " #{@new_transactions.inspect}, item_id: #{@item_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/institution.rb

@@ -0,0 +1,213 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Details relating to a specific financial institution
+  class Institution < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the institution
+    # @return [String]
+    attr_accessor :institution_id
+
+    # The official name of the institution
+    # @return [String]
+    attr_accessor :name
+
+    # A list of the Plaid products supported by the institution. Note that only
+    # institutions that support Instant Auth will return `auth` in the product
+    # array; institutions that do not list `auth` may still support other Auth
+    # methods such as Instant Match or Automated Micro-deposit Verification. For
+    # more details, see [Full Auth
+    # coverage](https://plaid.com/docs/auth/coverage/).
+    # @return [Array[Products]]
+    attr_accessor :products
+
+    # A list of the country codes supported by the institution.
+    # @return [Array[CountryCode]]
+    attr_accessor :country_codes
+
+    # The URL for the institution's website
+    # @return [String]
+    attr_accessor :url
+
+    # Hexadecimal representation of the primary color used by the institution
+    # @return [String]
+    attr_accessor :primary_color
+
+    # Base64 encoded representation of the institution's logo
+    # @return [String]
+    attr_accessor :logo
+
+    # A partial list of routing numbers associated with the institution. This
+    # list is provided for the purpose of looking up institutions by routing
+    # number. It is not comprehensive and should never be used as a complete
+    # list of routing numbers for an institution.
+    # @return [Array[String]]
+    attr_accessor :routing_numbers
+
+    # Indicates that the institution has an OAuth login flow. This is primarily
+    # relevant to institutions with European country codes.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :oauth
+
+    # The status of an institution is determined by the health of its Item
+    # logins, Transactions updates, Investments updates, Liabilities updates,
+    # Auth requests, Balance requests, Identity requests, Investments requests,
+    # and Liabilities requests. A login attempt is conducted during the initial
+    # Item add in Link. If there is not enough traffic to accurately calculate
+    # an institution's status, Plaid will return null rather than potentially
+    # inaccurate data.
+    # Institution status is accessible in the Dashboard and via the API using
+    # the `/institutions/get_by_id` endpoint with the `include_status` option
+    # set to true. Note that institution status is not available in the Sandbox
+    # environment.
+    # @return [InstitutionStatus]
+    attr_accessor :status
+
+    # Metadata that captures what specific payment configurations an institution
+    # supports when making Payment Initiation requests.
+    # @return [PaymentInitiationMetadata]
+    attr_accessor :payment_initiation_metadata
+
+    # Metadata that captures information about the Auth features of an
+    # institution.
+    # @return [AuthMetadata]
+    attr_accessor :auth_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['institution_id'] = 'institution_id'
+      @_hash['name'] = 'name'
+      @_hash['products'] = 'products'
+      @_hash['country_codes'] = 'country_codes'
+      @_hash['url'] = 'url'
+      @_hash['primary_color'] = 'primary_color'
+      @_hash['logo'] = 'logo'
+      @_hash['routing_numbers'] = 'routing_numbers'
+      @_hash['oauth'] = 'oauth'
+      @_hash['status'] = 'status'
+      @_hash['payment_initiation_metadata'] = 'payment_initiation_metadata'
+      @_hash['auth_metadata'] = 'auth_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+        primary_color
+        logo
+        status
+        payment_initiation_metadata
+        auth_metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        url
+        primary_color
+        logo
+        routing_numbers
+      ]
+    end
+
+    def initialize(institution_id:, name:, products:, country_codes:,
+                   routing_numbers:, oauth:, url: SKIP, primary_color: SKIP,
+                   logo: SKIP, status: SKIP, payment_initiation_metadata: SKIP,
+                   auth_metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @institution_id = institution_id
+      @name = name
+      @products = products
+      @country_codes = country_codes
+      @url = url unless url == SKIP
+      @primary_color = primary_color unless primary_color == SKIP
+      @logo = logo unless logo == SKIP
+      @routing_numbers = routing_numbers
+      @oauth = oauth
+      @status = status unless status == SKIP
+      unless payment_initiation_metadata == SKIP
+        @payment_initiation_metadata =
+          payment_initiation_metadata
+      end
+      @auth_metadata = auth_metadata unless auth_metadata == 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.
+      institution_id =
+        hash.key?('institution_id') ? hash['institution_id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      products = hash.key?('products') ? hash['products'] : nil
+      country_codes = hash.key?('country_codes') ? hash['country_codes'] : nil
+      routing_numbers =
+        hash.key?('routing_numbers') ? hash['routing_numbers'] : nil
+      oauth = hash.key?('oauth') ? hash['oauth'] : nil
+      url = hash.key?('url') ? hash['url'] : SKIP
+      primary_color = hash.key?('primary_color') ? hash['primary_color'] : SKIP
+      logo = hash.key?('logo') ? hash['logo'] : SKIP
+      status = InstitutionStatus.from_hash(hash['status']) if hash['status']
+      if hash['payment_initiation_metadata']
+        payment_initiation_metadata = PaymentInitiationMetadata.from_hash(hash['payment_initiation_metadata'])
+      end
+      auth_metadata = AuthMetadata.from_hash(hash['auth_metadata']) if hash['auth_metadata']
+
+      # 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.
+      Institution.new(institution_id: institution_id,
+                      name: name,
+                      products: products,
+                      country_codes: country_codes,
+                      routing_numbers: routing_numbers,
+                      oauth: oauth,
+                      url: url,
+                      primary_color: primary_color,
+                      logo: logo,
+                      status: status,
+                      payment_initiation_metadata: payment_initiation_metadata,
+                      auth_metadata: auth_metadata,
+                      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} institution_id: #{@institution_id}, name: #{@name}, products: #{@products},"\
+      " country_codes: #{@country_codes}, url: #{@url}, primary_color: #{@primary_color}, logo:"\
+      " #{@logo}, routing_numbers: #{@routing_numbers}, oauth: #{@oauth}, status: #{@status},"\
+      " payment_initiation_metadata: #{@payment_initiation_metadata}, auth_metadata:"\
+      " #{@auth_metadata}, 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} institution_id: #{@institution_id.inspect}, name: #{@name.inspect},"\
+      " products: #{@products.inspect}, country_codes: #{@country_codes.inspect}, url:"\
+      " #{@url.inspect}, primary_color: #{@primary_color.inspect}, logo: #{@logo.inspect},"\
+      " routing_numbers: #{@routing_numbers.inspect}, oauth: #{@oauth.inspect}, status:"\
+      " #{@status.inspect}, payment_initiation_metadata: #{@payment_initiation_metadata.inspect},"\
+      " auth_metadata: #{@auth_metadata.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end