apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/scheduled_payment_response.rb

@@ -0,0 +1,208 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # ScheduledPaymentResponse Model.
+  class ScheduledPaymentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount of the `transaction`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The date and time the scheduled payment was created, represented in ISO
+    # 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # A human-readable description of the `scheduled_payment`, for example,
+    # Power bill.
+    # @return [String]
+    attr_accessor :description
+
+    # The unique identifier for the scheduled payment. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Indicates whether the `scheduled_payment` has been paid or not. This field
+    # is only applicable to one-time transactions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_completed
+
+    # Deprecated. If required, reach out to MX to discuss an alternative.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_recurring
+
+    # The unique identifier for the merchant. Defined by MX.
+    # @return [String]
+    attr_accessor :merchant_guid
+
+    # The date on which the payment is scheduled to occur, given in ISO 8601
+    # format without a timestamp.
+    # @return [String]
+    attr_accessor :occurs_on
+
+    # The day of the month where the next payment is expected to occur.
+    # @return [Integer]
+    attr_accessor :recurrence_day
+
+    # The type of recurrence schedule.
+    # @return [String]
+    attr_accessor :recurrence_type
+
+    # The type of transaction. Can be either `CREDIT` or `DEBIT`.
+    # @return [TransactionType]
+    attr_accessor :transaction_type
+
+    # 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['amount'] = 'amount'
+      @_hash['created_at'] = 'created_at'
+      @_hash['description'] = 'description'
+      @_hash['guid'] = 'guid'
+      @_hash['is_completed'] = 'is_completed'
+      @_hash['is_recurring'] = 'is_recurring'
+      @_hash['merchant_guid'] = 'merchant_guid'
+      @_hash['occurs_on'] = 'occurs_on'
+      @_hash['recurrence_day'] = 'recurrence_day'
+      @_hash['recurrence_type'] = 'recurrence_type'
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        created_at
+        description
+        guid
+        is_completed
+        is_recurring
+        merchant_guid
+        occurs_on
+        recurrence_day
+        recurrence_type
+        transaction_type
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, created_at: SKIP, description: SKIP,
+                   guid: SKIP, is_completed: SKIP, is_recurring: SKIP,
+                   merchant_guid: SKIP, occurs_on: SKIP, recurrence_day: SKIP,
+                   recurrence_type: SKIP, transaction_type: SKIP,
+                   updated_at: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @description = description unless description == SKIP
+      @guid = guid unless guid == SKIP
+      @is_completed = is_completed unless is_completed == SKIP
+      @is_recurring = is_recurring unless is_recurring == SKIP
+      @merchant_guid = merchant_guid unless merchant_guid == SKIP
+      @occurs_on = occurs_on unless occurs_on == SKIP
+      @recurrence_day = recurrence_day unless recurrence_day == SKIP
+      @recurrence_type = recurrence_type unless recurrence_type == SKIP
+      @transaction_type = transaction_type unless transaction_type == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      is_completed = hash.key?('is_completed') ? hash['is_completed'] : SKIP
+      is_recurring = hash.key?('is_recurring') ? hash['is_recurring'] : SKIP
+      merchant_guid = hash.key?('merchant_guid') ? hash['merchant_guid'] : SKIP
+      occurs_on = hash.key?('occurs_on') ? hash['occurs_on'] : SKIP
+      recurrence_day =
+        hash.key?('recurrence_day') ? hash['recurrence_day'] : SKIP
+      recurrence_type =
+        hash.key?('recurrence_type') ? hash['recurrence_type'] : SKIP
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : 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.
+      ScheduledPaymentResponse.new(amount: amount,
+                                   created_at: created_at,
+                                   description: description,
+                                   guid: guid,
+                                   is_completed: is_completed,
+                                   is_recurring: is_recurring,
+                                   merchant_guid: merchant_guid,
+                                   occurs_on: occurs_on,
+                                   recurrence_day: recurrence_day,
+                                   recurrence_type: recurrence_type,
+                                   transaction_type: transaction_type,
+                                   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} amount: #{@amount}, created_at: #{@created_at}, description:"\
+      " #{@description}, guid: #{@guid}, is_completed: #{@is_completed}, is_recurring:"\
+      " #{@is_recurring}, merchant_guid: #{@merchant_guid}, occurs_on: #{@occurs_on},"\
+      " recurrence_day: #{@recurrence_day}, recurrence_type: #{@recurrence_type},"\
+      " transaction_type: #{@transaction_type}, 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} amount: #{@amount.inspect}, created_at: #{@created_at.inspect},"\
+      " description: #{@description.inspect}, guid: #{@guid.inspect}, is_completed:"\
+      " #{@is_completed.inspect}, is_recurring: #{@is_recurring.inspect}, merchant_guid:"\
+      " #{@merchant_guid.inspect}, occurs_on: #{@occurs_on.inspect}, recurrence_day:"\
+      " #{@recurrence_day.inspect}, recurrence_type: #{@recurrence_type.inspect},"\
+      " transaction_type: #{@transaction_type.inspect}, updated_at: #{@updated_at.inspect},"\
+      " user_guid: #{@user_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

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

