apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/transaction_type.rb

@@ -0,0 +1,36 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The type of transaction. Can be either `CREDIT` or `DEBIT`.
+  class TransactionType
+    TRANSACTION_TYPE = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/transaction_update_request.rb

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

data/lib/mx_platform_api/models/transaction_update_request_body.rb

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

data/lib/mx_platform_api/models/transactions_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
+  # TransactionsResponseBody Model.
+  class TransactionsResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TransactionResponse]]
+    attr_accessor :transactions
+
+    # 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['transactions'] = 'transactions'
+      @_hash['pagination'] = 'pagination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transactions
+        pagination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transactions: SKIP, pagination: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transactions = transactions unless transactions == 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
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (TransactionResponse.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+      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.
+      TransactionsResponseBody.new(transactions: transactions,
+                                   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} transactions: #{@transactions}, 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} transactions: #{@transactions.inspect}, pagination: #{@pagination.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/transactions_response_body_includes.rb

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

data/lib/mx_platform_api/models/type.rb

@@ -0,0 +1,36 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The type of transaction. Can be either `CREDIT` or `DEBIT`.
+  class Type
+    TYPE = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/update_goal_request.rb

@@ -0,0 +1,185 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # UpdateGoalRequest Model.
+  class UpdateGoalRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The amount of the `goal`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The type of goal. Can be `SAVE_AMOUNT` or `PAYOFF`.
+    # @return [GoalTypeName]
+    attr_accessor :goal_type_name
+
+    # The category of the goal.
+    # @return [String]
+    attr_accessor :meta_type_name
+
+    # The name of the goal.
+    # @return [String]
+    attr_accessor :name
+
+    # Date and time the `goal` was completed, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :completed_at
+
+    # Determines if the goal has been spent.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_been_spent
+
+    # Determines if the goal is complete.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_complete
+
+    # Additional information you can store about the `goal`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The priority of the `goal` in relation to multiple goals.
+    # @return [Integer]
+    attr_accessor :position
+
+    # Date and time the goal is to complete. Intended for users to set their own
+    # goal completion dates.
+    # @return [String]
+    attr_accessor :targeted_to_complete_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['amount'] = 'amount'
+      @_hash['goal_type_name'] = 'goal_type_name'
+      @_hash['meta_type_name'] = 'meta_type_name'
+      @_hash['name'] = 'name'
+      @_hash['completed_at'] = 'completed_at'
+      @_hash['has_been_spent'] = 'has_been_spent'
+      @_hash['is_complete'] = 'is_complete'
+      @_hash['metadata'] = 'metadata'
+      @_hash['position'] = 'position'
+      @_hash['targeted_to_complete_at'] = 'targeted_to_complete_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        amount
+        goal_type_name
+        meta_type_name
+        name
+        completed_at
+        has_been_spent
+        is_complete
+        metadata
+        position
+        targeted_to_complete_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        goal_type_name
+      ]
+    end
+
+    def initialize(account_guid: SKIP, amount: SKIP, goal_type_name: SKIP,
+                   meta_type_name: SKIP, name: SKIP, completed_at: SKIP,
+                   has_been_spent: SKIP, is_complete: SKIP, metadata: SKIP,
+                   position: SKIP, targeted_to_complete_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @amount = amount unless amount == SKIP
+      @goal_type_name = goal_type_name unless goal_type_name == SKIP
+      @meta_type_name = meta_type_name unless meta_type_name == SKIP
+      @name = name unless name == SKIP
+      @completed_at = completed_at unless completed_at == SKIP
+      @has_been_spent = has_been_spent unless has_been_spent == SKIP
+      @is_complete = is_complete unless is_complete == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @position = position unless position == SKIP
+      @targeted_to_complete_at = targeted_to_complete_at unless targeted_to_complete_at == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      goal_type_name =
+        hash.key?('goal_type_name') ? hash['goal_type_name'] : SKIP
+      meta_type_name =
+        hash.key?('meta_type_name') ? hash['meta_type_name'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      completed_at = hash.key?('completed_at') ? hash['completed_at'] : SKIP
+      has_been_spent =
+        hash.key?('has_been_spent') ? hash['has_been_spent'] : SKIP
+      is_complete = hash.key?('is_complete') ? hash['is_complete'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+      targeted_to_complete_at =
+        hash.key?('targeted_to_complete_at') ? hash['targeted_to_complete_at'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      UpdateGoalRequest.new(account_guid: account_guid,
+                            amount: amount,
+                            goal_type_name: goal_type_name,
+                            meta_type_name: meta_type_name,
+                            name: name,
+                            completed_at: completed_at,
+                            has_been_spent: has_been_spent,
+                            is_complete: is_complete,
+                            metadata: metadata,
+                            position: position,
+                            targeted_to_complete_at: targeted_to_complete_at,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_guid: #{@account_guid}, amount: #{@amount}, goal_type_name:"\
+      " #{@goal_type_name}, meta_type_name: #{@meta_type_name}, name: #{@name}, completed_at:"\
+      " #{@completed_at}, has_been_spent: #{@has_been_spent}, is_complete: #{@is_complete},"\
+      " metadata: #{@metadata}, position: #{@position}, targeted_to_complete_at:"\
+      " #{@targeted_to_complete_at}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_guid: #{@account_guid.inspect}, amount: #{@amount.inspect},"\
+      " goal_type_name: #{@goal_type_name.inspect}, meta_type_name: #{@meta_type_name.inspect},"\
+      " name: #{@name.inspect}, completed_at: #{@completed_at.inspect}, has_been_spent:"\
+      " #{@has_been_spent.inspect}, is_complete: #{@is_complete.inspect}, metadata:"\
+      " #{@metadata.inspect}, position: #{@position.inspect}, targeted_to_complete_at:"\
+      " #{@targeted_to_complete_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/update_goal_request_body.rb

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