apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/payment_account.rb

@@ -0,0 +1,183 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # PaymentAccount Model.
+  class PaymentAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The human-readable name for the account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The banking account number associated with a particular account.
+    # @return [Object]
+    attr_accessor :account_number
+
+    # The type of account. Some account types may include subtypes.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # The balance that is available for use in asset accounts like checking and
+    # savings.
+    # `PENDING` transactions are typically (not always) taken into account with
+    # the available balance.
+    # `available_balance` will usually be a positive value for all account
+    # types, determined in the same way as the balance field.
+    # @return [Float]
+    attr_accessor :available_balance
+
+    # The current balance of the account.
+    # `PENDING` transactions are typically not taken into account with the
+    # current balance, but this may not always be the case.
+    #     
+    # The balance will usually be a positive value for all account types.
+    # Asset-type accounts (`CHECKING`, `SAVINGS`, `INVESTMENT`) may have a
+    # negative balance if they are in overdraft.
+    # Debt-type accounts (`CREDIT_CARD`, `LOAN`, `LINE_OF_CREDIT`, `MORTGAGE`)
+    # may have a negative balance if they are overpaid.
+    # @return [Float]
+    attr_accessor :balance
+
+    # The date and time the resource was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The routing number for the `account`.
+    # @return [Object]
+    attr_accessor :routing_number
+
+    # The five-digit number identifying the branch of a Canadian financial
+    # institution.
+    # @return [Object]
+    attr_accessor :transit_number
+
+    # The date and time the resource was last updated in ISO 8601 format with a
+    # timestamp.
+    # For categories, this field will always be `null` when `is_default` is
+    # `true`.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'account_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_type'] = 'account_type'
+      @_hash['available_balance'] = 'available_balance'
+      @_hash['balance'] = 'balance'
+      @_hash['created_at'] = 'created_at'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['transit_number'] = 'transit_number'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        account_number
+        account_type
+        available_balance
+        balance
+        created_at
+        routing_number
+        transit_number
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_type
+        updated_at
+      ]
+    end
+
+    def initialize(account_name: SKIP, account_number: SKIP, account_type: SKIP,
+                   available_balance: SKIP, balance: SKIP, created_at: SKIP,
+                   routing_number: SKIP, transit_number: SKIP, updated_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @available_balance = available_balance unless available_balance == SKIP
+      @balance = balance unless balance == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+      @transit_number = transit_number unless transit_number == SKIP
+      @updated_at = updated_at unless updated_at == 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_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      available_balance =
+        hash.key?('available_balance') ? hash['available_balance'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : SKIP
+      transit_number =
+        hash.key?('transit_number') ? hash['transit_number'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : 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.
+      PaymentAccount.new(account_name: account_name,
+                         account_number: account_number,
+                         account_type: account_type,
+                         available_balance: available_balance,
+                         balance: balance,
+                         created_at: created_at,
+                         routing_number: routing_number,
+                         transit_number: transit_number,
+                         updated_at: updated_at,
+                         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_name: #{@account_name}, account_number: #{@account_number},"\
+      " account_type: #{@account_type}, available_balance: #{@available_balance}, balance:"\
+      " #{@balance}, created_at: #{@created_at}, routing_number: #{@routing_number},"\
+      " transit_number: #{@transit_number}, updated_at: #{@updated_at}, 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_name: #{@account_name.inspect}, account_number:"\
+      " #{@account_number.inspect}, account_type: #{@account_type.inspect}, available_balance:"\
+      " #{@available_balance.inspect}, balance: #{@balance.inspect}, created_at:"\
+      " #{@created_at.inspect}, routing_number: #{@routing_number.inspect}, transit_number:"\
+      " #{@transit_number.inspect}, updated_at: #{@updated_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/payment_account1.rb

@@ -0,0 +1,213 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # PaymentAccount1 Model.
+  class PaymentAccount1 < 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 human-readable name for the account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The banking account number associated with a particular account.
+    # @return [Object]
+    attr_accessor :account_number
+
+    # The type of account. Some account types may include subtypes.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # The balance that is available for use in asset accounts like checking and
+    # savings.
+    # `PENDING` transactions are typically (not always) taken into account with
+    # the available balance.
+    # `available_balance` will usually be a positive value for all account
+    # types, determined in the same way as the balance field.
+    # @return [Float]
+    attr_accessor :available_balance
+
+    # The current balance of the account.
+    # `PENDING` transactions are typically not taken into account with the
+    # current balance, but this may not always be the case.
+    #     
+    # The balance will usually be a positive value for all account types.
+    # Asset-type accounts (`CHECKING`, `SAVINGS`, `INVESTMENT`) may have a
+    # negative balance if they are in overdraft.
+    # Debt-type accounts (`CREDIT_CARD`, `LOAN`, `LINE_OF_CREDIT`, `MORTGAGE`)
+    # may have a negative balance if they are overpaid.
+    # @return [Float]
+    attr_accessor :balance
+
+    # The date and time the resource was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The routing number for the `account`.
+    # @return [Object]
+    attr_accessor :routing_number
+
+    # The five-digit number identifying the branch of a Canadian financial
+    # institution.
+    # @return [Object]
+    attr_accessor :transit_number
+
+    # The date and time the resource was last updated in ISO 8601 format with a
+    # timestamp.
+    # For categories, this field will always be `null` when `is_default` is
+    # `true`.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # 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['account_name'] = 'account_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_type'] = 'account_type'
+      @_hash['available_balance'] = 'available_balance'
+      @_hash['balance'] = 'balance'
+      @_hash['created_at'] = 'created_at'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['transit_number'] = 'transit_number'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        member_guid
+        user_guid
+        account_name
+        account_number
+        account_type
+        available_balance
+        balance
+        created_at
+        routing_number
+        transit_number
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_type
+        updated_at
+      ]
+    end
+
+    def initialize(account_guid: SKIP, member_guid: SKIP, user_guid: SKIP,
+                   account_name: SKIP, account_number: SKIP, account_type: SKIP,
+                   available_balance: SKIP, balance: SKIP, created_at: SKIP,
+                   routing_number: SKIP, transit_number: SKIP, updated_at: 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
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @available_balance = available_balance unless available_balance == SKIP
+      @balance = balance unless balance == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+      @transit_number = transit_number unless transit_number == SKIP
+      @updated_at = updated_at unless updated_at == 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
+      account_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      available_balance =
+        hash.key?('available_balance') ? hash['available_balance'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : SKIP
+      transit_number =
+        hash.key?('transit_number') ? hash['transit_number'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : 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.
+      PaymentAccount1.new(account_guid: account_guid,
+                          member_guid: member_guid,
+                          user_guid: user_guid,
+                          account_name: account_name,
+                          account_number: account_number,
+                          account_type: account_type,
+                          available_balance: available_balance,
+                          balance: balance,
+                          created_at: created_at,
+                          routing_number: routing_number,
+                          transit_number: transit_number,
+                          updated_at: updated_at,
+                          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}, account_name: #{@account_name}, account_number: #{@account_number},"\
+      " account_type: #{@account_type}, available_balance: #{@available_balance}, balance:"\
+      " #{@balance}, created_at: #{@created_at}, routing_number: #{@routing_number},"\
+      " transit_number: #{@transit_number}, updated_at: #{@updated_at}, 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}, account_name:"\
+      " #{@account_name.inspect}, account_number: #{@account_number.inspect}, account_type:"\
+      " #{@account_type.inspect}, available_balance: #{@available_balance.inspect}, balance:"\
+      " #{@balance.inspect}, created_at: #{@created_at.inspect}, routing_number:"\
+      " #{@routing_number.inspect}, transit_number: #{@transit_number.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/payment_account_body.rb

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

data/lib/mx_platform_api/models/processor_account_number.rb

@@ -0,0 +1,168 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # ProcessorAccountNumber Model.
+  class ProcessorAccountNumber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The banking account number associated with a particular account.
+    # @return [Integer]
+    attr_accessor :account_number
+
+    # The unique identifier for the account number. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The three-digit number identifying a Canadian banking institution.
+    # @return [Object]
+    attr_accessor :institution_number
+
+    # The guarantor of the student loan.
+    # @return [Object]
+    attr_accessor :loan_guarantor
+
+    # The reference number for the student loan.
+    # @return [Object]
+    attr_accessor :loan_reference_number
+
+    # Indicates whether the account number has passed validation.
+    # @return [Object]
+    attr_accessor :passed_validation
+
+    # The routing number for the `account`.
+    # @return [Integer]
+    attr_accessor :routing_number
+
+    # The sequence number for the account.
+    # @return [Object]
+    attr_accessor :sequence_number
+
+    # The five-digit number identifying the branch of a Canadian financial
+    # institution.
+    # @return [Object]
+    attr_accessor :transit_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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['passed_validation'] = 'passed_validation'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['sequence_number'] = 'sequence_number'
+      @_hash['transit_number'] = 'transit_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        guid
+        institution_number
+        loan_guarantor
+        loan_reference_number
+        passed_validation
+        routing_number
+        sequence_number
+        transit_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number: SKIP, guid: SKIP, institution_number: SKIP,
+                   loan_guarantor: SKIP, loan_reference_number: SKIP,
+                   passed_validation: SKIP, routing_number: SKIP,
+                   sequence_number: SKIP, transit_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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
+      @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
+      @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_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
+      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
+
+      # 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.
+      ProcessorAccountNumber.new(account_number: account_number,
+                                 guid: guid,
+                                 institution_number: institution_number,
+                                 loan_guarantor: loan_guarantor,
+                                 loan_reference_number: loan_reference_number,
+                                 passed_validation: passed_validation,
+                                 routing_number: routing_number,
+                                 sequence_number: sequence_number,
+                                 transit_number: transit_number,
+                                 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_number: #{@account_number}, guid: #{@guid}, institution_number:"\
+      " #{@institution_number}, loan_guarantor: #{@loan_guarantor}, loan_reference_number:"\
+      " #{@loan_reference_number}, passed_validation: #{@passed_validation}, routing_number:"\
+      " #{@routing_number}, sequence_number: #{@sequence_number}, transit_number:"\
+      " #{@transit_number}, 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_number: #{@account_number.inspect}, guid: #{@guid.inspect},"\
+      " institution_number: #{@institution_number.inspect}, loan_guarantor:"\
+      " #{@loan_guarantor.inspect}, loan_reference_number: #{@loan_reference_number.inspect},"\
+      " passed_validation: #{@passed_validation.inspect}, routing_number:"\
+      " #{@routing_number.inspect}, sequence_number: #{@sequence_number.inspect}, transit_number:"\
+      " #{@transit_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end