apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/microdeposit_verify_request.rb

@@ -0,0 +1,88 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MicrodepositVerifyRequest Model.
+  class MicrodepositVerifyRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount of the first microdeposit sent for account verification.
+    # @return [Float]
+    attr_accessor :deposit_amount_1
+
+    # The amount of the second microdeposit sent for account verification.
+    # @return [Float]
+    attr_accessor :deposit_amount_2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deposit_amount_1'] = 'deposit_amount_1'
+      @_hash['deposit_amount_2'] = 'deposit_amount_2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        deposit_amount_1
+        deposit_amount_2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deposit_amount_1: SKIP, deposit_amount_2: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deposit_amount_1 = deposit_amount_1 unless deposit_amount_1 == SKIP
+      @deposit_amount_2 = deposit_amount_2 unless deposit_amount_2 == 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.
+      deposit_amount_1 =
+        hash.key?('deposit_amount_1') ? hash['deposit_amount_1'] : SKIP
+      deposit_amount_2 =
+        hash.key?('deposit_amount_2') ? hash['deposit_amount_2'] : 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.
+      MicrodepositVerifyRequest.new(deposit_amount_1: deposit_amount_1,
+                                    deposit_amount_2: deposit_amount_2,
+                                    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} deposit_amount_1: #{@deposit_amount_1}, deposit_amount_2:"\
+      " #{@deposit_amount_2}, 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} deposit_amount_1: #{@deposit_amount_1.inspect}, deposit_amount_2:"\
+      " #{@deposit_amount_2.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/microdeposit_verify_request_body.rb

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

data/lib/mx_platform_api/models/microdeposits_response_body.rb

@@ -0,0 +1,95 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MicrodepositsResponseBody Model.
+  class MicrodepositsResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[MicrodepositResponse]]
+    attr_accessor :micro_deposits
+
+    # TODO: Write general description for this method
+    # @return [PaginationResponse]
+    attr_accessor :pagination
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['micro_deposits'] = 'micro_deposits'
+      @_hash['pagination'] = 'pagination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        micro_deposits
+        pagination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(micro_deposits: SKIP, pagination: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @micro_deposits = micro_deposits unless micro_deposits == SKIP
+      @pagination = pagination unless pagination == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      micro_deposits = nil
+      unless hash['micro_deposits'].nil?
+        micro_deposits = []
+        hash['micro_deposits'].each do |structure|
+          micro_deposits << (MicrodepositResponse.from_hash(structure) if structure)
+        end
+      end
+
+      micro_deposits = SKIP unless hash.key?('micro_deposits')
+      pagination = PaginationResponse.from_hash(hash['pagination']) if hash['pagination']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MicrodepositsResponseBody.new(micro_deposits: micro_deposits,
+                                    pagination: pagination,
+                                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} micro_deposits: #{@micro_deposits}, pagination: #{@pagination},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} micro_deposits: #{@micro_deposits.inspect}, pagination:"\
+      " #{@pagination.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/monthly_account_balance.rb

@@ -0,0 +1,123 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MonthlyAccountBalance Model.
+  class MonthlyAccountBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # 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 month for which the balance.
+    # @return [Float]
+    attr_accessor :month
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # The year for which the balance is reported.
+    # @return [Float]
+    attr_accessor :year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['balance'] = 'balance'
+      @_hash['month'] = 'month'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['year'] = 'year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        balance
+        month
+        user_guid
+        year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_guid: SKIP, balance: SKIP, month: SKIP,
+                   user_guid: SKIP, year: 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
+      @balance = balance unless balance == SKIP
+      @month = month unless month == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      @year = year unless year == 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
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      month = hash.key?('month') ? hash['month'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+      year = hash.key?('year') ? hash['year'] : 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.
+      MonthlyAccountBalance.new(account_guid: account_guid,
+                                balance: balance,
+                                month: month,
+                                user_guid: user_guid,
+                                year: year,
+                                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}, balance: #{@balance}, month: #{@month},"\
+      " user_guid: #{@user_guid}, year: #{@year}, 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}, balance: #{@balance.inspect},"\
+      " month: #{@month.inspect}, user_guid: #{@user_guid.inspect}, year: #{@year.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/monthly_account_balances_response_body.rb

@@ -0,0 +1,85 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MonthlyAccountBalancesResponseBody Model.
+  class MonthlyAccountBalancesResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[MonthlyAccountBalance]]
+    attr_accessor :monthly_account_balances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['monthly_account_balances'] = 'monthly_account_balances'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        monthly_account_balances
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(monthly_account_balances: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @monthly_account_balances = monthly_account_balances unless monthly_account_balances == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      monthly_account_balances = nil
+      unless hash['monthly_account_balances'].nil?
+        monthly_account_balances = []
+        hash['monthly_account_balances'].each do |structure|
+          monthly_account_balances << (MonthlyAccountBalance.from_hash(structure) if structure)
+        end
+      end
+
+      monthly_account_balances = SKIP unless hash.key?('monthly_account_balances')
+
+      # 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.
+      MonthlyAccountBalancesResponseBody.new(monthly_account_balances: monthly_account_balances,
+                                             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} monthly_account_balances: #{@monthly_account_balances},"\
+      " 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} monthly_account_balances: #{@monthly_account_balances.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/monthly_cash_flow_profile_request.rb

@@ -0,0 +1,95 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MonthlyCashFlowProfileRequest Model.
+  class MonthlyCashFlowProfileRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monthly dollar amount allocated for goals.
+    # @return [Float]
+    attr_accessor :goals_contribution
+
+    # Determines if the user uses estimated goals contribution.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :uses_estimated_goals_contribution
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['goals_contribution'] = 'goals_contribution'
+      @_hash['uses_estimated_goals_contribution'] =
+        'uses_estimated_goals_contribution'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        goals_contribution
+        uses_estimated_goals_contribution
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(goals_contribution: SKIP,
+                   uses_estimated_goals_contribution: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @goals_contribution = goals_contribution unless goals_contribution == SKIP
+      unless uses_estimated_goals_contribution == SKIP
+        @uses_estimated_goals_contribution =
+          uses_estimated_goals_contribution
+      end
+      @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.
+      goals_contribution =
+        hash.key?('goals_contribution') ? hash['goals_contribution'] : SKIP
+      uses_estimated_goals_contribution =
+        hash.key?('uses_estimated_goals_contribution') ? hash['uses_estimated_goals_contribution'] : 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.
+      MonthlyCashFlowProfileRequest.new(goals_contribution: goals_contribution,
+                                        uses_estimated_goals_contribution: uses_estimated_goals_contribution,
+                                        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} goals_contribution: #{@goals_contribution},"\
+      " uses_estimated_goals_contribution: #{@uses_estimated_goals_contribution},"\
+      " 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} goals_contribution: #{@goals_contribution.inspect},"\
+      " uses_estimated_goals_contribution: #{@uses_estimated_goals_contribution.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/monthly_cash_flow_profile_request_body.rb

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