apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/account_number_response.rb

@@ -0,0 +1,215 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountNumberResponse Model.
+  class AccountNumberResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The account number associated with the account. This will typically be a
+    # masked or partial account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Unique identifier for the account number. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The three-digit number identifying a Canadian banking institution.
+    # @return [String]
+    attr_accessor :institution_number
+
+    # The guarantor of the student loan.
+    # @return [String]
+    attr_accessor :loan_guarantor
+
+    # The reference number of the student loan.
+    # @return [String]
+    attr_accessor :loan_reference_number
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # This indicates whether the account and routing numbers passed MX's
+    # internal validity checks. If true, the account and routing/transit numbers
+    # are likely (but not guaranteed) to be valid. If false, either the account
+    # number, routing/transit number, or both are likely invalid.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :passed_validation
+
+    # The routing number for the `account`.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # The sequence number of the student loan.
+    # @return [String]
+    attr_accessor :sequence_number
+
+    # The five-digit number identifying the branch of a Canadian financial
+    # institution.
+    # @return [String]
+    attr_accessor :transit_number
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['account_number'] = 'account_number'
+      @_hash['guid'] = 'guid'
+      @_hash['institution_number'] = 'institution_number'
+      @_hash['loan_guarantor'] = 'loan_guarantor'
+      @_hash['loan_reference_number'] = 'loan_reference_number'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['passed_validation'] = 'passed_validation'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['sequence_number'] = 'sequence_number'
+      @_hash['transit_number'] = 'transit_number'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        account_number
+        guid
+        institution_number
+        loan_guarantor
+        loan_reference_number
+        member_guid
+        passed_validation
+        routing_number
+        sequence_number
+        transit_number
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_number
+        guid
+        institution_number
+        loan_guarantor
+        loan_reference_number
+        member_guid
+        passed_validation
+        routing_number
+        sequence_number
+        transit_number
+        user_guid
+      ]
+    end
+
+    def initialize(account_guid: SKIP, account_number: SKIP, guid: SKIP,
+                   institution_number: SKIP, loan_guarantor: SKIP,
+                   loan_reference_number: SKIP, member_guid: SKIP,
+                   passed_validation: SKIP, routing_number: SKIP,
+                   sequence_number: SKIP, transit_number: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @guid = guid unless guid == SKIP
+      @institution_number = institution_number unless institution_number == SKIP
+      @loan_guarantor = loan_guarantor unless loan_guarantor == SKIP
+      @loan_reference_number = loan_reference_number unless loan_reference_number == SKIP
+      @member_guid = member_guid unless member_guid == SKIP
+      @passed_validation = passed_validation unless passed_validation == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+      @sequence_number = sequence_number unless sequence_number == SKIP
+      @transit_number = transit_number unless transit_number == SKIP
+      @user_guid = user_guid unless user_guid == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      institution_number =
+        hash.key?('institution_number') ? hash['institution_number'] : SKIP
+      loan_guarantor =
+        hash.key?('loan_guarantor') ? hash['loan_guarantor'] : SKIP
+      loan_reference_number =
+        hash.key?('loan_reference_number') ? hash['loan_reference_number'] : SKIP
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : SKIP
+      passed_validation =
+        hash.key?('passed_validation') ? hash['passed_validation'] : SKIP
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : SKIP
+      sequence_number =
+        hash.key?('sequence_number') ? hash['sequence_number'] : SKIP
+      transit_number =
+        hash.key?('transit_number') ? hash['transit_number'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : 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.
+      AccountNumberResponse.new(account_guid: account_guid,
+                                account_number: account_number,
+                                guid: guid,
+                                institution_number: institution_number,
+                                loan_guarantor: loan_guarantor,
+                                loan_reference_number: loan_reference_number,
+                                member_guid: member_guid,
+                                passed_validation: passed_validation,
+                                routing_number: routing_number,
+                                sequence_number: sequence_number,
+                                transit_number: transit_number,
+                                user_guid: user_guid,
+                                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} account_guid: #{@account_guid}, account_number: #{@account_number}, guid:"\
+      " #{@guid}, institution_number: #{@institution_number}, loan_guarantor: #{@loan_guarantor},"\
+      " loan_reference_number: #{@loan_reference_number}, member_guid: #{@member_guid},"\
+      " passed_validation: #{@passed_validation}, routing_number: #{@routing_number},"\
+      " sequence_number: #{@sequence_number}, transit_number: #{@transit_number}, user_guid:"\
+      " #{@user_guid}, 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} account_guid: #{@account_guid.inspect}, account_number:"\
+      " #{@account_number.inspect}, guid: #{@guid.inspect}, institution_number:"\
+      " #{@institution_number.inspect}, loan_guarantor: #{@loan_guarantor.inspect},"\
+      " loan_reference_number: #{@loan_reference_number.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, passed_validation: #{@passed_validation.inspect}, routing_number:"\
+      " #{@routing_number.inspect}, sequence_number: #{@sequence_number.inspect}, transit_number:"\
+      " #{@transit_number.inspect}, user_guid: #{@user_guid.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/account_numbers_response_body.rb

@@ -0,0 +1,95 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountNumbersResponseBody Model.
+  class AccountNumbersResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountNumberResponse]]
+    attr_accessor :account_numbers
+
+    # TODO: Write general description for this method
+    # @return [PaginationResponse]
+    attr_accessor :pagination
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_numbers'] = 'account_numbers'
+      @_hash['pagination'] = 'pagination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_numbers
+        pagination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_numbers: SKIP, pagination: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_numbers = account_numbers unless account_numbers == SKIP
+      @pagination = pagination unless pagination == 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
+      account_numbers = nil
+      unless hash['account_numbers'].nil?
+        account_numbers = []
+        hash['account_numbers'].each do |structure|
+          account_numbers << (AccountNumberResponse.from_hash(structure) if structure)
+        end
+      end
+
+      account_numbers = SKIP unless hash.key?('account_numbers')
+      pagination = PaginationResponse.from_hash(hash['pagination']) if hash['pagination']
+
+      # 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.
+      AccountNumbersResponseBody.new(account_numbers: account_numbers,
+                                     pagination: pagination,
+                                     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} account_numbers: #{@account_numbers}, pagination: #{@pagination},"\
+      " 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} account_numbers: #{@account_numbers.inspect}, pagination:"\
+      " #{@pagination.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/account_owner.rb

