fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payment_amounts2.rb

@@ -0,0 +1,133 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Gross pay for covered period
+  class PaymentAmounts2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total gross pay for covered period
+    # @return [MonetaryAmount1]
+    attr_accessor :total
+
+    # Base pay part of Gross pay for covered period
+    # @return [MonetaryAmount2]
+    attr_accessor :base
+
+    # Bonus pay for covered period
+    # @return [MonetaryAmount3]
+    attr_accessor :bonus
+
+    # Commission for covered period
+    # @return [MonetaryAmount4]
+    attr_accessor :commission
+
+    # Overtime pay for covered period
+    # @return [MonetaryAmount5]
+    attr_accessor :overtime
+
+    # Other earnings received in covered period
+    # @return [Array[OtherMonetaryAmount]]
+    attr_accessor :other_earnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total'] = 'total'
+      @_hash['base'] = 'base'
+      @_hash['bonus'] = 'bonus'
+      @_hash['commission'] = 'commission'
+      @_hash['overtime'] = 'overtime'
+      @_hash['other_earnings'] = 'otherEarnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        base
+        bonus
+        commission
+        overtime
+        other_earnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total:, base: SKIP, bonus: SKIP, commission: SKIP,
+                   overtime: SKIP, other_earnings: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total = total
+      @base = base unless base == SKIP
+      @bonus = bonus unless bonus == SKIP
+      @commission = commission unless commission == SKIP
+      @overtime = overtime unless overtime == SKIP
+      @other_earnings = other_earnings unless other_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.
+      total = MonetaryAmount1.from_hash(hash['total']) if hash['total']
+      base = MonetaryAmount2.from_hash(hash['base']) if hash['base']
+      bonus = MonetaryAmount3.from_hash(hash['bonus']) if hash['bonus']
+      commission = MonetaryAmount4.from_hash(hash['commission']) if hash['commission']
+      overtime = MonetaryAmount5.from_hash(hash['overtime']) if hash['overtime']
+      # Parameter is an array, so we need to iterate through it
+      other_earnings = nil
+      unless hash['otherEarnings'].nil?
+        other_earnings = []
+        hash['otherEarnings'].each do |structure|
+          other_earnings << (OtherMonetaryAmount.from_hash(structure) if structure)
+        end
+      end
+
+      other_earnings = SKIP unless hash.key?('otherEarnings')
+
+      # 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.
+      PaymentAmounts2.new(total: total,
+                          base: base,
+                          bonus: bonus,
+                          commission: commission,
+                          overtime: overtime,
+                          other_earnings: other_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} total: #{@total}, base: #{@base}, bonus: #{@bonus}, commission:"\
+      " #{@commission}, overtime: #{@overtime}, other_earnings: #{@other_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} total: #{@total.inspect}, base: #{@base.inspect}, bonus: #{@bonus.inspect},"\
+      " commission: #{@commission.inspect}, overtime: #{@overtime.inspect}, other_earnings:"\
+      " #{@other_earnings.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_amounts3.rb

@@ -0,0 +1,92 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Year to date amounts for current and previous years
+  class PaymentAmounts3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The year in which this income was earned
+    # @return [Integer]
+    attr_accessor :year
+
+    # Gross pay for covered period
+    # @return [PaymentAmounts2]
+    attr_accessor :gross_pay
+
+    # Net pay for covered period
+    # @return [MonetaryAmount6]
+    attr_accessor :net_pay
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['year'] = 'year'
+      @_hash['gross_pay'] = 'grossPay'
+      @_hash['net_pay'] = 'netPay'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        net_pay
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(year:, gross_pay:, net_pay: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @year = year
+      @gross_pay = gross_pay
+      @net_pay = net_pay unless net_pay == 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.
+      year = hash.key?('year') ? hash['year'] : nil
+      gross_pay = PaymentAmounts2.from_hash(hash['grossPay']) if hash['grossPay']
+      net_pay = MonetaryAmount6.from_hash(hash['netPay']) if hash['netPay']
+
+      # 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.
+      PaymentAmounts3.new(year: year,
+                          gross_pay: gross_pay,
+                          net_pay: net_pay,
+                          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} year: #{@year}, gross_pay: #{@gross_pay}, net_pay: #{@net_pay},"\
+      " 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} year: #{@year.inspect}, gross_pay: #{@gross_pay.inspect}, net_pay:"\
+      " #{@net_pay.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_delivery_address_entity.rb

@@ -0,0 +1,99 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A single location for a party. A party (e.g. Branch) can have multiple
+  # registered locations; street addresses, email addresses and/or telephone
+  # numbers
+  class PaymentDeliveryAddressEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of delivery address
+    # @return [DeliveryAddressType]
+    attr_accessor :type
+
+    # Value of the address
+    # @return [Object]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      address = hash.key?('address') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentDeliveryAddressEntityAddress), hash['address']
+      ) : 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.
+      PaymentDeliveryAddressEntity.new(type: type,
+                                       address: address,
+                                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentDeliveryAddressEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, 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} type: #{@type.inspect}, address: #{@address.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_details_entity.rb

