apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/managed_account_create_request.rb

@@ -0,0 +1,422 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # ManagedAccountCreateRequest Model.
+  class ManagedAccountCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account number associated with the account. This will typically be a
+    # masked or partial account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # 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 amount of credit available for use in liability accounts like credit
+    # cards and lines of credit.
+    # `PENDING` transactions are typically (not always) taken into account with
+    # available credit.
+    # `available_credit` will usually be a positive value for all account types,
+    # determined in the same way as the `balance` field.
+    # @return [Float]
+    attr_accessor :available_credit
+
+    # 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
+
+    # Can only be updated for manual accounts. 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 day of the month the payment is due. For example, the 14th is passed
+    # as `14`.
+    # @return [Integer]
+    attr_accessor :day_payment_is_due
+
+    # The amount paid to the beneficiary of the account upon death of the
+    # account owner.
+    # @return [Integer]
+    attr_accessor :death_benefit
+
+    # The unique partner-defined identifier for the account.
+    # @return [String]
+    attr_accessor :id
+
+    # The interest rate associated with the account.
+    # @return [Float]
+    attr_accessor :interest_rate
+
+    # 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 most recent payment on the `account`.
+    # @return [Float]
+    attr_accessor :last_payment
+
+    # The date and time when the last payment was made, represented in ISO 8601
+    # format with a timestamp.
+    # @return [String]
+    attr_accessor :last_payment_at
+
+    # The amount of the loan associated with the `account`.
+    # @return [Float]
+    attr_accessor :loan_amount
+
+    # The date on which the `account` matures.
+    # @return [String]
+    attr_accessor :matures_on
+
+    # Additional information you can store about the `account`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The minimum balance associated with the `account`.
+    # @return [Float]
+    attr_accessor :minimum_balance
+
+    # The minimum payment required for an account. This can apply to any debt
+    # account.
+    # @return [Float]
+    attr_accessor :minimum_payment
+
+    # The name of 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`.
+    # @return [Float]
+    attr_accessor :original_balance
+
+    # The date and time at which the next payment is due on the `account`.
+    # @return [String]
+    attr_accessor :payment_due_at
+
+    # The payoff balance for a debt account. This will normally be a positive
+    # number.
+    # @return [Float]
+    attr_accessor :payoff_balance
+
+    # The routing number for the `account`.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # The date on which the loan from a debt account started.
+    # @return [String]
+    attr_accessor :started_on
+
+    # The account's subtype, e.g., `PLAN_401_K`, `MONEY_MARKET`, or
+    # `HOME_EQUITY`.
+    # @return [String]
+    attr_accessor :subtype
+
+    # The general or parent type of the `account`.
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['apr'] = 'apr'
+      @_hash['apy'] = 'apy'
+      @_hash['available_balance'] = 'available_balance'
+      @_hash['available_credit'] = 'available_credit'
+      @_hash['balance'] = 'balance'
+      @_hash['cash_surrender_value'] = 'cash_surrender_value'
+      @_hash['credit_limit'] = 'credit_limit'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['day_payment_is_due'] = 'day_payment_is_due'
+      @_hash['death_benefit'] = 'death_benefit'
+      @_hash['id'] = 'id'
+      @_hash['interest_rate'] = 'interest_rate'
+      @_hash['is_closed'] = 'is_closed'
+      @_hash['is_hidden'] = 'is_hidden'
+      @_hash['last_payment'] = 'last_payment'
+      @_hash['last_payment_at'] = 'last_payment_at'
+      @_hash['loan_amount'] = 'loan_amount'
+      @_hash['matures_on'] = 'matures_on'
+      @_hash['metadata'] = 'metadata'
+      @_hash['minimum_balance'] = 'minimum_balance'
+      @_hash['minimum_payment'] = 'minimum_payment'
+      @_hash['name'] = 'name'
+      @_hash['nickname'] = 'nickname'
+      @_hash['original_balance'] = 'original_balance'
+      @_hash['payment_due_at'] = 'payment_due_at'
+      @_hash['payoff_balance'] = 'payoff_balance'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['started_on'] = 'started_on'
+      @_hash['subtype'] = 'subtype'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        apr
+        apy
+        available_balance
+        available_credit
+        cash_surrender_value
+        credit_limit
+        currency_code
+        day_payment_is_due
+        death_benefit
+        interest_rate
+        is_closed
+        is_hidden
+        last_payment
+        last_payment_at
+        loan_amount
+        matures_on
+        metadata
+        minimum_balance
+        minimum_payment
+        nickname
+        original_balance
+        payment_due_at
+        payoff_balance
+        routing_number
+        started_on
+        subtype
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        available_credit
+        currency_code
+        day_payment_is_due
+      ]
+    end
+
+    def initialize(balance:, id:, name:, type:, account_number: SKIP, apr: SKIP,
+                   apy: SKIP, available_balance: SKIP, available_credit: SKIP,
+                   cash_surrender_value: SKIP, credit_limit: SKIP,
+                   currency_code: SKIP, day_payment_is_due: SKIP,
+                   death_benefit: SKIP, interest_rate: SKIP, is_closed: SKIP,
+                   is_hidden: SKIP, last_payment: SKIP, last_payment_at: SKIP,
+                   loan_amount: SKIP, matures_on: SKIP, metadata: SKIP,
+                   minimum_balance: SKIP, minimum_payment: SKIP, nickname: SKIP,
+                   original_balance: SKIP, payment_due_at: SKIP,
+                   payoff_balance: SKIP, routing_number: SKIP, started_on: SKIP,
+                   subtype: 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
+      @apr = apr unless apr == SKIP
+      @apy = apy unless apy == SKIP
+      @available_balance = available_balance unless available_balance == SKIP
+      @available_credit = available_credit unless available_credit == SKIP
+      @balance = balance
+      @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
+      @day_payment_is_due = day_payment_is_due unless day_payment_is_due == SKIP
+      @death_benefit = death_benefit unless death_benefit == SKIP
+      @id = id
+      @interest_rate = interest_rate unless interest_rate == SKIP
+      @is_closed = is_closed unless is_closed == SKIP
+      @is_hidden = is_hidden unless is_hidden == SKIP
+      @last_payment = last_payment unless last_payment == SKIP
+      @last_payment_at = last_payment_at unless last_payment_at == SKIP
+      @loan_amount = loan_amount unless loan_amount == SKIP
+      @matures_on = matures_on unless matures_on == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @minimum_balance = minimum_balance unless minimum_balance == SKIP
+      @minimum_payment = minimum_payment unless minimum_payment == SKIP
+      @name = name
+      @nickname = nickname unless nickname == SKIP
+      @original_balance = original_balance unless original_balance == SKIP
+      @payment_due_at = payment_due_at unless payment_due_at == SKIP
+      @payoff_balance = payoff_balance unless payoff_balance == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+      @started_on = started_on unless started_on == SKIP
+      @subtype = subtype unless subtype == SKIP
+      @type = type
+      @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.
+      balance = hash.key?('balance') ? hash['balance'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : 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
+      available_credit =
+        hash.key?('available_credit') ? hash['available_credit'] : 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
+      day_payment_is_due =
+        hash.key?('day_payment_is_due') ? hash['day_payment_is_due'] : SKIP
+      death_benefit = hash.key?('death_benefit') ? hash['death_benefit'] : SKIP
+      interest_rate = hash.key?('interest_rate') ? hash['interest_rate'] : SKIP
+      is_closed = hash.key?('is_closed') ? hash['is_closed'] : SKIP
+      is_hidden = hash.key?('is_hidden') ? hash['is_hidden'] : SKIP
+      last_payment = hash.key?('last_payment') ? hash['last_payment'] : SKIP
+      last_payment_at =
+        hash.key?('last_payment_at') ? hash['last_payment_at'] : SKIP
+      loan_amount = hash.key?('loan_amount') ? hash['loan_amount'] : SKIP
+      matures_on = hash.key?('matures_on') ? hash['matures_on'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      minimum_balance =
+        hash.key?('minimum_balance') ? hash['minimum_balance'] : SKIP
+      minimum_payment =
+        hash.key?('minimum_payment') ? hash['minimum_payment'] : SKIP
+      nickname = hash.key?('nickname') ? hash['nickname'] : SKIP
+      original_balance =
+        hash.key?('original_balance') ? hash['original_balance'] : SKIP
+      payment_due_at =
+        hash.key?('payment_due_at') ? hash['payment_due_at'] : SKIP
+      payoff_balance =
+        hash.key?('payoff_balance') ? hash['payoff_balance'] : SKIP
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : SKIP
+      started_on = hash.key?('started_on') ? hash['started_on'] : SKIP
+      subtype = hash.key?('subtype') ? hash['subtype'] : 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.
+      ManagedAccountCreateRequest.new(balance: balance,
+                                      id: id,
+                                      name: name,
+                                      type: type,
+                                      account_number: account_number,
+                                      apr: apr,
+                                      apy: apy,
+                                      available_balance: available_balance,
+                                      available_credit: available_credit,
+                                      cash_surrender_value: cash_surrender_value,
+                                      credit_limit: credit_limit,
+                                      currency_code: currency_code,
+                                      day_payment_is_due: day_payment_is_due,
+                                      death_benefit: death_benefit,
+                                      interest_rate: interest_rate,
+                                      is_closed: is_closed,
+                                      is_hidden: is_hidden,
+                                      last_payment: last_payment,
+                                      last_payment_at: last_payment_at,
+                                      loan_amount: loan_amount,
+                                      matures_on: matures_on,
+                                      metadata: metadata,
+                                      minimum_balance: minimum_balance,
+                                      minimum_payment: minimum_payment,
+                                      nickname: nickname,
+                                      original_balance: original_balance,
+                                      payment_due_at: payment_due_at,
+                                      payoff_balance: payoff_balance,
+                                      routing_number: routing_number,
+                                      started_on: started_on,
+                                      subtype: subtype,
+                                      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}, apr: #{@apr}, apy: #{@apy},"\
+      " available_balance: #{@available_balance}, available_credit: #{@available_credit}, balance:"\
+      " #{@balance}, cash_surrender_value: #{@cash_surrender_value}, credit_limit:"\
+      " #{@credit_limit}, currency_code: #{@currency_code}, day_payment_is_due:"\
+      " #{@day_payment_is_due}, death_benefit: #{@death_benefit}, id: #{@id}, interest_rate:"\
+      " #{@interest_rate}, is_closed: #{@is_closed}, is_hidden: #{@is_hidden}, last_payment:"\
+      " #{@last_payment}, last_payment_at: #{@last_payment_at}, loan_amount: #{@loan_amount},"\
+      " matures_on: #{@matures_on}, metadata: #{@metadata}, minimum_balance: #{@minimum_balance},"\
+      " minimum_payment: #{@minimum_payment}, name: #{@name}, nickname: #{@nickname},"\
+      " original_balance: #{@original_balance}, payment_due_at: #{@payment_due_at},"\
+      " payoff_balance: #{@payoff_balance}, routing_number: #{@routing_number}, started_on:"\
+      " #{@started_on}, subtype: #{@subtype}, type: #{@type}, 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}, apr: #{@apr.inspect}, apy:"\
+      " #{@apy.inspect}, available_balance: #{@available_balance.inspect}, available_credit:"\
+      " #{@available_credit.inspect}, balance: #{@balance.inspect}, cash_surrender_value:"\
+      " #{@cash_surrender_value.inspect}, credit_limit: #{@credit_limit.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, day_payment_is_due: #{@day_payment_is_due.inspect},"\
+      " death_benefit: #{@death_benefit.inspect}, id: #{@id.inspect}, interest_rate:"\
+      " #{@interest_rate.inspect}, is_closed: #{@is_closed.inspect}, is_hidden:"\
+      " #{@is_hidden.inspect}, last_payment: #{@last_payment.inspect}, last_payment_at:"\
+      " #{@last_payment_at.inspect}, loan_amount: #{@loan_amount.inspect}, matures_on:"\
+      " #{@matures_on.inspect}, metadata: #{@metadata.inspect}, minimum_balance:"\
+      " #{@minimum_balance.inspect}, minimum_payment: #{@minimum_payment.inspect}, name:"\
+      " #{@name.inspect}, nickname: #{@nickname.inspect}, original_balance:"\
+      " #{@original_balance.inspect}, payment_due_at: #{@payment_due_at.inspect}, payoff_balance:"\
+      " #{@payoff_balance.inspect}, routing_number: #{@routing_number.inspect}, started_on:"\
+      " #{@started_on.inspect}, subtype: #{@subtype.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/managed_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
+  # ManagedAccountCreateRequestBody Model.
+  class ManagedAccountCreateRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ManagedAccountCreateRequest]
+    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 = ManagedAccountCreateRequest.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.
+      ManagedAccountCreateRequestBody.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