fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/bill_entity.rb

@@ -0,0 +1,206 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A statement of a payment due on an account
+  class BillEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total payment due or next payment due as it appears on the account
+    # statement. Monthly payment due for loans. May be the same amount as the
+    # `statementBalance`
+    # @return [Float]
+    attr_accessor :total_payment_due
+
+    # The minimum amount which is due on the account statement
+    # @return [Float]
+    attr_accessor :minimum_payment_due
+
+    # The date that the payment is due as indicated on the statement
+    # @return [Date]
+    attr_accessor :due_date
+
+    # Whether the user's bill is paid automatically as indicated on the
+    # statement
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_pay_enabled
+
+    # The amount of money the user has set to autopay this bill as indicated on
+    # the statement
+    # @return [Float]
+    attr_accessor :auto_pay_amount
+
+    # The date the autopayment is set to trigger for this bill as indicated on
+    # the statement
+    # @return [Date]
+    attr_accessor :auto_pay_date
+
+    # The amount that the user should have already paid as it appears on the
+    # statement. The value is negative if the user owes money
+    # @return [Float]
+    attr_accessor :past_due_amount
+
+    # The amount of the most recent payment as indicated on the statement
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # The date of most recent payment as indicated on the statement
+    # @return [Date]
+    attr_accessor :last_payment_date
+
+    # The amount of the last statement. The value is negative if the user owes
+    # money
+    # @return [Float]
+    attr_accessor :statement_balance
+
+    # The date the statement was issued
+    # @return [Date]
+    attr_accessor :statement_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_payment_due'] = 'totalPaymentDue'
+      @_hash['minimum_payment_due'] = 'minimumPaymentDue'
+      @_hash['due_date'] = 'dueDate'
+      @_hash['auto_pay_enabled'] = 'autoPayEnabled'
+      @_hash['auto_pay_amount'] = 'autoPayAmount'
+      @_hash['auto_pay_date'] = 'autoPayDate'
+      @_hash['past_due_amount'] = 'pastDueAmount'
+      @_hash['last_payment_amount'] = 'lastPaymentAmount'
+      @_hash['last_payment_date'] = 'lastPaymentDate'
+      @_hash['statement_balance'] = 'statementBalance'
+      @_hash['statement_date'] = 'statementDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_payment_due
+        minimum_payment_due
+        due_date
+        auto_pay_enabled
+        auto_pay_amount
+        auto_pay_date
+        past_due_amount
+        last_payment_amount
+        last_payment_date
+        statement_balance
+        statement_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_payment_due: SKIP, minimum_payment_due: SKIP,
+                   due_date: SKIP, auto_pay_enabled: SKIP,
+                   auto_pay_amount: SKIP, auto_pay_date: SKIP,
+                   past_due_amount: SKIP, last_payment_amount: SKIP,
+                   last_payment_date: SKIP, statement_balance: SKIP,
+                   statement_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_payment_due = total_payment_due unless total_payment_due == SKIP
+      @minimum_payment_due = minimum_payment_due unless minimum_payment_due == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @auto_pay_enabled = auto_pay_enabled unless auto_pay_enabled == SKIP
+      @auto_pay_amount = auto_pay_amount unless auto_pay_amount == SKIP
+      @auto_pay_date = auto_pay_date unless auto_pay_date == SKIP
+      @past_due_amount = past_due_amount unless past_due_amount == SKIP
+      @last_payment_amount = last_payment_amount unless last_payment_amount == SKIP
+      @last_payment_date = last_payment_date unless last_payment_date == SKIP
+      @statement_balance = statement_balance unless statement_balance == SKIP
+      @statement_date = statement_date unless statement_date == 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_payment_due =
+        hash.key?('totalPaymentDue') ? hash['totalPaymentDue'] : SKIP
+      minimum_payment_due =
+        hash.key?('minimumPaymentDue') ? hash['minimumPaymentDue'] : SKIP
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : SKIP
+      auto_pay_enabled =
+        hash.key?('autoPayEnabled') ? hash['autoPayEnabled'] : SKIP
+      auto_pay_amount =
+        hash.key?('autoPayAmount') ? hash['autoPayAmount'] : SKIP
+      auto_pay_date = hash.key?('autoPayDate') ? hash['autoPayDate'] : SKIP
+      past_due_amount =
+        hash.key?('pastDueAmount') ? hash['pastDueAmount'] : SKIP
+      last_payment_amount =
+        hash.key?('lastPaymentAmount') ? hash['lastPaymentAmount'] : SKIP
+      last_payment_date =
+        hash.key?('lastPaymentDate') ? hash['lastPaymentDate'] : SKIP
+      statement_balance =
+        hash.key?('statementBalance') ? hash['statementBalance'] : SKIP
+      statement_date = hash.key?('statementDate') ? hash['statementDate'] : 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.
+      BillEntity.new(total_payment_due: total_payment_due,
+                     minimum_payment_due: minimum_payment_due,
+                     due_date: due_date,
+                     auto_pay_enabled: auto_pay_enabled,
+                     auto_pay_amount: auto_pay_amount,
+                     auto_pay_date: auto_pay_date,
+                     past_due_amount: past_due_amount,
+                     last_payment_amount: last_payment_amount,
+                     last_payment_date: last_payment_date,
+                     statement_balance: statement_balance,
+                     statement_date: statement_date,
+                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BillEntity | 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} total_payment_due: #{@total_payment_due}, minimum_payment_due:"\
+      " #{@minimum_payment_due}, due_date: #{@due_date}, auto_pay_enabled: #{@auto_pay_enabled},"\
+      " auto_pay_amount: #{@auto_pay_amount}, auto_pay_date: #{@auto_pay_date}, past_due_amount:"\
+      " #{@past_due_amount}, last_payment_amount: #{@last_payment_amount}, last_payment_date:"\
+      " #{@last_payment_date}, statement_balance: #{@statement_balance}, statement_date:"\
+      " #{@statement_date}, 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_payment_due: #{@total_payment_due.inspect}, minimum_payment_due:"\
+      " #{@minimum_payment_due.inspect}, due_date: #{@due_date.inspect}, auto_pay_enabled:"\
+      " #{@auto_pay_enabled.inspect}, auto_pay_amount: #{@auto_pay_amount.inspect}, auto_pay_date:"\
+      " #{@auto_pay_date.inspect}, past_due_amount: #{@past_due_amount.inspect},"\
+      " last_payment_amount: #{@last_payment_amount.inspect}, last_payment_date:"\
+      " #{@last_payment_date.inspect}, statement_balance: #{@statement_balance.inspect},"\
+      " statement_date: #{@statement_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/bond_security_entity.rb

