apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/document_metadata.rb

@@ -0,0 +1,96 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing metadata from the end user's uploaded document.
+  class DocumentMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the document.
+    # @return [String]
+    attr_accessor :name
+
+    # The processing status of the document.
+    # @return [String]
+    attr_accessor :status
+
+    # An identifier of the document that is also present in the paystub
+    # response.
+    # @return [String]
+    attr_accessor :doc_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['status'] = 'status'
+      @_hash['doc_id'] = 'doc_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        status
+        doc_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, status: SKIP, doc_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @status = status unless status == SKIP
+      @doc_id = doc_id unless doc_id == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      doc_id = hash.key?('doc_id') ? hash['doc_id'] : 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.
+      DocumentMetadata.new(name: name,
+                           status: status,
+                           doc_id: doc_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} name: #{@name}, status: #{@status}, doc_id: #{@doc_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} name: #{@name.inspect}, status: #{@status.inspect}, doc_id:"\
+      " #{@doc_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/earnings.rb

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

data/lib/plaid/models/earnings_total.rb

@@ -0,0 +1,133 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing both the current pay period and year to date amount
+  # for an earning category.
+  class EarningsTotal < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Commonly used term to describe the line item.
+    # @return [CanonicalDescription]
+    attr_accessor :canonical_description
+
+    # Text of the line item as printed on the paystub.
+    # @return [String]
+    attr_accessor :description
+
+    # An object representing a monetary amount.
+    # @return [Pay]
+    attr_accessor :current_pay
+
+    # An object representing a monetary amount.
+    # @return [Pay]
+    attr_accessor :ytd_pay
+
+    # An object representing a monetary amount.
+    # @return [String]
+    attr_accessor :current_hours
+
+    # An object representing a monetary amount.
+    # @return [String]
+    attr_accessor :current_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['canonical_description'] = 'canonical_description'
+      @_hash['description'] = 'description'
+      @_hash['current_pay'] = 'current_pay'
+      @_hash['ytd_pay'] = 'ytd_pay'
+      @_hash['current_hours'] = 'current_hours'
+      @_hash['current_rate'] = 'current_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        canonical_description
+        description
+        current_pay
+        ytd_pay
+        current_hours
+        current_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        current_hours
+        current_rate
+      ]
+    end
+
+    def initialize(canonical_description: SKIP, description: SKIP,
+                   current_pay: SKIP, ytd_pay: SKIP, current_hours: SKIP,
+                   current_rate: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @canonical_description = canonical_description unless canonical_description == SKIP
+      @description = description unless description == SKIP
+      @current_pay = current_pay unless current_pay == SKIP
+      @ytd_pay = ytd_pay unless ytd_pay == SKIP
+      @current_hours = current_hours unless current_hours == SKIP
+      @current_rate = current_rate unless current_rate == 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.
+      canonical_description =
+        hash.key?('canonical_description') ? hash['canonical_description'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      current_pay = Pay.from_hash(hash['current_pay']) if hash['current_pay']
+      ytd_pay = Pay.from_hash(hash['ytd_pay']) if hash['ytd_pay']
+      current_hours = hash.key?('current_hours') ? hash['current_hours'] : SKIP
+      current_rate = hash.key?('current_rate') ? hash['current_rate'] : 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.
+      EarningsTotal.new(canonical_description: canonical_description,
+                        description: description,
+                        current_pay: current_pay,
+                        ytd_pay: ytd_pay,
+                        current_hours: current_hours,
+                        current_rate: current_rate,
+                        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} canonical_description: #{@canonical_description}, description:"\
+      " #{@description}, current_pay: #{@current_pay}, ytd_pay: #{@ytd_pay}, current_hours:"\
+      " #{@current_hours}, current_rate: #{@current_rate}, 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} canonical_description: #{@canonical_description.inspect}, description:"\
+      " #{@description.inspect}, current_pay: #{@current_pay.inspect}, ytd_pay:"\
+      " #{@ytd_pay.inspect}, current_hours: #{@current_hours.inspect}, current_rate:"\
+      " #{@current_rate.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/email.rb

@@ -0,0 +1,91 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing an email address
+  class Email < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The email address.
+    # @return [String]
+    attr_accessor :data
+
+    # When `true`, identifies the email address as the primary email on an
+    # account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # The type of email account as described by the financial institution.
+    # @return [Type1]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['primary'] = 'primary'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, primary:, type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @primary = primary
+      @type = type
+      @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.
+      data = hash.key?('data') ? hash['data'] : nil
+      primary = hash.key?('primary') ? hash['primary'] : nil
+      type = hash.key?('type') ? hash['type'] : 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.
+      Email.new(data: data,
+                primary: primary,
+                type: type,
+                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} data: #{@data}, primary: #{@primary}, type: #{@type},"\
+      " 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} data: #{@data.inspect}, primary: #{@primary.inspect}, type:"\
+      " #{@type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/employee.rb

@@ -0,0 +1,107 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Data about the employee.
+  class Employee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the employee.
+    # @return [String]
+    attr_accessor :name
+
+    # The name of the employee.
+    # @return [Address2]
+    attr_accessor :address
+
+    # Marital status of the employee.
+    # @return [String]
+    attr_accessor :marital_status
+
+    # Marital status of the employee.
+    # @return [TaxpayerId]
+    attr_accessor :taxpayer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['marital_status'] = 'marital_status'
+      @_hash['taxpayer_id'] = 'taxpayer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        marital_status
+        taxpayer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        name
+        marital_status
+      ]
+    end
+
+    def initialize(name:, address:, marital_status: SKIP, taxpayer_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @address = address
+      @marital_status = marital_status unless marital_status == SKIP
+      @taxpayer_id = taxpayer_id unless taxpayer_id == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      address = Address2.from_hash(hash['address']) if hash['address']
+      marital_status =
+        hash.key?('marital_status') ? hash['marital_status'] : SKIP
+      taxpayer_id = TaxpayerId.from_hash(hash['taxpayer_id']) if hash['taxpayer_id']
+
+      # 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.
+      Employee.new(name: name,
+                   address: address,
+                   marital_status: marital_status,
+                   taxpayer_id: taxpayer_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} name: #{@name}, address: #{@address}, marital_status: #{@marital_status},"\
+      " taxpayer_id: #{@taxpayer_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} name: #{@name.inspect}, address: #{@address.inspect}, marital_status:"\
+      " #{@marital_status.inspect}, taxpayer_id: #{@taxpayer_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/employee2.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The employee on the paystub.
+  class Employee2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the employee.
+    # @return [String]
+    attr_accessor :name
+
+    # The address of the employee.
+    # @return [Address1]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @address = address unless address == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      address = Address1.from_hash(hash['address']) if hash['address']
+
+      # 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.
+      Employee2.new(name: name,
+                    address: address,
+                    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} name: #{@name}, address: #{@address}, 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} name: #{@name.inspect}, address: #{@address.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end