@@ -0,0 +1,142 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Breakdown of payment details
+  class PaymentDetailsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount of payment applied to principal
+    # @return [Float]
+    attr_accessor :principal_amount
+
+    # The amount of payment applied to interest
+    # @return [Float]
+    attr_accessor :interest_amount
+
+    # The amount of payment applied to life/health/accident insurance on the
+    # loan
+    # @return [Float]
+    attr_accessor :insurance_amount
+
+    # The amount of payment applied to escrow
+    # @return [Float]
+    attr_accessor :escrow_amount
+
+    # The amount of payment applied to PMI
+    # @return [Float]
+    attr_accessor :pmi_amount
+
+    # The amount of payment applied to fees
+    # @return [Float]
+    attr_accessor :fees_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['principal_amount'] = 'principalAmount'
+      @_hash['interest_amount'] = 'interestAmount'
+      @_hash['insurance_amount'] = 'insuranceAmount'
+      @_hash['escrow_amount'] = 'escrowAmount'
+      @_hash['pmi_amount'] = 'pmiAmount'
+      @_hash['fees_amount'] = 'feesAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        principal_amount
+        interest_amount
+        insurance_amount
+        escrow_amount
+        pmi_amount
+        fees_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(principal_amount: SKIP, interest_amount: SKIP,
+                   insurance_amount: SKIP, escrow_amount: SKIP,
+                   pmi_amount: SKIP, fees_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @principal_amount = principal_amount unless principal_amount == SKIP
+      @interest_amount = interest_amount unless interest_amount == SKIP
+      @insurance_amount = insurance_amount unless insurance_amount == SKIP
+      @escrow_amount = escrow_amount unless escrow_amount == SKIP
+      @pmi_amount = pmi_amount unless pmi_amount == SKIP
+      @fees_amount = fees_amount unless fees_amount == 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.
+      principal_amount =
+        hash.key?('principalAmount') ? hash['principalAmount'] : SKIP
+      interest_amount =
+        hash.key?('interestAmount') ? hash['interestAmount'] : SKIP
+      insurance_amount =
+        hash.key?('insuranceAmount') ? hash['insuranceAmount'] : SKIP
+      escrow_amount = hash.key?('escrowAmount') ? hash['escrowAmount'] : SKIP
+      pmi_amount = hash.key?('pmiAmount') ? hash['pmiAmount'] : SKIP
+      fees_amount = hash.key?('feesAmount') ? hash['feesAmount'] : 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.
+      PaymentDetailsEntity.new(principal_amount: principal_amount,
+                               interest_amount: interest_amount,
+                               insurance_amount: insurance_amount,
+                               escrow_amount: escrow_amount,
+                               pmi_amount: pmi_amount,
+                               fees_amount: fees_amount,
+                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentDetailsEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} principal_amount: #{@principal_amount}, interest_amount:"\
+      " #{@interest_amount}, insurance_amount: #{@insurance_amount}, escrow_amount:"\
+      " #{@escrow_amount}, pmi_amount: #{@pmi_amount}, fees_amount: #{@fees_amount},"\
+      " 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} principal_amount: #{@principal_amount.inspect}, interest_amount:"\
+      " #{@interest_amount.inspect}, insurance_amount: #{@insurance_amount.inspect},"\
+      " escrow_amount: #{@escrow_amount.inspect}, pmi_amount: #{@pmi_amount.inspect}, fees_amount:"\
+      " #{@fees_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end