apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/goal_request.rb

@@ -0,0 +1,179 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # GoalRequest Model.
+  class GoalRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account.
+    # @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[
+        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:, amount:, goal_type_name:, meta_type_name:,
+                   name:, 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
+      @amount = amount
+      @goal_type_name = goal_type_name
+      @meta_type_name = meta_type_name
+      @name = name
+      @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'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      goal_type_name =
+        hash.key?('goal_type_name') ? hash['goal_type_name'] : nil
+      meta_type_name =
+        hash.key?('meta_type_name') ? hash['meta_type_name'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      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.
+      GoalRequest.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/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
+  # GoalRequestBody Model.
+  class GoalRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [GoalRequest]
+    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 = GoalRequest.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.
+      GoalRequestBody.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

data/lib/mx_platform_api/models/goal_response.rb

@@ -0,0 +1,241 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # GoalResponse Model.
+  class GoalResponse < 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
+
+    # Date and time the `goal` was completed, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :completed_at
+
+    # The current amount of the `goal`.
+    # @return [Float]
+    attr_accessor :current_amount
+
+    # The type of goal. Can be `SAVE_AMOUNT` or `PAYOFF`.
+    # @return [GoalTypeName]
+    attr_accessor :goal_type_name
+
+    # Unique identifier for the goal. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # 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 stored about the `goal`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The category of the `goal`.
+    # @return [String]
+    attr_accessor :meta_type_name
+
+    # The name of the `goal`.
+    # @return [String]
+    attr_accessor :name
+
+    # The priority of the `goal` in relation to multiple goals.
+    # @return [Integer]
+    attr_accessor :position
+
+    # Date and time the `goal` is projected to be completed.
+    # @return [String]
+    attr_accessor :projected_to_complete_at
+
+    # 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
+
+    # The track of the `goal`.
+    # @return [TrackTypeName]
+    attr_accessor :track_type_name
+
+    # The unique identifier for the the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # 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['completed_at'] = 'completed_at'
+      @_hash['current_amount'] = 'current_amount'
+      @_hash['goal_type_name'] = 'goal_type_name'
+      @_hash['guid'] = 'guid'
+      @_hash['has_been_spent'] = 'has_been_spent'
+      @_hash['is_complete'] = 'is_complete'
+      @_hash['metadata'] = 'metadata'
+      @_hash['meta_type_name'] = 'meta_type_name'
+      @_hash['name'] = 'name'
+      @_hash['position'] = 'position'
+      @_hash['projected_to_complete_at'] = 'projected_to_complete_at'
+      @_hash['targeted_to_complete_at'] = 'targeted_to_complete_at'
+      @_hash['track_type_name'] = 'track_type_name'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        amount
+        completed_at
+        current_amount
+        goal_type_name
+        guid
+        has_been_spent
+        is_complete
+        metadata
+        meta_type_name
+        name
+        position
+        projected_to_complete_at
+        targeted_to_complete_at
+        track_type_name
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        goal_type_name
+      ]
+    end
+
+    def initialize(account_guid: SKIP, amount: SKIP, completed_at: SKIP,
+                   current_amount: SKIP, goal_type_name: SKIP, guid: SKIP,
+                   has_been_spent: SKIP, is_complete: SKIP, metadata: SKIP,
+                   meta_type_name: SKIP, name: SKIP, position: SKIP,
+                   projected_to_complete_at: SKIP,
+                   targeted_to_complete_at: SKIP, track_type_name: SKIP,
+                   user_guid: 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
+      @completed_at = completed_at unless completed_at == SKIP
+      @current_amount = current_amount unless current_amount == SKIP
+      @goal_type_name = goal_type_name unless goal_type_name == SKIP
+      @guid = guid unless guid == 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
+      @meta_type_name = meta_type_name unless meta_type_name == SKIP
+      @name = name unless name == SKIP
+      @position = position unless position == SKIP
+      @projected_to_complete_at = projected_to_complete_at unless projected_to_complete_at == SKIP
+      @targeted_to_complete_at = targeted_to_complete_at unless targeted_to_complete_at == SKIP
+      @track_type_name = track_type_name unless track_type_name == SKIP
+      @user_guid = user_guid unless user_guid == 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
+      completed_at = hash.key?('completed_at') ? hash['completed_at'] : SKIP
+      current_amount =
+        hash.key?('current_amount') ? hash['current_amount'] : SKIP
+      goal_type_name =
+        hash.key?('goal_type_name') ? hash['goal_type_name'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : 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
+      meta_type_name =
+        hash.key?('meta_type_name') ? hash['meta_type_name'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+      projected_to_complete_at =
+        hash.key?('projected_to_complete_at') ? hash['projected_to_complete_at'] : SKIP
+      targeted_to_complete_at =
+        hash.key?('targeted_to_complete_at') ? hash['targeted_to_complete_at'] : SKIP
+      track_type_name =
+        hash.key?('track_type_name') ? hash['track_type_name'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : 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.
+      GoalResponse.new(account_guid: account_guid,
+                       amount: amount,
+                       completed_at: completed_at,
+                       current_amount: current_amount,
+                       goal_type_name: goal_type_name,
+                       guid: guid,
+                       has_been_spent: has_been_spent,
+                       is_complete: is_complete,
+                       metadata: metadata,
+                       meta_type_name: meta_type_name,
+                       name: name,
+                       position: position,
+                       projected_to_complete_at: projected_to_complete_at,
+                       targeted_to_complete_at: targeted_to_complete_at,
+                       track_type_name: track_type_name,
+                       user_guid: user_guid,
+                       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}, completed_at:"\
+      " #{@completed_at}, current_amount: #{@current_amount}, goal_type_name: #{@goal_type_name},"\
+      " guid: #{@guid}, has_been_spent: #{@has_been_spent}, is_complete: #{@is_complete},"\
+      " metadata: #{@metadata}, meta_type_name: #{@meta_type_name}, name: #{@name}, position:"\
+      " #{@position}, projected_to_complete_at: #{@projected_to_complete_at},"\
+      " targeted_to_complete_at: #{@targeted_to_complete_at}, track_type_name:"\
+      " #{@track_type_name}, user_guid: #{@user_guid}, 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},"\
+      " completed_at: #{@completed_at.inspect}, current_amount: #{@current_amount.inspect},"\
+      " goal_type_name: #{@goal_type_name.inspect}, guid: #{@guid.inspect}, has_been_spent:"\
+      " #{@has_been_spent.inspect}, is_complete: #{@is_complete.inspect}, metadata:"\
+      " #{@metadata.inspect}, meta_type_name: #{@meta_type_name.inspect}, name: #{@name.inspect},"\
+      " position: #{@position.inspect}, projected_to_complete_at:"\
+      " #{@projected_to_complete_at.inspect}, targeted_to_complete_at:"\
+      " #{@targeted_to_complete_at.inspect}, track_type_name: #{@track_type_name.inspect},"\
+      " user_guid: #{@user_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/goal_response_body.rb

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

data/lib/mx_platform_api/models/goal_type_name.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 goal. Can be `SAVE_AMOUNT` or `PAYOFF`.
+  class GoalTypeName
+    GOAL_TYPE_NAME = [
+      # TODO: Write general description for SAVE_AMOUNT
+      SAVE_AMOUNT = 'SAVE_AMOUNT'.freeze,
+
+      # TODO: Write general description for PAYOFF
+      PAYOFF = 'PAYOFF'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      GOAL_TYPE_NAME.include?(value)
+    end
+
+    def self.from_value(value, default_value = SAVE_AMOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'save_amount' then SAVE_AMOUNT
+      when 'payoff' then PAYOFF
+      else
+        default_value
+      end
+    end
+  end
+end