apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/account_create_request.rb

@@ -0,0 +1,309 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountCreateRequest Model.
+  class AccountCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account's subtype, for example, `PLAN_401_K`, `MONEY_MARKET`, or
+    # `HOME_EQUITY`. Each subtype belongs to an account `type`. For a full list
+    # of account subtypes and types, see
+    # [Accounts](/api-reference/platform-api/reference/account-types).
+    # @return [String]
+    attr_accessor :account_subtype
+
+    # The type of account. Some account types may include subtypes.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # The annual percentage rate associated with the `account`.
+    # @return [Float]
+    attr_accessor :apr
+
+    # The annual percentage yield associated with the `account`.
+    # @return [Float]
+    attr_accessor :apy
+
+    # 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 sum of money paid to the policyholder or annuity holder in the event
+    # the policy is voluntarily terminated before it matures, or the insured
+    # event occurs.
+    # @return [Float]
+    attr_accessor :cash_surrender_value
+
+    # The credit limit associated with the `account`.
+    # @return [Float]
+    attr_accessor :credit_limit
+
+    # The three-character ISO 4217 currency code, for example, `USD`.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # The amount paid to the beneficiary of the account upon death of the
+    # account owner.
+    # @return [Integer]
+    attr_accessor :death_benefit
+
+    # The interest rate associated with the account.
+    # @return [Float]
+    attr_accessor :interest_rate
+
+    # Indicates whether the account is a business account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_business
+
+    # Indicates whether an account has been closed. Closed accounts will no
+    # longer update balance or transaction information.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_closed
+
+    # Indicates whether the account is hidden. Hidden accounts can still have an
+    # active balance and receive transactions. Defaults to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_hidden
+
+    # The amount of the loan associated with the `account`.
+    # @return [Float]
+    attr_accessor :loan_amount
+
+    # Additional information you can store about the `account`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The human-readable name for the `account`.
+    # @return [String]
+    attr_accessor :name
+
+    # An alternate name for the `account`.
+    # @return [String]
+    attr_accessor :nickname
+
+    # The original balance associated with the `account`. This will always be
+    # positive.
+    # @return [Float]
+    attr_accessor :original_balance
+
+    # Subtype if the account type is `PROPERTY`. This field should be ignored
+    # unless the type is set to `PROPERTY`.
+    # @return [PropertyType]
+    attr_accessor :property_type
+
+    # If set to `true`, prevents sending an account webhook for the update if
+    # that webhook type is enabled for you.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_webhook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_subtype'] = 'account_subtype'
+      @_hash['account_type'] = 'account_type'
+      @_hash['apr'] = 'apr'
+      @_hash['apy'] = 'apy'
+      @_hash['available_balance'] = 'available_balance'
+      @_hash['balance'] = 'balance'
+      @_hash['cash_surrender_value'] = 'cash_surrender_value'
+      @_hash['credit_limit'] = 'credit_limit'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['death_benefit'] = 'death_benefit'
+      @_hash['interest_rate'] = 'interest_rate'
+      @_hash['is_business'] = 'is_business'
+      @_hash['is_closed'] = 'is_closed'
+      @_hash['is_hidden'] = 'is_hidden'
+      @_hash['loan_amount'] = 'loan_amount'
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash['nickname'] = 'nickname'
+      @_hash['original_balance'] = 'original_balance'
+      @_hash['property_type'] = 'property_type'
+      @_hash['skip_webhook'] = 'skip_webhook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_subtype
+        apr
+        apy
+        available_balance
+        balance
+        cash_surrender_value
+        credit_limit
+        currency_code
+        death_benefit
+        interest_rate
+        is_business
+        is_closed
+        is_hidden
+        loan_amount
+        metadata
+        nickname
+        original_balance
+        property_type
+        skip_webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_subtype
+        account_type
+        currency_code
+      ]
+    end
+
+    def initialize(account_type:, name:, account_subtype: SKIP, apr: SKIP,
+                   apy: SKIP, available_balance: SKIP, balance: SKIP,
+                   cash_surrender_value: SKIP, credit_limit: SKIP,
+                   currency_code: SKIP, death_benefit: SKIP,
+                   interest_rate: SKIP, is_business: SKIP, is_closed: SKIP,
+                   is_hidden: SKIP, loan_amount: SKIP, metadata: SKIP,
+                   nickname: SKIP, original_balance: SKIP, property_type: SKIP,
+                   skip_webhook: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_subtype = account_subtype unless account_subtype == SKIP
+      @account_type = account_type
+      @apr = apr unless apr == SKIP
+      @apy = apy unless apy == SKIP
+      @available_balance = available_balance unless available_balance == SKIP
+      @balance = balance unless balance == SKIP
+      @cash_surrender_value = cash_surrender_value unless cash_surrender_value == SKIP
+      @credit_limit = credit_limit unless credit_limit == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @death_benefit = death_benefit unless death_benefit == SKIP
+      @interest_rate = interest_rate unless interest_rate == SKIP
+      @is_business = is_business unless is_business == SKIP
+      @is_closed = is_closed unless is_closed == SKIP
+      @is_hidden = is_hidden unless is_hidden == SKIP
+      @loan_amount = loan_amount unless loan_amount == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @name = name
+      @nickname = nickname unless nickname == SKIP
+      @original_balance = original_balance unless original_balance == SKIP
+      @property_type = property_type unless property_type == SKIP
+      @skip_webhook = skip_webhook unless skip_webhook == 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_type = hash.key?('account_type') ? hash['account_type'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      account_subtype =
+        hash.key?('account_subtype') ? hash['account_subtype'] : SKIP
+      apr = hash.key?('apr') ? hash['apr'] : SKIP
+      apy = hash.key?('apy') ? hash['apy'] : SKIP
+      available_balance =
+        hash.key?('available_balance') ? hash['available_balance'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      cash_surrender_value =
+        hash.key?('cash_surrender_value') ? hash['cash_surrender_value'] : SKIP
+      credit_limit = hash.key?('credit_limit') ? hash['credit_limit'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+      death_benefit = hash.key?('death_benefit') ? hash['death_benefit'] : SKIP
+      interest_rate = hash.key?('interest_rate') ? hash['interest_rate'] : SKIP
+      is_business = hash.key?('is_business') ? hash['is_business'] : SKIP
+      is_closed = hash.key?('is_closed') ? hash['is_closed'] : SKIP
+      is_hidden = hash.key?('is_hidden') ? hash['is_hidden'] : SKIP
+      loan_amount = hash.key?('loan_amount') ? hash['loan_amount'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      nickname = hash.key?('nickname') ? hash['nickname'] : SKIP
+      original_balance =
+        hash.key?('original_balance') ? hash['original_balance'] : SKIP
+      property_type = hash.key?('property_type') ? hash['property_type'] : SKIP
+      skip_webhook = hash.key?('skip_webhook') ? hash['skip_webhook'] : 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.
+      AccountCreateRequest.new(account_type: account_type,
+                               name: name,
+                               account_subtype: account_subtype,
+                               apr: apr,
+                               apy: apy,
+                               available_balance: available_balance,
+                               balance: balance,
+                               cash_surrender_value: cash_surrender_value,
+                               credit_limit: credit_limit,
+                               currency_code: currency_code,
+                               death_benefit: death_benefit,
+                               interest_rate: interest_rate,
+                               is_business: is_business,
+                               is_closed: is_closed,
+                               is_hidden: is_hidden,
+                               loan_amount: loan_amount,
+                               metadata: metadata,
+                               nickname: nickname,
+                               original_balance: original_balance,
+                               property_type: property_type,
+                               skip_webhook: skip_webhook,
+                               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_subtype: #{@account_subtype}, account_type: #{@account_type}, apr:"\
+      " #{@apr}, apy: #{@apy}, available_balance: #{@available_balance}, balance: #{@balance},"\
+      " cash_surrender_value: #{@cash_surrender_value}, credit_limit: #{@credit_limit},"\
+      " currency_code: #{@currency_code}, death_benefit: #{@death_benefit}, interest_rate:"\
+      " #{@interest_rate}, is_business: #{@is_business}, is_closed: #{@is_closed}, is_hidden:"\
+      " #{@is_hidden}, loan_amount: #{@loan_amount}, metadata: #{@metadata}, name: #{@name},"\
+      " nickname: #{@nickname}, original_balance: #{@original_balance}, property_type:"\
+      " #{@property_type}, skip_webhook: #{@skip_webhook}, 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_subtype: #{@account_subtype.inspect}, account_type:"\
+      " #{@account_type.inspect}, apr: #{@apr.inspect}, apy: #{@apy.inspect}, available_balance:"\
+      " #{@available_balance.inspect}, balance: #{@balance.inspect}, cash_surrender_value:"\
+      " #{@cash_surrender_value.inspect}, credit_limit: #{@credit_limit.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, death_benefit: #{@death_benefit.inspect}, interest_rate:"\
+      " #{@interest_rate.inspect}, is_business: #{@is_business.inspect}, is_closed:"\
+      " #{@is_closed.inspect}, is_hidden: #{@is_hidden.inspect}, loan_amount:"\
+      " #{@loan_amount.inspect}, metadata: #{@metadata.inspect}, name: #{@name.inspect}, nickname:"\
+      " #{@nickname.inspect}, original_balance: #{@original_balance.inspect}, property_type:"\
+      " #{@property_type.inspect}, skip_webhook: #{@skip_webhook.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/account_create_request_body.rb

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

data/lib/mx_platform_api/models/account_number.rb

@@ -0,0 +1,199 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountNumber Model.
+  class AccountNumber < 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 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_guid'] = 'account_guid'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['user_guid'] = 'user_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['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_guid
+        member_guid
+        user_guid
+        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_guid: SKIP, member_guid: SKIP, user_guid: SKIP,
+                   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_guid = account_guid unless account_guid == SKIP
+      @member_guid = member_guid unless member_guid == SKIP
+      @user_guid = user_guid unless user_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
+      @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_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_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.
+      AccountNumber.new(account_guid: account_guid,
+                        member_guid: member_guid,
+                        user_guid: user_guid,
+                        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_guid: #{@account_guid}, member_guid: #{@member_guid}, user_guid:"\
+      " #{@user_guid}, 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_guid: #{@account_guid.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, user_guid: #{@user_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}, 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