data/lib/mx_platform_api/models/spending_plan_account_response.rb

@@ -0,0 +1,142 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # SpendingPlanAccountResponse Model.
+  class SpendingPlanAccountResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The unique identifier for the client associated with the insight. Defined
+    # by MX.
+    # @return [String]
+    attr_accessor :client_guid
+
+    # The date and time the spending plan account was created, represented in
+    # ISO 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The unique identifier for the spending plan account. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The unique identifier for the spending plan. Defined by MX.
+    # @return [String]
+    attr_accessor :spending_plan_guid
+
+    # 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['account_guid'] = 'account_guid'
+      @_hash['client_guid'] = 'client_guid'
+      @_hash['created_at'] = 'created_at'
+      @_hash['guid'] = 'guid'
+      @_hash['spending_plan_guid'] = 'spending_plan_guid'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        client_guid
+        created_at
+        guid
+        spending_plan_guid
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_guid: SKIP, client_guid: SKIP, created_at: SKIP,
+                   guid: SKIP, spending_plan_guid: SKIP, updated_at: 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
+      @client_guid = client_guid unless client_guid == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @guid = guid unless guid == SKIP
+      @spending_plan_guid = spending_plan_guid unless spending_plan_guid == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      client_guid = hash.key?('client_guid') ? hash['client_guid'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      spending_plan_guid =
+        hash.key?('spending_plan_guid') ? hash['spending_plan_guid'] : 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.
+      SpendingPlanAccountResponse.new(account_guid: account_guid,
+                                      client_guid: client_guid,
+                                      created_at: created_at,
+                                      guid: guid,
+                                      spending_plan_guid: spending_plan_guid,
+                                      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} account_guid: #{@account_guid}, client_guid: #{@client_guid}, created_at:"\
+      " #{@created_at}, guid: #{@guid}, spending_plan_guid: #{@spending_plan_guid}, 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} account_guid: #{@account_guid.inspect}, client_guid:"\
+      " #{@client_guid.inspect}, created_at: #{@created_at.inspect}, guid: #{@guid.inspect},"\
+      " spending_plan_guid: #{@spending_plan_guid.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_accounts_response.rb

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

data/lib/mx_platform_api/models/spending_plan_iteration_item_create_request_body.rb

@@ -0,0 +1,124 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # SpendingPlanIterationItemCreateRequestBody Model.
+  class SpendingPlanIterationItemCreateRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The type of transaction grouping for the spending plan `iteration_item` (0
+    # = `RECURRING_EXPENSE`, 1 = `PLANNED_EXPENSE`, 2 = `OTHER_EXPENSE`, 3 =
+    # `INCOME`).
+    # @return [Float]
+    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 `top_level_category_guid` associated with
+    # the spending plan `iteration_item`. Defined by MX.
+    # @return [String]
+    attr_accessor :top_level_category_guid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['item_type'] = 'item_type'
+      @_hash['planned_amount'] = 'planned_amount'
+      @_hash['scheduled_payment_guid'] = 'scheduled_payment_guid'
+      @_hash['top_level_category_guid'] = 'top_level_category_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_guid
+        item_type
+        scheduled_payment_guid
+        top_level_category_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(planned_amount:, category_guid: SKIP, item_type: SKIP,
+                   scheduled_payment_guid: SKIP, top_level_category_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category_guid = category_guid unless category_guid == SKIP
+      @item_type = item_type unless item_type == SKIP
+      @planned_amount = planned_amount
+      @scheduled_payment_guid = scheduled_payment_guid unless scheduled_payment_guid == SKIP
+      @top_level_category_guid = top_level_category_guid unless top_level_category_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.
+      planned_amount =
+        hash.key?('planned_amount') ? hash['planned_amount'] : nil
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      item_type = hash.key?('item_type') ? hash['item_type'] : SKIP
+      scheduled_payment_guid =
+        hash.key?('scheduled_payment_guid') ? hash['scheduled_payment_guid'] : SKIP
+      top_level_category_guid =
+        hash.key?('top_level_category_guid') ? hash['top_level_category_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.
+      SpendingPlanIterationItemCreateRequestBody.new(planned_amount: planned_amount,
+                                                     category_guid: category_guid,
+                                                     item_type: item_type,
+                                                     scheduled_payment_guid: scheduled_payment_guid,
+                                                     top_level_category_guid: top_level_category_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} category_guid: #{@category_guid}, item_type: #{@item_type}, planned_amount:"\
+      " #{@planned_amount}, scheduled_payment_guid: #{@scheduled_payment_guid},"\
+      " top_level_category_guid: #{@top_level_category_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} category_guid: #{@category_guid.inspect}, item_type: #{@item_type.inspect},"\
+      " planned_amount: #{@planned_amount.inspect}, scheduled_payment_guid:"\
+      " #{@scheduled_payment_guid.inspect}, top_level_category_guid:"\
+      " #{@top_level_category_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end