apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/tasks_request.rb

@@ -0,0 +1,183 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApolloRestApi
+  # TasksRequest Model.
+  class TasksRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for the task owner within your team's Apollo account. This is the
+    # user that will take action on the contacts. <br><br>Use the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-users"
+    # target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
+    # of the users within your Apollo account. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @return [String]
+    attr_accessor :user_id
+
+    # The Apollo ID for the contact that you want to be on the receiving end of
+    # the action. <br><br>To find contact IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts"
+    # target="_blank">Search for Contacts endpoint</a> and identify the `id`
+    # value for the contact. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @return [String]
+    attr_accessor :contact_id
+
+    # Set the task to be 1 of the following task types. This enables the task
+    # owner to know the type of action they need to take. <ul> <li> `call`: Call
+    # the contact. </li> <li> `outreach_manual_email`: Email the contact. </li>
+    # <li> `linkedin_step_connect`: Send a LinkedIn invitation to connect with
+    # the contact. </li> <li> `linkedin_step_message`: Send a direct message to
+    # the contact's LinkedIn profile. </li> <li> `linkedin_step_view_profile`:
+    # View the contact's LinkedIn profile. </li> <li>
+    # `linkedin_step_interact_post`: Interact with the contact's recent LinkedIn
+    # posts. </li> <li> `action_item`: Take generic action for the contact. If
+    # you use this task type, Apollo recommends using the `note` parameter too.
+    # </li> </ul>
+    # @return [String]
+    attr_accessor :type
+
+    # Assign a priority to the task you are creating: <ul> <li> `high` </li>
+    # <li> `medium` </li> <li> `low` </li> </ul>
+    # @return [String]
+    attr_accessor :priority
+
+    # The status of the task being created. For future-facing tasks, you should
+    # use the `scheduled` status. <br><br>For tasks that are already completed,
+    # you can use `completed` or `skipped`. <br><br>Example: `scheduled`
+    # @return [String]
+    attr_accessor :status
+
+    # The full date and time when the task will be due. <br><br>Your entry
+    # should adhere to the <a
+    # href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6"
+    # target="_blank">ISO 8601 date-time format</a>. Apollo uses Greenwich Mean
+    # Time (GMT) by default. If you do not account for time zone differences,
+    # you could add a task due date that falls on a different day than you
+    # intended. <br><br>The value you enter can either adhere to GMT, or you can
+    # adjust the time manually by specifying in hours and minutes how much you
+    # want to offset GMT.<br><br>Example: `2025-02-15T08:10:30Z`;
+    # `2025-03-25T10:15:30+05:00`
+    # @return [DateTime]
+    attr_accessor :due_at
+
+    # A title for the task. If omitted, Apollo will display an auto-generated
+    # title based on the task type and contact name. <br><br>Example: `Follow up
+    # on demo request`
+    # @return [String]
+    attr_accessor :title
+
+    # Add a description for the task. This should be a human-readable message.
+    # <br><br>This parameter is not required, but it is recommended as it
+    # provides the task owner with more context on the action they need to take.
+    # <br><br>Example: `This contact expressed interest in the Sequences feature
+    # specifically. Be prepared to discuss.`
+    # @return [String]
+    attr_accessor :note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_id'] = 'user_id'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['type'] = 'type'
+      @_hash['priority'] = 'priority'
+      @_hash['status'] = 'status'
+      @_hash['due_at'] = 'due_at'
+      @_hash['title'] = 'title'
+      @_hash['note'] = 'note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        priority
+        title
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_id:, contact_id:, type:, status:, due_at:,
+                   priority: 'medium', title: SKIP, note: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_id = user_id
+      @contact_id = contact_id
+      @type = type
+      @priority = priority unless priority == SKIP
+      @status = status
+      @due_at = due_at
+      @title = title unless title == SKIP
+      @note = note unless note == 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?('user_id') ? hash['user_id'] : nil
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      due_at = if hash.key?('due_at')
+                 (DateTimeHelper.from_rfc3339(hash['due_at']) if hash['due_at'])
+               end
+      priority = hash['priority'] ||= 'medium'
+      title = hash.key?('title') ? hash['title'] : SKIP
+      note = hash.key?('note') ? hash['note'] : 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.
+      TasksRequest.new(user_id: user_id,
+                       contact_id: contact_id,
+                       type: type,
+                       status: status,
+                       due_at: due_at,
+                       priority: priority,
+                       title: title,
+                       note: note,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_due_at
+      DateTimeHelper.to_rfc3339(due_at)
+    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}, contact_id: #{@contact_id}, type: #{@type}, priority:"\
+      " #{@priority}, status: #{@status}, due_at: #{@due_at}, title: #{@title}, note: #{@note},"\
+      " 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}, contact_id: #{@contact_id.inspect}, type:"\
+      " #{@type.inspect}, priority: #{@priority.inspect}, status: #{@status.inspect}, due_at:"\
+      " #{@due_at.inspect}, title: #{@title.inspect}, note: #{@note.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/tasks_request1.rb