@@ -0,0 +1,186 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountOwner Model.
+  class AccountOwner < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # The unique identifier for an account owner. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The account owner's name.
+    # @return [String]
+    attr_accessor :owner_name
+
+    # The account owner's street address.
+    # @return [String]
+    attr_accessor :address
+
+    # The account owner's city.
+    # @return [String]
+    attr_accessor :city
+
+    # The account owner's state.
+    # @return [String]
+    attr_accessor :state
+
+    # The account owner's postal code.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The country name.
+    # @return [String]
+    attr_accessor :country
+
+    # The email address associated with the account.
+    # @return [String]
+    attr_accessor :email
+
+    # The phone number associated with the account owner.
+    # @return [String]
+    attr_accessor :phone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['guid'] = 'guid'
+      @_hash['owner_name'] = 'owner_name'
+      @_hash['address'] = 'address'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash['email'] = 'email'
+      @_hash['phone'] = 'phone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        member_guid
+        user_guid
+        guid
+        owner_name
+        address
+        city
+        state
+        postal_code
+        country
+        email
+        phone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        country
+      ]
+    end
+
+    def initialize(account_guid: SKIP, member_guid: SKIP, user_guid: SKIP,
+                   guid: SKIP, owner_name: SKIP, address: SKIP, city: SKIP,
+                   state: SKIP, postal_code: SKIP, country: SKIP, email: SKIP,
+                   phone: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @member_guid = member_guid unless member_guid == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      @guid = guid unless guid == SKIP
+      @owner_name = owner_name unless owner_name == SKIP
+      @address = address unless address == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @email = email unless email == SKIP
+      @phone = phone unless phone == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      owner_name = hash.key?('owner_name') ? hash['owner_name'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : 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.
+      AccountOwner.new(account_guid: account_guid,
+                       member_guid: member_guid,
+                       user_guid: user_guid,
+                       guid: guid,
+                       owner_name: owner_name,
+                       address: address,
+                       city: city,
+                       state: state,
+                       postal_code: postal_code,
+                       country: country,
+                       email: email,
+                       phone: phone,
+                       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} account_guid: #{@account_guid}, member_guid: #{@member_guid}, user_guid:"\
+      " #{@user_guid}, guid: #{@guid}, owner_name: #{@owner_name}, address: #{@address}, city:"\
+      " #{@city}, state: #{@state}, postal_code: #{@postal_code}, country: #{@country}, email:"\
+      " #{@email}, phone: #{@phone}, 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} account_guid: #{@account_guid.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, user_guid: #{@user_guid.inspect}, guid: #{@guid.inspect},"\
+      " owner_name: #{@owner_name.inspect}, address: #{@address.inspect}, city: #{@city.inspect},"\
+      " state: #{@state.inspect}, postal_code: #{@postal_code.inspect}, country:"\
+      " #{@country.inspect}, email: #{@email.inspect}, phone: #{@phone.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end