apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/account_response_body.rb

@@ -0,0 +1,75 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountResponseBody Model.
+  class AccountResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountResponse]
+    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 = AccountResponse.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.
+      AccountResponseBody.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_type.rb

@@ -0,0 +1,80 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The type of account. Some account types may include subtypes.
+  class AccountType
+    ACCOUNT_TYPE = [
+      # TODO: Write general description for ANY
+      ANY = 'ANY'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for CHECKING
+      CHECKING = 'CHECKING'.freeze,
+
+      # TODO: Write general description for CHECKING_LINE_OF_CREDIT
+      CHECKING_LINE_OF_CREDIT = 'CHECKING_LINE_OF_CREDIT'.freeze,
+
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'CREDIT_CARD'.freeze,
+
+      # TODO: Write general description for LOAN
+      LOAN = 'LOAN'.freeze,
+
+      # TODO: Write general description for LINE_OF_CREDIT
+      LINE_OF_CREDIT = 'LINE_OF_CREDIT'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'SAVINGS'.freeze,
+
+      # TODO: Write general description for INVESTMENT
+      INVESTMENT = 'INVESTMENT'.freeze,
+
+      # TODO: Write general description for MORTGAGE
+      MORTGAGE = 'MORTGAGE'.freeze,
+
+      # TODO: Write general description for INSURANCE
+      INSURANCE = 'INSURANCE'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'PREPAID'.freeze,
+
+      # TODO: Write general description for PROPERTY
+      PROPERTY = 'PROPERTY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ANY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'any' then ANY
+      when 'cash' then CASH
+      when 'checking' then CHECKING
+      when 'checking_line_of_credit' then CHECKING_LINE_OF_CREDIT
+      when 'credit_card' then CREDIT_CARD
+      when 'loan' then LOAN
+      when 'line_of_credit' then LINE_OF_CREDIT
+      when 'savings' then SAVINGS
+      when 'investment' then INVESTMENT
+      when 'mortgage' then MORTGAGE
+      when 'insurance' then INSURANCE
+      when 'prepaid' then PREPAID
+      when 'property' then PROPERTY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/account_type1.rb

@@ -0,0 +1,80 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The type of account. Some account types may include subtypes.
+  class AccountType1
+    ACCOUNT_TYPE1 = [
+      # TODO: Write general description for ANY
+      ANY = 'ANY'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for CHECKING
+      CHECKING = 'CHECKING'.freeze,
+
+      # TODO: Write general description for CHECKING_LINE_OF_CREDIT
+      CHECKING_LINE_OF_CREDIT = 'CHECKING_LINE_OF_CREDIT'.freeze,
+
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'CREDIT_CARD'.freeze,
+
+      # TODO: Write general description for LOAN
+      LOAN = 'LOAN'.freeze,
+
+      # TODO: Write general description for LINE_OF_CREDIT
+      LINE_OF_CREDIT = 'LINE_OF_CREDIT'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'SAVINGS'.freeze,
+
+      # TODO: Write general description for INVESTMENT
+      INVESTMENT = 'INVESTMENT'.freeze,
+
+      # TODO: Write general description for MORTGAGE
+      MORTGAGE = 'MORTGAGE'.freeze,
+
+      # TODO: Write general description for INSURANCE
+      INSURANCE = 'INSURANCE'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'PREPAID'.freeze,
+
+      # TODO: Write general description for PROPERTY
+      PROPERTY = 'PROPERTY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = ANY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'any' then ANY
+      when 'cash' then CASH
+      when 'checking' then CHECKING
+      when 'checking_line_of_credit' then CHECKING_LINE_OF_CREDIT
+      when 'credit_card' then CREDIT_CARD
+      when 'loan' then LOAN
+      when 'line_of_credit' then LINE_OF_CREDIT
+      when 'savings' then SAVINGS
+      when 'investment' then INVESTMENT
+      when 'mortgage' then MORTGAGE
+      when 'insurance' then INSURANCE
+      when 'prepaid' then PREPAID
+      when 'property' then PROPERTY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/account_update_request.rb

@@ -0,0 +1,301 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountUpdateRequest Model.
+  class AccountUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Can only be updated for manual accounts.
+    # @return [String]
+    attr_accessor :account_subtype
+
+    # The type of account. Some account types may include subtypes.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # Can only be updated for manual accounts. The annual percentage rate
+    # associated with the `account`.
+    # @return [Float]
+    attr_accessor :apr
+
+    # Can only be updated for manual accounts. The annual percentage yield
+    # associated with the `account`.
+    # @return [Float]
+    attr_accessor :apy
+
+    # Can only be updated for manual accounts.
+    # The balance that is available for use in asset accounts like checking and
+    # savings.
+    # @return [Float]
+    attr_accessor :available_balance
+
+    # Can only be updated for manual accounts. The current balance of the
+    # account.
+    # @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
+
+    # Can only be updated for manual accounts. The credit limit associated with
+    # the `account`.
+    # @return [Float]
+    attr_accessor :credit_limit
+
+    # Can only be updated for manual accounts. The three-character ISO 4217
+    # currency code, for example, `USD`.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Can only be updated for manual accounts. The amount paid to the
+    # beneficiary of the account upon death of the account owner.
+    # @return [Integer]
+    attr_accessor :death_benefit
+
+    # Can only be updated for manual accounts.
+    # @return [Float]
+    attr_accessor :interest_rate
+
+    # Can be updated for manual accounts and aggregated accounts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_business
+
+    # Can only be updated for manual accounts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_closed
+
+    # Can be updated for manual accounts and aggregated accounts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_hidden
+
+    # Can only be updated for manual accounts.
+    # @return [Float]
+    attr_accessor :loan_amount
+
+    # Can only be updated for manual accounts.
+    # @return [String]
+    attr_accessor :metadata
+
+    # Can only be updated for manual accounts.
+    # @return [String]
+    attr_accessor :name
+
+    # Can only be updated for manual accounts.
+    # @return [String]
+    attr_accessor :nickname
+
+    # Can only be updated for manual accounts.
+    # @return [Float]
+    attr_accessor :original_balance
+
+    # Can only be updated for manual accounts.
+    # @return [String]
+    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
+        account_type
+        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
+        name
+        nickname
+        original_balance
+        property_type
+        skip_webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_subtype
+        account_type
+        apr
+        credit_limit
+        currency_code
+      ]
+    end
+
+    def initialize(account_subtype: SKIP, account_type: 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,
+                   name: 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 unless account_type == SKIP
+      @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 unless name == SKIP
+      @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_subtype =
+        hash.key?('account_subtype') ? hash['account_subtype'] : SKIP
+      account_type = hash.key?('account_type') ? hash['account_type'] : 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
+      name = hash.key?('name') ? hash['name'] : 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.
+      AccountUpdateRequest.new(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 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_update_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
+  # AccountUpdateRequestBody Model.
+  class AccountUpdateRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountUpdateRequest]
+    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 = AccountUpdateRequest.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.
+      AccountUpdateRequestBody.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/accounts_merge_request.rb

@@ -0,0 +1,75 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AccountsMergeRequest Model.
+  class AccountsMergeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of account GUIDs to merge. Must include at least two GUIDs
+    # belonging to the same user.
+    # @return [Array[String]]
+    attr_accessor :account_guids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guids'] = 'account_guids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_guids:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guids = account_guids
+      @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_guids = hash.key?('account_guids') ? hash['account_guids'] : nil
+
+      # 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.
+      AccountsMergeRequest.new(account_guids: account_guids,
+                               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_guids: #{@account_guids}, 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_guids: #{@account_guids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end