@@ -0,0 +1,148 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'debt_security_entity'
+
+module FdxV660Api
+  # A Bond held on an investment account
+  class BondSecurityEntity < DebtSecurityEntity
+    # Face value at the time of data retrieved
+    # @return [Float]
+    attr_accessor :face_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['face_value'] = 'faceValue'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        face_value
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(face_value: SKIP, par_value: SKIP, debt_type: SKIP,
+                   debt_class: SKIP, coupon_rate: SKIP, coupon_date: SKIP,
+                   coupon_mature_frequency: SKIP, call_price: SKIP,
+                   yield_to_call: SKIP, call_date: SKIP, call_type: SKIP,
+                   yield_to_maturity: SKIP, bond_maturity_date: SKIP,
+                   security_category: 'Bond Security entity',
+                   fi_attributes: SKIP, additional_properties: nil)
+      @face_value = face_value unless face_value == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(par_value: par_value,
+            debt_type: debt_type,
+            debt_class: debt_class,
+            coupon_rate: coupon_rate,
+            coupon_date: coupon_date,
+            coupon_mature_frequency: coupon_mature_frequency,
+            call_price: call_price,
+            yield_to_call: yield_to_call,
+            call_date: call_date,
+            call_type: call_type,
+            yield_to_maturity: yield_to_maturity,
+            bond_maturity_date: bond_maturity_date,
+            security_category: security_category,
+            fi_attributes: fi_attributes,
+            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.
+      face_value = hash.key?('faceValue') ? hash['faceValue'] : SKIP
+      par_value = hash.key?('parValue') ? hash['parValue'] : SKIP
+      debt_type = hash.key?('debtType') ? hash['debtType'] : SKIP
+      debt_class = hash.key?('debtClass') ? hash['debtClass'] : SKIP
+      coupon_rate = hash.key?('couponRate') ? hash['couponRate'] : SKIP
+      coupon_date = hash.key?('couponDate') ? hash['couponDate'] : SKIP
+      coupon_mature_frequency =
+        hash.key?('couponMatureFrequency') ? hash['couponMatureFrequency'] : SKIP
+      call_price = hash.key?('callPrice') ? hash['callPrice'] : SKIP
+      yield_to_call = hash.key?('yieldToCall') ? hash['yieldToCall'] : SKIP
+      call_date = hash.key?('callDate') ? hash['callDate'] : SKIP
+      call_type = hash.key?('callType') ? hash['callType'] : SKIP
+      yield_to_maturity =
+        hash.key?('yieldToMaturity') ? hash['yieldToMaturity'] : SKIP
+      bond_maturity_date =
+        hash.key?('bondMaturityDate') ? hash['bondMaturityDate'] : SKIP
+      security_category = hash['securityCategory'] ||= 'Bond Security entity'
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # 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.
+      BondSecurityEntity.new(face_value: face_value,
+                             par_value: par_value,
+                             debt_type: debt_type,
+                             debt_class: debt_class,
+                             coupon_rate: coupon_rate,
+                             coupon_date: coupon_date,
+                             coupon_mature_frequency: coupon_mature_frequency,
+                             call_price: call_price,
+                             yield_to_call: yield_to_call,
+                             call_date: call_date,
+                             call_type: call_type,
+                             yield_to_maturity: yield_to_maturity,
+                             bond_maturity_date: bond_maturity_date,
+                             security_category: security_category,
+                             fi_attributes: fi_attributes,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BondSecurityEntity | 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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, face_value: #{@face_value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, face_value: #{@face_value.inspect}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/branch_entity.rb

@@ -0,0 +1,116 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Details on the Branch that is owning the destination account
+  class BranchEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Branch number
+    # @return [String]
+    attr_accessor :branch_id
+
+    # Name of the branch
+    # @return [String]
+    attr_accessor :name
+
+    # Location of the branch
+    # @return [Array[PaymentDeliveryAddressEntity]]
+    attr_accessor :locations
+
+    # Financial institution associated with the branch
+    # @return [FinancialInstitutionEntity2]
+    attr_accessor :financial_institution
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['branch_id'] = 'branchId'
+      @_hash['name'] = 'name'
+      @_hash['locations'] = 'locations'
+      @_hash['financial_institution'] = 'financialInstitution'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        branch_id
+        name
+        locations
+        financial_institution
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(branch_id: SKIP, name: SKIP, locations: SKIP,
+                   financial_institution: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @branch_id = branch_id unless branch_id == SKIP
+      @name = name unless name == SKIP
+      @locations = locations unless locations == SKIP
+      @financial_institution = financial_institution unless financial_institution == 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.
+      branch_id = hash.key?('branchId') ? hash['branchId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      locations = nil
+      unless hash['locations'].nil?
+        locations = []
+        hash['locations'].each do |structure|
+          locations << (PaymentDeliveryAddressEntity.from_hash(structure) if structure)
+        end
+      end
+
+      locations = SKIP unless hash.key?('locations')
+      financial_institution = FinancialInstitutionEntity2.from_hash(hash['financialInstitution']) if
+        hash['financialInstitution']
+
+      # 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.
+      BranchEntity.new(branch_id: branch_id,
+                       name: name,
+                       locations: locations,
+                       financial_institution: financial_institution,
+                       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} branch_id: #{@branch_id}, name: #{@name}, locations: #{@locations},"\
+      " financial_institution: #{@financial_institution}, 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} branch_id: #{@branch_id.inspect}, name: #{@name.inspect}, locations:"\
+      " #{@locations.inspect}, financial_institution: #{@financial_institution.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/branch_entity1.rb

@@ -0,0 +1,126 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Branch details associated with this account
+  class BranchEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Branch number
+    # @return [String]
+    attr_accessor :branch_id
+
+    # Name of the branch
+    # @return [String]
+    attr_accessor :name
+
+    # Location of the branch
+    # @return [Array[PaymentDeliveryAddressEntity]]
+    attr_accessor :locations
+
+    # Financial institution associated with the branch
+    # @return [FinancialInstitutionEntity2]
+    attr_accessor :financial_institution
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['branch_id'] = 'branchId'
+      @_hash['name'] = 'name'
+      @_hash['locations'] = 'locations'
+      @_hash['financial_institution'] = 'financialInstitution'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        branch_id
+        name
+        locations
+        financial_institution
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(branch_id: SKIP, name: SKIP, locations: SKIP,
+                   financial_institution: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @branch_id = branch_id unless branch_id == SKIP
+      @name = name unless name == SKIP
+      @locations = locations unless locations == SKIP
+      @financial_institution = financial_institution unless financial_institution == 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.
+      branch_id = hash.key?('branchId') ? hash['branchId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      locations = nil
+      unless hash['locations'].nil?
+        locations = []
+        hash['locations'].each do |structure|
+          locations << (PaymentDeliveryAddressEntity.from_hash(structure) if structure)
+        end
+      end
+
+      locations = SKIP unless hash.key?('locations')
+      financial_institution = FinancialInstitutionEntity2.from_hash(hash['financialInstitution']) if
+        hash['financialInstitution']
+
+      # 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.
+      BranchEntity1.new(branch_id: branch_id,
+                        name: name,
+                        locations: locations,
+                        financial_institution: financial_institution,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BranchEntity1 | 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} branch_id: #{@branch_id}, name: #{@name}, locations: #{@locations},"\
+      " financial_institution: #{@financial_institution}, 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} branch_id: #{@branch_id.inspect}, name: #{@name.inspect}, locations:"\
+      " #{@locations.inspect}, financial_institution: #{@financial_institution.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end