fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/basic_auth_credentials1.rb

@@ -0,0 +1,105 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The Basic Authentication credentials to retrieve a tax form
+  class BasicAuthCredentials1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # Enumerated name of the tax form entity e.g. "TaxW2"
+    # @return [TypeFormType1]
+    attr_accessor :tax_form_type
+
+    # Confidential and unique identifier of the tax form
+    # @return [String]
+    attr_accessor :id
+
+    # Unique, randomized and restricted password for this document
+    # @return [String]
+    attr_accessor :passcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_year'] = 'taxYear'
+      @_hash['tax_form_type'] = 'taxFormType'
+      @_hash['id'] = 'id'
+      @_hash['passcode'] = 'passcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_year
+        tax_form_type
+        id
+        passcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_year: SKIP, tax_form_type: SKIP, id: SKIP,
+                   passcode: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_year = tax_year unless tax_year == SKIP
+      @tax_form_type = tax_form_type unless tax_form_type == SKIP
+      @id = id unless id == SKIP
+      @passcode = passcode unless passcode == 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.
+      tax_year = hash.key?('taxYear') ? hash['taxYear'] : SKIP
+      tax_form_type = hash.key?('taxFormType') ? hash['taxFormType'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      passcode = hash.key?('passcode') ? hash['passcode'] : 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.
+      BasicAuthCredentials1.new(tax_year: tax_year,
+                                tax_form_type: tax_form_type,
+                                id: id,
+                                passcode: passcode,
+                                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} tax_year: #{@tax_year}, tax_form_type: #{@tax_form_type}, id: #{@id},"\
+      " passcode: #{@passcode}, 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} tax_year: #{@tax_year.inspect}, tax_form_type: #{@tax_form_type.inspect},"\
+      " id: #{@id.inspect}, passcode: #{@passcode.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/basic_auth_for_qr.rb

@@ -0,0 +1,96 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Tax form credentials container for QR Code purposes
+  class BasicAuthForQr < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Basic Authentication credentials to retrieve a tax form
+    # @return [BasicAuthCredentials1]
+    attr_accessor :basic_auth
+
+    # [Financial Data Exchange (FDX)](https://financialdataexchange.org/) schema
+    # version number (e.g. "V5.0").
+    # @return [FdxVersion]
+    attr_accessor :version
+
+    # The FDX registration ID of company or software generating this tax data
+    # @return [String]
+    attr_accessor :software_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['basic_auth'] = 'basicAuth'
+      @_hash['version'] = 'version'
+      @_hash['software_id'] = 'softwareId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        basic_auth
+        version
+        software_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(basic_auth: SKIP, version: SKIP, software_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @basic_auth = basic_auth unless basic_auth == SKIP
+      @version = version unless version == SKIP
+      @software_id = software_id unless software_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.
+      basic_auth = BasicAuthCredentials1.from_hash(hash['basicAuth']) if hash['basicAuth']
+      version = hash.key?('version') ? hash['version'] : SKIP
+      software_id = hash.key?('softwareId') ? hash['softwareId'] : 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.
+      BasicAuthForQr.new(basic_auth: basic_auth,
+                         version: version,
+                         software_id: software_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} basic_auth: #{@basic_auth}, version: #{@version}, software_id:"\
+      " #{@software_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} basic_auth: #{@basic_auth.inspect}, version: #{@version.inspect},"\
+      " software_id: #{@software_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/bills_entity.rb

@@ -0,0 +1,201 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The payments due on an account
+  class BillsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total payment due or next payment due.  Monthly payment due for loans
+    # @return [Float]
+    attr_accessor :total_payment_due
+
+    # The minimum amount which is due
+    # @return [Float]
+    attr_accessor :minimum_payment_due
+
+    # The date that the payment is due
+    # @return [Date]
+    attr_accessor :due_date
+
+    # Whether the user's bill is paid automatically
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_pay_enabled
+
+    # The amount of money the user has set to autopay this bill
+    # @return [Float]
+    attr_accessor :auto_pay_amount
+
+    # The date the autopayment is set to trigger for this bill
+    # @return [Date]
+    attr_accessor :auto_pay_date
+
+    # The amount that the user should have already paid. The value is negative
+    # if user owes money
+    # @return [Float]
+    attr_accessor :past_due_amount
+
+    # The amount of the most recent payment
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # The date of most recent payment
+    # @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.
+      BillsEntity.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 [BillsEntity | 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_api/models/branch_entity.rb

@@ -0,0 +1,116 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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_api/models/branch_entity1.rb

@@ -0,0 +1,126 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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