@@ -0,0 +1,227 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApolloRestApi
+  # TasksRequest1 Model.
+  class TasksRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for the task owner within your team's Apollo account. Only applies
+    # to tasks with a `scheduled` status. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @return [String]
+    attr_accessor :user_id
+
+    # The ID of the user considered the creator of this task. Only applies to
+    # tasks with a `scheduled` status. <br><br>If this task currently has a
+    # `scheduled` status and you omit this parameter, Apollo resets it to the
+    # user associated with your API key. <br><br>Example:
+    # `60affe7d6e270a00f5db6fe4`
+    # @return [String]
+    attr_accessor :creator_id
+
+    # The Apollo ID for the contact you want on the receiving end of the action.
+    # <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @return [String]
+    attr_accessor :contact_id
+
+    # A description for the task. This should be a human-readable message.
+    # <br><br>Example: `This contact expressed interest in the Sequences feature
+    # specifically. Be prepared to discuss.`
+    # @return [String]
+    attr_accessor :note
+
+    # Only applies to tasks with a `scheduled` status. Set the task to 1 of the
+    # following task types: <ul> <li> `call`: Call the contact. </li> <li>
+    # `outreach_manual_email`: Email the contact. </li> <li>
+    # `linkedin_step_connect`: Send a LinkedIn invitation to connect with the
+    # contact. </li> <li> `linkedin_step_message`: Send a direct message to the
+    # contact's LinkedIn profile. </li> <li> `linkedin_step_view_profile`: View
+    # the contact's LinkedIn profile. </li> <li> `linkedin_step_interact_post`:
+    # Interact with the contact's recent LinkedIn posts. </li> <li>
+    # `action_item`: Take generic action for the contact. </li> </ul>
+    # @return [String]
+    attr_accessor :type
+
+    # Assign a priority to the task: `high`, `medium`, or `low`. <br><br>If this
+    # task currently has a `scheduled` status and you omit this parameter,
+    # Apollo resets its priority to `medium`.
+    # @return [String]
+    attr_accessor :priority
+
+    # Numeric-coded alternative to `priority`. Only applies to tasks that are
+    # not `scheduled` (already `completed` or `skipped`).
+    # @return [Object]
+    attr_accessor :priority_cd
+
+    # Only applies to tasks with a `scheduled` status. To mark a task done, use
+    # the <a href="https://docs.apollo.io/reference/complete-a-task">Complete a
+    # Task</a> or <a href="https://docs.apollo.io/reference/skip-a-task">Skip a
+    # Task</a> endpoints instead of setting this directly. <br><br>Example:
+    # `scheduled`
+    # @return [String]
+    attr_accessor :status
+
+    # Only applies to tasks with a `scheduled` status. The full date and time
+    # when the task is due, in <a
+    # href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6"
+    # target="_blank">ISO 8601</a> format. <br><br>Example:
+    # `2025-02-15T08:10:30Z`
+    # @return [DateTime]
+    attr_accessor :due_at
+
+    # Only applies to tasks with a `scheduled` status. A title for the task.
+    # <br><br>Example: `Follow up on demo request`
+    # @return [String]
+    attr_accessor :title
+
+    # Only applies to tasks with a `scheduled` status. A call script or talking
+    # points for a `call` type task.
+    # @return [String]
+    attr_accessor :call_script
+
+    # Only applies to tasks with a `scheduled` status. Names of team-defined
+    # relevant fields to surface for this task.
+    # @return [Array[Object]]
+    attr_accessor :relevant_fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_id'] = 'user_id'
+      @_hash['creator_id'] = 'creator_id'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['note'] = 'note'
+      @_hash['type'] = 'type'
+      @_hash['priority'] = 'priority'
+      @_hash['priority_cd'] = 'priority_cd'
+      @_hash['status'] = 'status'
+      @_hash['due_at'] = 'due_at'
+      @_hash['title'] = 'title'
+      @_hash['call_script'] = 'call_script'
+      @_hash['relevant_fields'] = 'relevant_fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_id
+        creator_id
+        contact_id
+        note
+        type
+        priority
+        priority_cd
+        status
+        due_at
+        title
+        call_script
+        relevant_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_id: SKIP, creator_id: SKIP, contact_id: SKIP,
+                   note: SKIP, type: SKIP, priority: 'medium',
+                   priority_cd: SKIP, status: SKIP, due_at: SKIP, title: SKIP,
+                   call_script: SKIP, relevant_fields: 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
+      @creator_id = creator_id unless creator_id == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @note = note unless note == SKIP
+      @type = type unless type == SKIP
+      @priority = priority unless priority == SKIP
+      @priority_cd = priority_cd unless priority_cd == SKIP
+      @status = status unless status == SKIP
+      @due_at = due_at unless due_at == SKIP
+      @title = title unless title == SKIP
+      @call_script = call_script unless call_script == SKIP
+      @relevant_fields = relevant_fields unless relevant_fields == 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?('user_id') ? hash['user_id'] : SKIP
+      creator_id = hash.key?('creator_id') ? hash['creator_id'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      note = hash.key?('note') ? hash['note'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      priority = hash['priority'] ||= 'medium'
+      priority_cd = hash.key?('priority_cd') ? hash['priority_cd'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      due_at = if hash.key?('due_at')
+                 (DateTimeHelper.from_rfc3339(hash['due_at']) if hash['due_at'])
+               else
+                 SKIP
+               end
+      title = hash.key?('title') ? hash['title'] : SKIP
+      call_script = hash.key?('call_script') ? hash['call_script'] : SKIP
+      relevant_fields =
+        hash.key?('relevant_fields') ? hash['relevant_fields'] : 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.
+      TasksRequest1.new(user_id: user_id,
+                        creator_id: creator_id,
+                        contact_id: contact_id,
+                        note: note,
+                        type: type,
+                        priority: priority,
+                        priority_cd: priority_cd,
+                        status: status,
+                        due_at: due_at,
+                        title: title,
+                        call_script: call_script,
+                        relevant_fields: relevant_fields,
+                        additional_properties: additional_properties)
+    end
+
+    def to_custom_due_at
+      DateTimeHelper.to_rfc3339(due_at)
+    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}, creator_id: #{@creator_id}, contact_id:"\
+      " #{@contact_id}, note: #{@note}, type: #{@type}, priority: #{@priority}, priority_cd:"\
+      " #{@priority_cd}, status: #{@status}, due_at: #{@due_at}, title: #{@title}, call_script:"\
+      " #{@call_script}, relevant_fields: #{@relevant_fields}, 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}, creator_id: #{@creator_id.inspect},"\
+      " contact_id: #{@contact_id.inspect}, note: #{@note.inspect}, type: #{@type.inspect},"\
+      " priority: #{@priority.inspect}, priority_cd: #{@priority_cd.inspect}, status:"\
+      " #{@status.inspect}, due_at: #{@due_at.inspect}, title: #{@title.inspect}, call_script:"\
+      " #{@call_script.inspect}, relevant_fields: #{@relevant_fields.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/tasks_response.rb

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

data/lib/apollo_rest_api/models/tasks_response1.rb

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

data/lib/apollo_rest_api/models/tasks_search_response.rb

@@ -0,0 +1,136 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # TasksSearchResponse Model.
+  class TasksSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Task]]
+    attr_accessor :tasks
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :breadcrumbs
+
+    # TODO: Write general description for this method
+    # @return [Pagination]
+    attr_accessor :pagination
+
+    # TODO: Write general description for this method
+    # @return [Faceting]
+    attr_accessor :faceting
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :pipeline_total
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :num_fetch_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tasks'] = 'tasks'
+      @_hash['breadcrumbs'] = 'breadcrumbs'
+      @_hash['pagination'] = 'pagination'
+      @_hash['faceting'] = 'faceting'
+      @_hash['pipeline_total'] = 'pipeline_total'
+      @_hash['num_fetch_result'] = 'num_fetch_result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tasks
+        breadcrumbs
+        pagination
+        faceting
+        pipeline_total
+        num_fetch_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tasks: SKIP, breadcrumbs: SKIP, pagination: SKIP,
+                   faceting: SKIP, pipeline_total: 0, num_fetch_result: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tasks = tasks unless tasks == SKIP
+      @breadcrumbs = breadcrumbs unless breadcrumbs == SKIP
+      @pagination = pagination unless pagination == SKIP
+      @faceting = faceting unless faceting == SKIP
+      @pipeline_total = pipeline_total unless pipeline_total == SKIP
+      @num_fetch_result = num_fetch_result unless num_fetch_result == 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
+      tasks = nil
+      unless hash['tasks'].nil?
+        tasks = []
+        hash['tasks'].each do |structure|
+          tasks << (Task.from_hash(structure) if structure)
+        end
+      end
+
+      tasks = SKIP unless hash.key?('tasks')
+      breadcrumbs = hash.key?('breadcrumbs') ? hash['breadcrumbs'] : SKIP
+      pagination = Pagination.from_hash(hash['pagination']) if hash['pagination']
+      faceting = Faceting.from_hash(hash['faceting']) if hash['faceting']
+      pipeline_total = hash['pipeline_total'] ||= 0
+      num_fetch_result =
+        hash.key?('num_fetch_result') ? hash['num_fetch_result'] : 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.
+      TasksSearchResponse.new(tasks: tasks,
+                              breadcrumbs: breadcrumbs,
+                              pagination: pagination,
+                              faceting: faceting,
+                              pipeline_total: pipeline_total,
+                              num_fetch_result: num_fetch_result,
+                              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} tasks: #{@tasks}, breadcrumbs: #{@breadcrumbs}, pagination: #{@pagination},"\
+      " faceting: #{@faceting}, pipeline_total: #{@pipeline_total}, num_fetch_result:"\
+      " #{@num_fetch_result}, 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} tasks: #{@tasks.inspect}, breadcrumbs: #{@breadcrumbs.inspect}, pagination:"\
+      " #{@pagination.inspect}, faceting: #{@faceting.inspect}, pipeline_total:"\
+      " #{@pipeline_total.inspect}, num_fetch_result: #{@num_fetch_result.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end