apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/spending_plan_iteration_item_response.rb

@@ -0,0 +1,224 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # SpendingPlanIterationItemResponse Model.
+  class SpendingPlanIterationItemResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The sum of the transactions associated with the spending plan
+    # `iteration_item`.
+    # @return [Float]
+    attr_accessor :actual_amount
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The date and time the spending plan iteration item was created,
+    # represented in ISO 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The unique identifier for the spending plan `iteration_item`. Defined by
+    # MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The type of transaction grouping for the spending plan `iteration_item` (0
+    # = `RECURRING_EXPENSE`, 1 = `PLANNED_EXPENSE`, 2 = `OTHER_EXPENSE`, 3 =
+    # `INCOME`).
+    # @return [ItemType]
+    attr_accessor :item_type
+
+    # The total amount planned for a spending plan `iteration_item`.
+    # @return [Float]
+    attr_accessor :planned_amount
+
+    # The unique identifier for the `scheduled_payment_guid` associated with the
+    # spending plan `iteration_item`. Defined by MX.
+    # @return [String]
+    attr_accessor :scheduled_payment_guid
+
+    # The unique identifier for the spending plan `iteration_item`. Defined by
+    # MX.
+    # @return [String]
+    attr_accessor :spending_plan_iteration_guid
+
+    # The unique identifier for the `top_level_category_guid` associated with
+    # the spending plan `iteration_item`. Defined by MX.
+    # @return [String]
+    attr_accessor :top_level_category_guid
+
+    # An array of transaction GUIDs that are relevant to the spending plan
+    # `iteration_item`. Defined by MX.
+    # @return [Array[String]]
+    attr_accessor :transaction_guids
+
+    # The date and time the resource was last updated in ISO 8601 format with a
+    # timestamp.
+    # For categories, this field will always be `null` when `is_default` is
+    # `true`.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # The unique identifier for 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['actual_amount'] = 'actual_amount'
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['created_at'] = 'created_at'
+      @_hash['guid'] = 'guid'
+      @_hash['item_type'] = 'item_type'
+      @_hash['planned_amount'] = 'planned_amount'
+      @_hash['scheduled_payment_guid'] = 'scheduled_payment_guid'
+      @_hash['spending_plan_iteration_guid'] = 'spending_plan_iteration_guid'
+      @_hash['top_level_category_guid'] = 'top_level_category_guid'
+      @_hash['transaction_guids'] = 'transaction_guids'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        actual_amount
+        category_guid
+        created_at
+        guid
+        item_type
+        planned_amount
+        scheduled_payment_guid
+        spending_plan_iteration_guid
+        top_level_category_guid
+        transaction_guids
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        actual_amount
+        category_guid
+        created_at
+        guid
+        item_type
+        planned_amount
+        scheduled_payment_guid
+        spending_plan_iteration_guid
+        top_level_category_guid
+        updated_at
+        user_guid
+      ]
+    end
+
+    def initialize(actual_amount: SKIP, category_guid: SKIP, created_at: SKIP,
+                   guid: SKIP, item_type: SKIP, planned_amount: SKIP,
+                   scheduled_payment_guid: SKIP,
+                   spending_plan_iteration_guid: SKIP,
+                   top_level_category_guid: SKIP, transaction_guids: SKIP,
+                   updated_at: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @actual_amount = actual_amount unless actual_amount == SKIP
+      @category_guid = category_guid unless category_guid == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @guid = guid unless guid == SKIP
+      @item_type = item_type unless item_type == SKIP
+      @planned_amount = planned_amount unless planned_amount == SKIP
+      @scheduled_payment_guid = scheduled_payment_guid unless scheduled_payment_guid == SKIP
+      unless spending_plan_iteration_guid == SKIP
+        @spending_plan_iteration_guid =
+          spending_plan_iteration_guid
+      end
+      @top_level_category_guid = top_level_category_guid unless top_level_category_guid == SKIP
+      @transaction_guids = transaction_guids unless transaction_guids == SKIP
+      @updated_at = updated_at unless updated_at == 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.
+      actual_amount = hash.key?('actual_amount') ? hash['actual_amount'] : SKIP
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      item_type = hash.key?('item_type') ? hash['item_type'] : SKIP
+      planned_amount =
+        hash.key?('planned_amount') ? hash['planned_amount'] : SKIP
+      scheduled_payment_guid =
+        hash.key?('scheduled_payment_guid') ? hash['scheduled_payment_guid'] : SKIP
+      spending_plan_iteration_guid =
+        hash.key?('spending_plan_iteration_guid') ? hash['spending_plan_iteration_guid'] : SKIP
+      top_level_category_guid =
+        hash.key?('top_level_category_guid') ? hash['top_level_category_guid'] : SKIP
+      transaction_guids =
+        hash.key?('transaction_guids') ? hash['transaction_guids'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : 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.
+      SpendingPlanIterationItemResponse.new(actual_amount: actual_amount,
+                                            category_guid: category_guid,
+                                            created_at: created_at,
+                                            guid: guid,
+                                            item_type: item_type,
+                                            planned_amount: planned_amount,
+                                            scheduled_payment_guid: scheduled_payment_guid,
+                                            spending_plan_iteration_guid: spending_plan_iteration_guid,
+                                            top_level_category_guid: top_level_category_guid,
+                                            transaction_guids: transaction_guids,
+                                            updated_at: updated_at,
+                                            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} actual_amount: #{@actual_amount}, category_guid: #{@category_guid},"\
+      " created_at: #{@created_at}, guid: #{@guid}, item_type: #{@item_type}, planned_amount:"\
+      " #{@planned_amount}, scheduled_payment_guid: #{@scheduled_payment_guid},"\
+      " spending_plan_iteration_guid: #{@spending_plan_iteration_guid}, top_level_category_guid:"\
+      " #{@top_level_category_guid}, transaction_guids: #{@transaction_guids}, updated_at:"\
+      " #{@updated_at}, 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} actual_amount: #{@actual_amount.inspect}, category_guid:"\
+      " #{@category_guid.inspect}, created_at: #{@created_at.inspect}, guid: #{@guid.inspect},"\
+      " item_type: #{@item_type.inspect}, planned_amount: #{@planned_amount.inspect},"\
+      " scheduled_payment_guid: #{@scheduled_payment_guid.inspect}, spending_plan_iteration_guid:"\
+      " #{@spending_plan_iteration_guid.inspect}, top_level_category_guid:"\
+      " #{@top_level_category_guid.inspect}, transaction_guids: #{@transaction_guids.inspect},"\
+      " updated_at: #{@updated_at.inspect}, user_guid: #{@user_guid.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

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

data/lib/mx_platform_api/models/spending_plan_iteration_response.rb

@@ -0,0 +1,162 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # SpendingPlanIterationResponse Model.
+  class SpendingPlanIterationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the spending plan iteration was created, represented in
+    # ISO 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The date on which the spending plan iteration ends.
+    # @return [String]
+    attr_accessor :end_on
+
+    # The unique identifier for the spending plan iteration. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The current iteration number for the spending plan iteration.
+    # @return [Integer]
+    attr_accessor :iteration_number
+
+    # The unique identifier for the spending plan. Defined by MX.
+    # @return [String]
+    attr_accessor :spending_plan_guid
+
+    # The date on which the spending plan iteration starts.
+    # @return [String]
+    attr_accessor :start_on
+
+    # The date and time the resource was last updated in ISO 8601 format with a
+    # timestamp.
+    # For categories, this field will always be `null` when `is_default` is
+    # `true`.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # The unique identifier for 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['created_at'] = 'created_at'
+      @_hash['end_on'] = 'end_on'
+      @_hash['guid'] = 'guid'
+      @_hash['iteration_number'] = 'iteration_number'
+      @_hash['spending_plan_guid'] = 'spending_plan_guid'
+      @_hash['start_on'] = 'start_on'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        end_on
+        guid
+        iteration_number
+        spending_plan_guid
+        start_on
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        created_at
+        end_on
+        guid
+        iteration_number
+        spending_plan_guid
+        start_on
+        updated_at
+        user_guid
+      ]
+    end
+
+    def initialize(created_at: SKIP, end_on: SKIP, guid: SKIP,
+                   iteration_number: SKIP, spending_plan_guid: SKIP,
+                   start_on: SKIP, updated_at: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_at = created_at unless created_at == SKIP
+      @end_on = end_on unless end_on == SKIP
+      @guid = guid unless guid == SKIP
+      @iteration_number = iteration_number unless iteration_number == SKIP
+      @spending_plan_guid = spending_plan_guid unless spending_plan_guid == SKIP
+      @start_on = start_on unless start_on == SKIP
+      @updated_at = updated_at unless updated_at == 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.
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      end_on = hash.key?('end_on') ? hash['end_on'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      iteration_number =
+        hash.key?('iteration_number') ? hash['iteration_number'] : SKIP
+      spending_plan_guid =
+        hash.key?('spending_plan_guid') ? hash['spending_plan_guid'] : SKIP
+      start_on = hash.key?('start_on') ? hash['start_on'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : 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.
+      SpendingPlanIterationResponse.new(created_at: created_at,
+                                        end_on: end_on,
+                                        guid: guid,
+                                        iteration_number: iteration_number,
+                                        spending_plan_guid: spending_plan_guid,
+                                        start_on: start_on,
+                                        updated_at: updated_at,
+                                        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} created_at: #{@created_at}, end_on: #{@end_on}, guid: #{@guid},"\
+      " iteration_number: #{@iteration_number}, spending_plan_guid: #{@spending_plan_guid},"\
+      " start_on: #{@start_on}, updated_at: #{@updated_at}, 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} created_at: #{@created_at.inspect}, end_on: #{@end_on.inspect}, guid:"\
+      " #{@guid.inspect}, iteration_number: #{@iteration_number.inspect}, spending_plan_guid:"\
+      " #{@spending_plan_guid.inspect}, start_on: #{@start_on.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, user_guid: #{@user_guid.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/spending_plan_iterations_response.rb

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