xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/project.rb

@@ -0,0 +1,328 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module XeroApIs
+  # Project Model.
+  class Project < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the project.
+    # @return [UUID | String]
+    attr_accessor :project_id
+
+    # Identifier of the contact this project was created for.
+    # @return [UUID | String]
+    attr_accessor :contact_id
+
+    # Name of the project.
+    # @return [String]
+    attr_accessor :name
+
+    # 3 letter alpha code for the ISO-4217 currency code, e.g. USD, AUD.
+    # @return [CurrencyCode1]
+    attr_accessor :currency_code
+
+    # A total of minutes logged against all tasks on the Project.
+    # @return [Integer]
+    attr_accessor :minutes_logged
+
+    # A total of minutes logged against all tasks on the Project.
+    # @return [Amount]
+    attr_accessor :total_task_amount
+
+    # A total of minutes logged against all tasks on the Project.
+    # @return [Amount]
+    attr_accessor :total_expense_amount
+
+    # A total of minutes logged against all tasks on the Project.
+    # @return [Amount]
+    attr_accessor :estimate_amount
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Integer]
+    attr_accessor :minutes_to_be_invoiced
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :task_amount_to_be_invoiced
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :task_amount_invoiced
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :expense_amount_to_be_invoiced
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :expense_amount_invoiced
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :project_amount_invoiced
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :deposit
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :deposit_applied
+
+    # Minutes which have not been invoiced across all chargeable tasks in the
+    # project.
+    # @return [Amount]
+    attr_accessor :credit_note_amount
+
+    # Deadline for the project. UTC Date Time in ISO-8601 format.
+    # @return [DateTime]
+    attr_accessor :deadline_utc
+
+    # Deadline for the project. UTC Date Time in ISO-8601 format.
+    # @return [Amount]
+    attr_accessor :total_invoiced
+
+    # Deadline for the project. UTC Date Time in ISO-8601 format.
+    # @return [Amount]
+    attr_accessor :total_to_be_invoiced
+
+    # Deadline for the project. UTC Date Time in ISO-8601 format.
+    # @return [Amount]
+    attr_accessor :estimate
+
+    # Status for project
+    # @return [ProjectStatus]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['project_id'] = 'projectId'
+      @_hash['contact_id'] = 'contactId'
+      @_hash['name'] = 'name'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['minutes_logged'] = 'minutesLogged'
+      @_hash['total_task_amount'] = 'totalTaskAmount'
+      @_hash['total_expense_amount'] = 'totalExpenseAmount'
+      @_hash['estimate_amount'] = 'estimateAmount'
+      @_hash['minutes_to_be_invoiced'] = 'minutesToBeInvoiced'
+      @_hash['task_amount_to_be_invoiced'] = 'taskAmountToBeInvoiced'
+      @_hash['task_amount_invoiced'] = 'taskAmountInvoiced'
+      @_hash['expense_amount_to_be_invoiced'] = 'expenseAmountToBeInvoiced'
+      @_hash['expense_amount_invoiced'] = 'expenseAmountInvoiced'
+      @_hash['project_amount_invoiced'] = 'projectAmountInvoiced'
+      @_hash['deposit'] = 'deposit'
+      @_hash['deposit_applied'] = 'depositApplied'
+      @_hash['credit_note_amount'] = 'creditNoteAmount'
+      @_hash['deadline_utc'] = 'deadlineUtc'
+      @_hash['total_invoiced'] = 'totalInvoiced'
+      @_hash['total_to_be_invoiced'] = 'totalToBeInvoiced'
+      @_hash['estimate'] = 'estimate'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        project_id
+        contact_id
+        currency_code
+        minutes_logged
+        total_task_amount
+        total_expense_amount
+        estimate_amount
+        minutes_to_be_invoiced
+        task_amount_to_be_invoiced
+        task_amount_invoiced
+        expense_amount_to_be_invoiced
+        expense_amount_invoiced
+        project_amount_invoiced
+        deposit
+        deposit_applied
+        credit_note_amount
+        deadline_utc
+        total_invoiced
+        total_to_be_invoiced
+        estimate
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, project_id: SKIP, contact_id: SKIP,
+                   currency_code: SKIP, minutes_logged: SKIP,
+                   total_task_amount: SKIP, total_expense_amount: SKIP,
+                   estimate_amount: SKIP, minutes_to_be_invoiced: SKIP,
+                   task_amount_to_be_invoiced: SKIP, task_amount_invoiced: SKIP,
+                   expense_amount_to_be_invoiced: SKIP,
+                   expense_amount_invoiced: SKIP, project_amount_invoiced: SKIP,
+                   deposit: SKIP, deposit_applied: SKIP,
+                   credit_note_amount: SKIP, deadline_utc: SKIP,
+                   total_invoiced: SKIP, total_to_be_invoiced: SKIP,
+                   estimate: SKIP, status: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @project_id = project_id unless project_id == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @name = name
+      @currency_code = currency_code unless currency_code == SKIP
+      @minutes_logged = minutes_logged unless minutes_logged == SKIP
+      @total_task_amount = total_task_amount unless total_task_amount == SKIP
+      @total_expense_amount = total_expense_amount unless total_expense_amount == SKIP
+      @estimate_amount = estimate_amount unless estimate_amount == SKIP
+      @minutes_to_be_invoiced = minutes_to_be_invoiced unless minutes_to_be_invoiced == SKIP
+      unless task_amount_to_be_invoiced == SKIP
+        @task_amount_to_be_invoiced =
+          task_amount_to_be_invoiced
+      end
+      @task_amount_invoiced = task_amount_invoiced unless task_amount_invoiced == SKIP
+      unless expense_amount_to_be_invoiced == SKIP
+        @expense_amount_to_be_invoiced =
+          expense_amount_to_be_invoiced
+      end
+      @expense_amount_invoiced = expense_amount_invoiced unless expense_amount_invoiced == SKIP
+      @project_amount_invoiced = project_amount_invoiced unless project_amount_invoiced == SKIP
+      @deposit = deposit unless deposit == SKIP
+      @deposit_applied = deposit_applied unless deposit_applied == SKIP
+      @credit_note_amount = credit_note_amount unless credit_note_amount == SKIP
+      @deadline_utc = deadline_utc unless deadline_utc == SKIP
+      @total_invoiced = total_invoiced unless total_invoiced == SKIP
+      @total_to_be_invoiced = total_to_be_invoiced unless total_to_be_invoiced == SKIP
+      @estimate = estimate unless estimate == SKIP
+      @status = status unless status == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : SKIP
+      contact_id = hash.key?('contactId') ? hash['contactId'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      minutes_logged = hash.key?('minutesLogged') ? hash['minutesLogged'] : SKIP
+      total_task_amount = Amount.from_hash(hash['totalTaskAmount']) if hash['totalTaskAmount']
+      total_expense_amount = Amount.from_hash(hash['totalExpenseAmount']) if
+        hash['totalExpenseAmount']
+      estimate_amount = Amount.from_hash(hash['estimateAmount']) if hash['estimateAmount']
+      minutes_to_be_invoiced =
+        hash.key?('minutesToBeInvoiced') ? hash['minutesToBeInvoiced'] : SKIP
+      task_amount_to_be_invoiced = Amount.from_hash(hash['taskAmountToBeInvoiced']) if
+        hash['taskAmountToBeInvoiced']
+      task_amount_invoiced = Amount.from_hash(hash['taskAmountInvoiced']) if
+        hash['taskAmountInvoiced']
+      expense_amount_to_be_invoiced = Amount.from_hash(hash['expenseAmountToBeInvoiced']) if
+        hash['expenseAmountToBeInvoiced']
+      expense_amount_invoiced = Amount.from_hash(hash['expenseAmountInvoiced']) if
+        hash['expenseAmountInvoiced']
+      project_amount_invoiced = Amount.from_hash(hash['projectAmountInvoiced']) if
+        hash['projectAmountInvoiced']
+      deposit = Amount.from_hash(hash['deposit']) if hash['deposit']
+      deposit_applied = Amount.from_hash(hash['depositApplied']) if hash['depositApplied']
+      credit_note_amount = Amount.from_hash(hash['creditNoteAmount']) if hash['creditNoteAmount']
+      deadline_utc = if hash.key?('deadlineUtc')
+                       (DateTimeHelper.from_rfc3339(hash['deadlineUtc']) if hash['deadlineUtc'])
+                     else
+                       SKIP
+                     end
+      total_invoiced = Amount.from_hash(hash['totalInvoiced']) if hash['totalInvoiced']
+      total_to_be_invoiced = Amount.from_hash(hash['totalToBeInvoiced']) if
+        hash['totalToBeInvoiced']
+      estimate = Amount.from_hash(hash['estimate']) if hash['estimate']
+      status = hash.key?('status') ? hash['status'] : 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.
+      Project.new(name: name,
+                  project_id: project_id,
+                  contact_id: contact_id,
+                  currency_code: currency_code,
+                  minutes_logged: minutes_logged,
+                  total_task_amount: total_task_amount,
+                  total_expense_amount: total_expense_amount,
+                  estimate_amount: estimate_amount,
+                  minutes_to_be_invoiced: minutes_to_be_invoiced,
+                  task_amount_to_be_invoiced: task_amount_to_be_invoiced,
+                  task_amount_invoiced: task_amount_invoiced,
+                  expense_amount_to_be_invoiced: expense_amount_to_be_invoiced,
+                  expense_amount_invoiced: expense_amount_invoiced,
+                  project_amount_invoiced: project_amount_invoiced,
+                  deposit: deposit,
+                  deposit_applied: deposit_applied,
+                  credit_note_amount: credit_note_amount,
+                  deadline_utc: deadline_utc,
+                  total_invoiced: total_invoiced,
+                  total_to_be_invoiced: total_to_be_invoiced,
+                  estimate: estimate,
+                  status: status,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_deadline_utc
+      DateTimeHelper.to_rfc3339(deadline_utc)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} project_id: #{@project_id}, contact_id: #{@contact_id}, name: #{@name},"\
+      " currency_code: #{@currency_code}, minutes_logged: #{@minutes_logged}, total_task_amount:"\
+      " #{@total_task_amount}, total_expense_amount: #{@total_expense_amount}, estimate_amount:"\
+      " #{@estimate_amount}, minutes_to_be_invoiced: #{@minutes_to_be_invoiced},"\
+      " task_amount_to_be_invoiced: #{@task_amount_to_be_invoiced}, task_amount_invoiced:"\
+      " #{@task_amount_invoiced}, expense_amount_to_be_invoiced:"\
+      " #{@expense_amount_to_be_invoiced}, expense_amount_invoiced: #{@expense_amount_invoiced},"\
+      " project_amount_invoiced: #{@project_amount_invoiced}, deposit: #{@deposit},"\
+      " deposit_applied: #{@deposit_applied}, credit_note_amount: #{@credit_note_amount},"\
+      " deadline_utc: #{@deadline_utc}, total_invoiced: #{@total_invoiced}, total_to_be_invoiced:"\
+      " #{@total_to_be_invoiced}, estimate: #{@estimate}, status: #{@status},"\
+      " 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} project_id: #{@project_id.inspect}, contact_id: #{@contact_id.inspect},"\
+      " name: #{@name.inspect}, currency_code: #{@currency_code.inspect}, minutes_logged:"\
+      " #{@minutes_logged.inspect}, total_task_amount: #{@total_task_amount.inspect},"\
+      " total_expense_amount: #{@total_expense_amount.inspect}, estimate_amount:"\
+      " #{@estimate_amount.inspect}, minutes_to_be_invoiced: #{@minutes_to_be_invoiced.inspect},"\
+      " task_amount_to_be_invoiced: #{@task_amount_to_be_invoiced.inspect}, task_amount_invoiced:"\
+      " #{@task_amount_invoiced.inspect}, expense_amount_to_be_invoiced:"\
+      " #{@expense_amount_to_be_invoiced.inspect}, expense_amount_invoiced:"\
+      " #{@expense_amount_invoiced.inspect}, project_amount_invoiced:"\
+      " #{@project_amount_invoiced.inspect}, deposit: #{@deposit.inspect}, deposit_applied:"\
+      " #{@deposit_applied.inspect}, credit_note_amount: #{@credit_note_amount.inspect},"\
+      " deadline_utc: #{@deadline_utc.inspect}, total_invoiced: #{@total_invoiced.inspect},"\
+      " total_to_be_invoiced: #{@total_to_be_invoiced.inspect}, estimate: #{@estimate.inspect},"\
+      " status: #{@status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/project_create_or_update.rb

@@ -0,0 +1,115 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module XeroApIs
+  # ProjectCreateOrUpdate Model.
+  class ProjectCreateOrUpdate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the contact this project was created for.
+    # @return [UUID | String]
+    attr_accessor :contact_id
+
+    # Name of the project.
+    # @return [String]
+    attr_accessor :name
+
+    # Name of the project.
+    # @return [Float]
+    attr_accessor :estimate_amount
+
+    # Deadline for the project. UTC Date Time in ISO-8601 format.
+    # @return [DateTime]
+    attr_accessor :deadline_utc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_id'] = 'contactId'
+      @_hash['name'] = 'name'
+      @_hash['estimate_amount'] = 'estimateAmount'
+      @_hash['deadline_utc'] = 'deadlineUtc'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_id
+        estimate_amount
+        deadline_utc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, contact_id: SKIP, estimate_amount: SKIP,
+                   deadline_utc: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact_id = contact_id unless contact_id == SKIP
+      @name = name
+      @estimate_amount = estimate_amount unless estimate_amount == SKIP
+      @deadline_utc = deadline_utc unless deadline_utc == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      contact_id = hash.key?('contactId') ? hash['contactId'] : SKIP
+      estimate_amount =
+        hash.key?('estimateAmount') ? hash['estimateAmount'] : SKIP
+      deadline_utc = if hash.key?('deadlineUtc')
+                       (DateTimeHelper.from_rfc3339(hash['deadlineUtc']) if hash['deadlineUtc'])
+                     else
+                       SKIP
+                     end
+
+      # 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.
+      ProjectCreateOrUpdate.new(name: name,
+                                contact_id: contact_id,
+                                estimate_amount: estimate_amount,
+                                deadline_utc: deadline_utc,
+                                additional_properties: additional_properties)
+    end
+
+    def to_custom_deadline_utc
+      DateTimeHelper.to_rfc3339(deadline_utc)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_id: #{@contact_id}, name: #{@name}, estimate_amount:"\
+      " #{@estimate_amount}, deadline_utc: #{@deadline_utc}, 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} contact_id: #{@contact_id.inspect}, name: #{@name.inspect},"\
+      " estimate_amount: #{@estimate_amount.inspect}, deadline_utc: #{@deadline_utc.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/project_patch.rb

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

data/lib/xero_ap_is/models/project_status.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Status for project
+  class ProjectStatus
+    PROJECT_STATUS = [
+      # TODO: Write general description for INPROGRESS
+      INPROGRESS = 'INPROGRESS'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'CLOSED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROJECT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = INPROGRESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'inprogress' then INPROGRESS
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/project_user.rb

@@ -0,0 +1,95 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ProjectUser Model.
+  class ProjectUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the user of the project.
+    # @return [UUID | String]
+    attr_accessor :user_id
+
+    # Full name of the user.
+    # @return [String]
+    attr_accessor :name
+
+    # Email address of the user.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_id'] = 'userId'
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_id
+        name
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_id: SKIP, name: SKIP, email: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_id = user_id unless user_id == SKIP
+      @name = name unless name == SKIP
+      @email = email unless email == 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.
+      user_id = hash.key?('userId') ? hash['userId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : 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.
+      ProjectUser.new(user_id: user_id,
+                      name: name,
+                      email: email,
+                      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} user_id: #{@user_id}, name: #{@name}, email: #{@email},"\
+      " 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} user_id: #{@user_id.inspect}, name: #{@name.inspect}, email:"\
+      " #{@email.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end