apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/paystub.rb

@@ -0,0 +1,186 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing data extracted from the end user's paystub.
+  class Paystub < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object with the deduction information found on a paystub.
+    # @return [Deductions]
+    attr_accessor :deductions
+
+    # An identifier of the document referenced by the document metadata.
+    # @return [String]
+    attr_accessor :doc_id
+
+    # An object representing both a breakdown of earnings on a paystub and the
+    # total earnings.
+    # @return [Earnings]
+    attr_accessor :earnings
+
+    # An object representing both a breakdown of earnings on a paystub and the
+    # total earnings.
+    # @return [Employer2]
+    attr_accessor :employer
+
+    # Data about the employee.
+    # @return [Employee]
+    attr_accessor :employee
+
+    # An object representing employment details found on a paystub.
+    # @return [EmploymentDetails]
+    attr_accessor :employment_details
+
+    # An object representing information about the net pay amount on the
+    # paystub.
+    # @return [NetPay]
+    attr_accessor :net_pay
+
+    # Details about the pay period.
+    # @return [PayPeriodDetails]
+    attr_accessor :pay_period_details
+
+    # An object representing details that can be found on the paystub.
+    # @return [PaystubDetails]
+    attr_accessor :paystub_details
+
+    # An object representing details that can be found on the paystub.
+    # @return [Array[IncomeBreakdown]]
+    attr_accessor :income_breakdown
+
+    # The amount of income earned year to date, as based on paystub data.
+    # @return [PaystubYtdDetails]
+    attr_accessor :ytd_earnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deductions'] = 'deductions'
+      @_hash['doc_id'] = 'doc_id'
+      @_hash['earnings'] = 'earnings'
+      @_hash['employer'] = 'employer'
+      @_hash['employee'] = 'employee'
+      @_hash['employment_details'] = 'employment_details'
+      @_hash['net_pay'] = 'net_pay'
+      @_hash['pay_period_details'] = 'pay_period_details'
+      @_hash['paystub_details'] = 'paystub_details'
+      @_hash['income_breakdown'] = 'income_breakdown'
+      @_hash['ytd_earnings'] = 'ytd_earnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        deductions
+        doc_id
+        earnings
+        employment_details
+        net_pay
+        paystub_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(employer:, employee:, pay_period_details:, income_breakdown:,
+                   ytd_earnings:, deductions: SKIP, doc_id: SKIP,
+                   earnings: SKIP, employment_details: SKIP, net_pay: SKIP,
+                   paystub_details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deductions = deductions unless deductions == SKIP
+      @doc_id = doc_id unless doc_id == SKIP
+      @earnings = earnings unless earnings == SKIP
+      @employer = employer
+      @employee = employee
+      @employment_details = employment_details unless employment_details == SKIP
+      @net_pay = net_pay unless net_pay == SKIP
+      @pay_period_details = pay_period_details
+      @paystub_details = paystub_details unless paystub_details == SKIP
+      @income_breakdown = income_breakdown
+      @ytd_earnings = ytd_earnings
+      @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.
+      employer = Employer2.from_hash(hash['employer']) if hash['employer']
+      employee = Employee.from_hash(hash['employee']) if hash['employee']
+      pay_period_details = PayPeriodDetails.from_hash(hash['pay_period_details']) if
+        hash['pay_period_details']
+      # Parameter is an array, so we need to iterate through it
+      income_breakdown = nil
+      unless hash['income_breakdown'].nil?
+        income_breakdown = []
+        hash['income_breakdown'].each do |structure|
+          income_breakdown << (IncomeBreakdown.from_hash(structure) if structure)
+        end
+      end
+
+      income_breakdown = nil unless hash.key?('income_breakdown')
+      ytd_earnings = PaystubYtdDetails.from_hash(hash['ytd_earnings']) if hash['ytd_earnings']
+      deductions = Deductions.from_hash(hash['deductions']) if hash['deductions']
+      doc_id = hash.key?('doc_id') ? hash['doc_id'] : SKIP
+      earnings = Earnings.from_hash(hash['earnings']) if hash['earnings']
+      employment_details = EmploymentDetails.from_hash(hash['employment_details']) if
+        hash['employment_details']
+      net_pay = NetPay.from_hash(hash['net_pay']) if hash['net_pay']
+      paystub_details = PaystubDetails.from_hash(hash['paystub_details']) if
+        hash['paystub_details']
+
+      # 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.
+      Paystub.new(employer: employer,
+                  employee: employee,
+                  pay_period_details: pay_period_details,
+                  income_breakdown: income_breakdown,
+                  ytd_earnings: ytd_earnings,
+                  deductions: deductions,
+                  doc_id: doc_id,
+                  earnings: earnings,
+                  employment_details: employment_details,
+                  net_pay: net_pay,
+                  paystub_details: paystub_details,
+                  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} deductions: #{@deductions}, doc_id: #{@doc_id}, earnings: #{@earnings},"\
+      " employer: #{@employer}, employee: #{@employee}, employment_details:"\
+      " #{@employment_details}, net_pay: #{@net_pay}, pay_period_details: #{@pay_period_details},"\
+      " paystub_details: #{@paystub_details}, income_breakdown: #{@income_breakdown},"\
+      " ytd_earnings: #{@ytd_earnings}, 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} deductions: #{@deductions.inspect}, doc_id: #{@doc_id.inspect}, earnings:"\
+      " #{@earnings.inspect}, employer: #{@employer.inspect}, employee: #{@employee.inspect},"\
+      " employment_details: #{@employment_details.inspect}, net_pay: #{@net_pay.inspect},"\
+      " pay_period_details: #{@pay_period_details.inspect}, paystub_details:"\
+      " #{@paystub_details.inspect}, income_breakdown: #{@income_breakdown.inspect}, ytd_earnings:"\
+      " #{@ytd_earnings.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/paystub_deduction.rb

@@ -0,0 +1,95 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaystubDeduction Model.
+  class PaystubDeduction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the deduction, as provided on the paystub. For example:
+    # `"401(k)"`, `"FICA MED TAX"`.
+    # @return [String]
+    attr_accessor :type
+
+    # `true` if the deduction is pre-tax; `false` otherwise.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_pretax
+
+    # The amount of the deduction.
+    # @return [Float]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['is_pretax'] = 'is_pretax'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        is_pretax
+        total
+      ]
+    end
+
+    def initialize(type:, is_pretax:, total:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @is_pretax = is_pretax
+      @total = total
+      @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
+      is_pretax = hash.key?('is_pretax') ? hash['is_pretax'] : nil
+      total = hash.key?('total') ? hash['total'] : 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.
+      PaystubDeduction.new(type: type,
+                           is_pretax: is_pretax,
+                           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} type: #{@type}, is_pretax: #{@is_pretax}, 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} type: #{@type.inspect}, is_pretax: #{@is_pretax.inspect}, total:"\
+      " #{@total.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/paystub_details.rb

@@ -0,0 +1,127 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing details that can be found on the paystub.
+  class PaystubDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Beginning date of the pay period on the paystub in the 'YYYY-MM-DD'
+    # format.
+    # @return [Date]
+    attr_accessor :pay_period_start_date
+
+    # Ending date of the pay period on the paystub in the 'YYYY-MM-DD' format.
+    # @return [Date]
+    attr_accessor :pay_period_end_date
+
+    # Pay date on the paystub in the 'YYYY-MM-DD' format.
+    # @return [Date]
+    attr_accessor :pay_date
+
+    # The name of the payroll provider that generated the paystub, e.g. ADP
+    # @return [String]
+    attr_accessor :paystub_provider
+
+    # The frequency at which the employee is paid. Possible values: `MONTHLY`,
+    # `BI-WEEKLY`, `WEEKLY`, `SEMI-MONTHLY`.
+    # @return [PayFrequency1]
+    attr_accessor :pay_frequency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pay_period_start_date'] = 'pay_period_start_date'
+      @_hash['pay_period_end_date'] = 'pay_period_end_date'
+      @_hash['pay_date'] = 'pay_date'
+      @_hash['paystub_provider'] = 'paystub_provider'
+      @_hash['pay_frequency'] = 'pay_frequency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pay_period_start_date
+        pay_period_end_date
+        pay_date
+        paystub_provider
+        pay_frequency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        pay_period_start_date
+        pay_period_end_date
+        pay_date
+        paystub_provider
+      ]
+    end
+
+    def initialize(pay_period_start_date: SKIP, pay_period_end_date: SKIP,
+                   pay_date: SKIP, paystub_provider: SKIP, pay_frequency: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pay_period_start_date = pay_period_start_date unless pay_period_start_date == SKIP
+      @pay_period_end_date = pay_period_end_date unless pay_period_end_date == SKIP
+      @pay_date = pay_date unless pay_date == SKIP
+      @paystub_provider = paystub_provider unless paystub_provider == SKIP
+      @pay_frequency = pay_frequency unless pay_frequency == 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.
+      pay_period_start_date =
+        hash.key?('pay_period_start_date') ? hash['pay_period_start_date'] : SKIP
+      pay_period_end_date =
+        hash.key?('pay_period_end_date') ? hash['pay_period_end_date'] : SKIP
+      pay_date = hash.key?('pay_date') ? hash['pay_date'] : SKIP
+      paystub_provider =
+        hash.key?('paystub_provider') ? hash['paystub_provider'] : SKIP
+      pay_frequency = hash.key?('pay_frequency') ? hash['pay_frequency'] : 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.
+      PaystubDetails.new(pay_period_start_date: pay_period_start_date,
+                         pay_period_end_date: pay_period_end_date,
+                         pay_date: pay_date,
+                         paystub_provider: paystub_provider,
+                         pay_frequency: pay_frequency,
+                         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} pay_period_start_date: #{@pay_period_start_date}, pay_period_end_date:"\
+      " #{@pay_period_end_date}, pay_date: #{@pay_date}, paystub_provider: #{@paystub_provider},"\
+      " pay_frequency: #{@pay_frequency}, 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} pay_period_start_date: #{@pay_period_start_date.inspect},"\
+      " pay_period_end_date: #{@pay_period_end_date.inspect}, pay_date: #{@pay_date.inspect},"\
+      " paystub_provider: #{@paystub_provider.inspect}, pay_frequency: #{@pay_frequency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/paystub_override.rb

@@ -0,0 +1,116 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing data from a paystub.
+  class PaystubOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The employer on the paystub.
+    # @return [Employer3]
+    attr_accessor :employer
+
+    # The employee on the paystub.
+    # @return [Employee2]
+    attr_accessor :employee
+
+    # The employee on the paystub.
+    # @return [Array[IncomeBreakdown]]
+    attr_accessor :income_breakdown
+
+    # Details about the pay period.
+    # @return [PayPeriodDetails]
+    attr_accessor :pay_period_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employer'] = 'employer'
+      @_hash['employee'] = 'employee'
+      @_hash['income_breakdown'] = 'income_breakdown'
+      @_hash['pay_period_details'] = 'pay_period_details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        employer
+        employee
+        income_breakdown
+        pay_period_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(employer: SKIP, employee: SKIP, income_breakdown: SKIP,
+                   pay_period_details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employer = employer unless employer == SKIP
+      @employee = employee unless employee == SKIP
+      @income_breakdown = income_breakdown unless income_breakdown == SKIP
+      @pay_period_details = pay_period_details unless pay_period_details == 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.
+      employer = Employer3.from_hash(hash['employer']) if hash['employer']
+      employee = Employee2.from_hash(hash['employee']) if hash['employee']
+      # Parameter is an array, so we need to iterate through it
+      income_breakdown = nil
+      unless hash['income_breakdown'].nil?
+        income_breakdown = []
+        hash['income_breakdown'].each do |structure|
+          income_breakdown << (IncomeBreakdown.from_hash(structure) if structure)
+        end
+      end
+
+      income_breakdown = SKIP unless hash.key?('income_breakdown')
+      pay_period_details = PayPeriodDetails.from_hash(hash['pay_period_details']) if
+        hash['pay_period_details']
+
+      # 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.
+      PaystubOverride.new(employer: employer,
+                          employee: employee,
+                          income_breakdown: income_breakdown,
+                          pay_period_details: pay_period_details,
+                          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} employer: #{@employer}, employee: #{@employee}, income_breakdown:"\
+      " #{@income_breakdown}, pay_period_details: #{@pay_period_details}, 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} employer: #{@employer.inspect}, employee: #{@employee.inspect},"\
+      " income_breakdown: #{@income_breakdown.inspect}, pay_period_details:"\
+      " #{@pay_period_details.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/paystub_ytd_details.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The amount of income earned year to date, as based on paystub data.
+  class PaystubYtdDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year-to-date gross earnings.
+    # @return [Float]
+    attr_accessor :gross_earnings
+
+    # Year-to-date net (take home) earnings.
+    # @return [Float]
+    attr_accessor :net_earnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross_earnings'] = 'gross_earnings'
+      @_hash['net_earnings'] = 'net_earnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        gross_earnings
+        net_earnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        gross_earnings
+        net_earnings
+      ]
+    end
+
+    def initialize(gross_earnings: SKIP, net_earnings: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @gross_earnings = gross_earnings unless gross_earnings == SKIP
+      @net_earnings = net_earnings unless net_earnings == 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.
+      gross_earnings =
+        hash.key?('gross_earnings') ? hash['gross_earnings'] : SKIP
+      net_earnings = hash.key?('net_earnings') ? hash['net_earnings'] : 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.
+      PaystubYtdDetails.new(gross_earnings: gross_earnings,
+                            net_earnings: net_earnings,
+                            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} gross_earnings: #{@gross_earnings}, net_earnings: #{@net_earnings},"\
+      " 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} gross_earnings: #{@gross_earnings.inspect}, net_earnings:"\
+      " #{@net_earnings.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end