apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/goals_response.rb

@@ -0,0 +1,241 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # GoalsResponse Model.
+  class GoalsResponse < 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 current amount of the `goal`.
+    # @return [Float]
+    attr_accessor :current_amount
+
+    # The unique identifier for the goal. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # 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 stored about the `goal`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The priority of the goal in relation to multiple goals.
+    # @return [Integer]
+    attr_accessor :position
+
+    # The date on which the project was completed.
+    # @return [String]
+    attr_accessor :projected_to_complete_at
+
+    # Date and time the goal is to complete, represented in ISO 8601 format with
+    # timestamp. 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['current_amount'] = 'current_amount'
+      @_hash['guid'] = 'guid'
+      @_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['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
+        current_amount
+        guid
+        goal_type_name
+        meta_type_name
+        name
+        completed_at
+        has_been_spent
+        is_complete
+        metadata
+        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, current_amount: SKIP,
+                   guid: 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,
+                   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
+      @current_amount = current_amount unless current_amount == SKIP
+      @guid = guid unless guid == 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
+      @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
+      current_amount =
+        hash.key?('current_amount') ? hash['current_amount'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : 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
+      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.
+      GoalsResponse.new(account_guid: account_guid,
+                        amount: amount,
+                        current_amount: current_amount,
+                        guid: guid,
+                        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,
+                        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}, current_amount:"\
+      " #{@current_amount}, guid: #{@guid}, 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}, 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},"\
+      " current_amount: #{@current_amount.inspect}, guid: #{@guid.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}, 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/goals_response_body.rb

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

data/lib/mx_platform_api/models/image_option_response.rb

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