apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/conversations_response.rb

@@ -0,0 +1,333 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ConversationsResponse Model.
+  class ConversationsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique conversation ID.
+    # @return [String]
+    attr_accessor :id
+
+    # Conversation topic or title.
+    # @return [String]
+    attr_accessor :topic
+
+    # Conversation start time (ISO 8601). Apollo uses Greenwich Mean Time (GMT)
+    # for all date and time values.
+    # @return [String]
+    attr_accessor :start_time
+
+    # Duration of the conversation in seconds.
+    # @return [Integer]
+    attr_accessor :duration
+
+    # Current processing state of the conversation.
+    # @return [String]
+    attr_accessor :state
+
+    # Name of the conversation host.
+    # @return [String]
+    attr_accessor :host
+
+    # User ID of the conversation host.
+    # @return [String]
+    attr_accessor :host_id
+
+    # Privacy setting of the conversation.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_private
+
+    # Whether the conversation has been pushed to a CRM.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pushed_to_crm
+
+    # IDs of accounts associated with the conversation.
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # Map of label IDs to label names associated with the conversation.
+    # @return [Array[String]]
+    attr_accessor :label_id_names
+
+    # Whether the conversation has been shared.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_shared_conversation
+
+    # IDs of opportunities associated with the conversation.
+    # @return [Array[String]]
+    attr_accessor :opportunity_ids
+
+    # Number of comments on the conversation.
+    # @return [Integer]
+    attr_accessor :comment_count
+
+    # Error code if the conversation processing failed. Returns
+    # <code>null</code> if no failure occurred.
+    # @return [String]
+    attr_accessor :failure_code
+
+    # Reason the bot call ended. Returns <code>null</code> if not applicable.
+    # @return [String]
+    attr_accessor :bot_call_ended_reason
+
+    # Type of conversation.
+    # @return [ConversationType2]
+    attr_accessor :conversation_type
+
+    # Whether the conversation is a clip.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_clip
+
+    # Video recording details for the conversation.
+    # @return [VideoRecording]
+    attr_accessor :video_recording
+
+    # Audio recording details for the conversation.
+    # @return [AudioRecording]
+    attr_accessor :audio_recording
+
+    # Transcript of the conversation.
+    # @return [Array[Object]]
+    attr_accessor :transcript
+
+    # Participants in the conversation, grouped by internal and external.
+    # @return [Participants]
+    attr_accessor :participants
+
+    # Opportunities associated with the conversation.
+    # @return [Array[Opportunity11]]
+    attr_accessor :opportunities
+
+    # IDs of the playlist clips associated with the conversation.
+    # @return [Array[String]]
+    attr_accessor :playlist_clip_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['topic'] = 'topic'
+      @_hash['start_time'] = 'start_time'
+      @_hash['duration'] = 'duration'
+      @_hash['state'] = 'state'
+      @_hash['host'] = 'host'
+      @_hash['host_id'] = 'host_id'
+      @_hash['is_private'] = 'is_private'
+      @_hash['pushed_to_crm'] = 'pushed_to_crm'
+      @_hash['account_ids'] = 'account_ids'
+      @_hash['label_id_names'] = 'label_id_names'
+      @_hash['is_shared_conversation'] = 'is_shared_conversation'
+      @_hash['opportunity_ids'] = 'opportunity_ids'
+      @_hash['comment_count'] = 'comment_count'
+      @_hash['failure_code'] = 'failure_code'
+      @_hash['bot_call_ended_reason'] = 'bot_call_ended_reason'
+      @_hash['conversation_type'] = 'conversation_type'
+      @_hash['is_clip'] = 'is_clip'
+      @_hash['video_recording'] = 'video_recording'
+      @_hash['audio_recording'] = 'audio_recording'
+      @_hash['transcript'] = 'transcript'
+      @_hash['participants'] = 'participants'
+      @_hash['opportunities'] = 'opportunities'
+      @_hash['playlist_clip_ids'] = 'playlist_clip_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        topic
+        start_time
+        duration
+        state
+        host
+        host_id
+        is_private
+        pushed_to_crm
+        account_ids
+        label_id_names
+        is_shared_conversation
+        opportunity_ids
+        comment_count
+        failure_code
+        bot_call_ended_reason
+        conversation_type
+        is_clip
+        video_recording
+        audio_recording
+        transcript
+        participants
+        opportunities
+        playlist_clip_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        failure_code
+        bot_call_ended_reason
+        playlist_clip_ids
+      ]
+    end
+
+    def initialize(id: SKIP, topic: SKIP, start_time: SKIP, duration: SKIP,
+                   state: SKIP, host: SKIP, host_id: SKIP, is_private: SKIP,
+                   pushed_to_crm: SKIP, account_ids: SKIP, label_id_names: SKIP,
+                   is_shared_conversation: SKIP, opportunity_ids: SKIP,
+                   comment_count: SKIP, failure_code: SKIP,
+                   bot_call_ended_reason: SKIP, conversation_type: SKIP,
+                   is_clip: SKIP, video_recording: SKIP, audio_recording: SKIP,
+                   transcript: SKIP, participants: SKIP, opportunities: SKIP,
+                   playlist_clip_ids: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @topic = topic unless topic == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @duration = duration unless duration == SKIP
+      @state = state unless state == SKIP
+      @host = host unless host == SKIP
+      @host_id = host_id unless host_id == SKIP
+      @is_private = is_private unless is_private == SKIP
+      @pushed_to_crm = pushed_to_crm unless pushed_to_crm == SKIP
+      @account_ids = account_ids unless account_ids == SKIP
+      @label_id_names = label_id_names unless label_id_names == SKIP
+      @is_shared_conversation = is_shared_conversation unless is_shared_conversation == SKIP
+      @opportunity_ids = opportunity_ids unless opportunity_ids == SKIP
+      @comment_count = comment_count unless comment_count == SKIP
+      @failure_code = failure_code unless failure_code == SKIP
+      @bot_call_ended_reason = bot_call_ended_reason unless bot_call_ended_reason == SKIP
+      @conversation_type = conversation_type unless conversation_type == SKIP
+      @is_clip = is_clip unless is_clip == SKIP
+      @video_recording = video_recording unless video_recording == SKIP
+      @audio_recording = audio_recording unless audio_recording == SKIP
+      @transcript = transcript unless transcript == SKIP
+      @participants = participants unless participants == SKIP
+      @opportunities = opportunities unless opportunities == SKIP
+      @playlist_clip_ids = playlist_clip_ids unless playlist_clip_ids == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      topic = hash.key?('topic') ? hash['topic'] : SKIP
+      start_time = hash.key?('start_time') ? hash['start_time'] : SKIP
+      duration = hash.key?('duration') ? hash['duration'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      host = hash.key?('host') ? hash['host'] : SKIP
+      host_id = hash.key?('host_id') ? hash['host_id'] : SKIP
+      is_private = hash.key?('is_private') ? hash['is_private'] : SKIP
+      pushed_to_crm = hash.key?('pushed_to_crm') ? hash['pushed_to_crm'] : SKIP
+      account_ids = hash.key?('account_ids') ? hash['account_ids'] : SKIP
+      label_id_names =
+        hash.key?('label_id_names') ? hash['label_id_names'] : SKIP
+      is_shared_conversation =
+        hash.key?('is_shared_conversation') ? hash['is_shared_conversation'] : SKIP
+      opportunity_ids =
+        hash.key?('opportunity_ids') ? hash['opportunity_ids'] : SKIP
+      comment_count = hash.key?('comment_count') ? hash['comment_count'] : SKIP
+      failure_code = hash.key?('failure_code') ? hash['failure_code'] : SKIP
+      bot_call_ended_reason =
+        hash.key?('bot_call_ended_reason') ? hash['bot_call_ended_reason'] : SKIP
+      conversation_type =
+        hash.key?('conversation_type') ? hash['conversation_type'] : SKIP
+      is_clip = hash.key?('is_clip') ? hash['is_clip'] : SKIP
+      video_recording = VideoRecording.from_hash(hash['video_recording']) if
+        hash['video_recording']
+      audio_recording = AudioRecording.from_hash(hash['audio_recording']) if
+        hash['audio_recording']
+      transcript = hash.key?('transcript') ? hash['transcript'] : SKIP
+      participants = Participants.from_hash(hash['participants']) if hash['participants']
+      # Parameter is an array, so we need to iterate through it
+      opportunities = nil
+      unless hash['opportunities'].nil?
+        opportunities = []
+        hash['opportunities'].each do |structure|
+          opportunities << (Opportunity11.from_hash(structure) if structure)
+        end
+      end
+
+      opportunities = SKIP unless hash.key?('opportunities')
+      playlist_clip_ids =
+        hash.key?('playlist_clip_ids') ? hash['playlist_clip_ids'] : 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.
+      ConversationsResponse.new(id: id,
+                                topic: topic,
+                                start_time: start_time,
+                                duration: duration,
+                                state: state,
+                                host: host,
+                                host_id: host_id,
+                                is_private: is_private,
+                                pushed_to_crm: pushed_to_crm,
+                                account_ids: account_ids,
+                                label_id_names: label_id_names,
+                                is_shared_conversation: is_shared_conversation,
+                                opportunity_ids: opportunity_ids,
+                                comment_count: comment_count,
+                                failure_code: failure_code,
+                                bot_call_ended_reason: bot_call_ended_reason,
+                                conversation_type: conversation_type,
+                                is_clip: is_clip,
+                                video_recording: video_recording,
+                                audio_recording: audio_recording,
+                                transcript: transcript,
+                                participants: participants,
+                                opportunities: opportunities,
+                                playlist_clip_ids: playlist_clip_ids,
+                                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} id: #{@id}, topic: #{@topic}, start_time: #{@start_time}, duration:"\
+      " #{@duration}, state: #{@state}, host: #{@host}, host_id: #{@host_id}, is_private:"\
+      " #{@is_private}, pushed_to_crm: #{@pushed_to_crm}, account_ids: #{@account_ids},"\
+      " label_id_names: #{@label_id_names}, is_shared_conversation: #{@is_shared_conversation},"\
+      " opportunity_ids: #{@opportunity_ids}, comment_count: #{@comment_count}, failure_code:"\
+      " #{@failure_code}, bot_call_ended_reason: #{@bot_call_ended_reason}, conversation_type:"\
+      " #{@conversation_type}, is_clip: #{@is_clip}, video_recording: #{@video_recording},"\
+      " audio_recording: #{@audio_recording}, transcript: #{@transcript}, participants:"\
+      " #{@participants}, opportunities: #{@opportunities}, playlist_clip_ids:"\
+      " #{@playlist_clip_ids}, 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} id: #{@id.inspect}, topic: #{@topic.inspect}, start_time:"\
+      " #{@start_time.inspect}, duration: #{@duration.inspect}, state: #{@state.inspect}, host:"\
+      " #{@host.inspect}, host_id: #{@host_id.inspect}, is_private: #{@is_private.inspect},"\
+      " pushed_to_crm: #{@pushed_to_crm.inspect}, account_ids: #{@account_ids.inspect},"\
+      " label_id_names: #{@label_id_names.inspect}, is_shared_conversation:"\
+      " #{@is_shared_conversation.inspect}, opportunity_ids: #{@opportunity_ids.inspect},"\
+      " comment_count: #{@comment_count.inspect}, failure_code: #{@failure_code.inspect},"\
+      " bot_call_ended_reason: #{@bot_call_ended_reason.inspect}, conversation_type:"\
+      " #{@conversation_type.inspect}, is_clip: #{@is_clip.inspect}, video_recording:"\
+      " #{@video_recording.inspect}, audio_recording: #{@audio_recording.inspect}, transcript:"\
+      " #{@transcript.inspect}, participants: #{@participants.inspect}, opportunities:"\
+      " #{@opportunities.inspect}, playlist_clip_ids: #{@playlist_clip_ids.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/conversations_search_request.rb

@@ -0,0 +1,207 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ConversationsSearchRequest Model.
+  class ConversationsSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Page number for pagination.
+    # @return [Integer]
+    attr_accessor :page
+
+    # Maximum number of results to return.
+    # @return [Integer]
+    attr_accessor :num_fetch_result
+
+    # Filter by dialer calls, or video conference calls.
+    # @return [ConversationType]
+    attr_accessor :conversation_type
+
+    # Filter by account ID.
+    # @return [String]
+    attr_accessor :account_id
+
+    # Filter by one or more contact IDs.
+    # @return [Array[String]]
+    attr_accessor :contact_ids
+
+    # Filter by label or tag IDs.
+    # @return [Array[String]]
+    attr_accessor :tag_ids
+
+    # Filter by tracker IDs.
+    # @return [Array[String]]
+    attr_accessor :tracker_ids
+
+    # Filter by organization IDs.
+    # @return [Array[String]]
+    attr_accessor :organization_ids
+
+    # Filter by date range.
+    # @return [DateRange1]
+    attr_accessor :date_range
+
+    # Filter by scorecard template ID.
+    # @return [String]
+    attr_accessor :scorecard_template_id
+
+    # Maximum scorecard rating to include in the results.
+    # @return [Float]
+    attr_accessor :scorecard_max_rating
+
+    # Field to sort results by.
+    # @return [String]
+    attr_accessor :sort_by_field
+
+    # When <code>true</code>, restricts results to conversations visible to the
+    # specified contacts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enforce_contact_boundary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['num_fetch_result'] = 'num_fetch_result'
+      @_hash['conversation_type'] = 'conversation_type'
+      @_hash['account_id'] = 'account_id'
+      @_hash['contact_ids'] = 'contact_ids'
+      @_hash['tag_ids'] = 'tag_ids'
+      @_hash['tracker_ids'] = 'tracker_ids'
+      @_hash['organization_ids'] = 'organization_ids'
+      @_hash['date_range'] = 'date_range'
+      @_hash['scorecard_template_id'] = 'scorecard_template_id'
+      @_hash['scorecard_max_rating'] = 'scorecard_max_rating'
+      @_hash['sort_by_field'] = 'sort_by_field'
+      @_hash['enforce_contact_boundary'] = 'enforce_contact_boundary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        num_fetch_result
+        conversation_type
+        account_id
+        contact_ids
+        tag_ids
+        tracker_ids
+        organization_ids
+        date_range
+        scorecard_template_id
+        scorecard_max_rating
+        sort_by_field
+        enforce_contact_boundary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, num_fetch_result: SKIP, conversation_type: SKIP,
+                   account_id: SKIP, contact_ids: SKIP, tag_ids: SKIP,
+                   tracker_ids: SKIP, organization_ids: SKIP, date_range: SKIP,
+                   scorecard_template_id: SKIP, scorecard_max_rating: SKIP,
+                   sort_by_field: SKIP, enforce_contact_boundary: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @num_fetch_result = num_fetch_result unless num_fetch_result == SKIP
+      @conversation_type = conversation_type unless conversation_type == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @contact_ids = contact_ids unless contact_ids == SKIP
+      @tag_ids = tag_ids unless tag_ids == SKIP
+      @tracker_ids = tracker_ids unless tracker_ids == SKIP
+      @organization_ids = organization_ids unless organization_ids == SKIP
+      @date_range = date_range unless date_range == SKIP
+      @scorecard_template_id = scorecard_template_id unless scorecard_template_id == SKIP
+      @scorecard_max_rating = scorecard_max_rating unless scorecard_max_rating == SKIP
+      @sort_by_field = sort_by_field unless sort_by_field == SKIP
+      @enforce_contact_boundary = enforce_contact_boundary unless enforce_contact_boundary == 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.
+      page = hash.key?('page') ? hash['page'] : SKIP
+      num_fetch_result =
+        hash.key?('num_fetch_result') ? hash['num_fetch_result'] : SKIP
+      conversation_type =
+        hash.key?('conversation_type') ? hash['conversation_type'] : SKIP
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      contact_ids = hash.key?('contact_ids') ? hash['contact_ids'] : SKIP
+      tag_ids = hash.key?('tag_ids') ? hash['tag_ids'] : SKIP
+      tracker_ids = hash.key?('tracker_ids') ? hash['tracker_ids'] : SKIP
+      organization_ids =
+        hash.key?('organization_ids') ? hash['organization_ids'] : SKIP
+      date_range = DateRange1.from_hash(hash['date_range']) if hash['date_range']
+      scorecard_template_id =
+        hash.key?('scorecard_template_id') ? hash['scorecard_template_id'] : SKIP
+      scorecard_max_rating =
+        hash.key?('scorecard_max_rating') ? hash['scorecard_max_rating'] : SKIP
+      sort_by_field = hash.key?('sort_by_field') ? hash['sort_by_field'] : SKIP
+      enforce_contact_boundary =
+        hash.key?('enforce_contact_boundary') ? hash['enforce_contact_boundary'] : 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.
+      ConversationsSearchRequest.new(page: page,
+                                     num_fetch_result: num_fetch_result,
+                                     conversation_type: conversation_type,
+                                     account_id: account_id,
+                                     contact_ids: contact_ids,
+                                     tag_ids: tag_ids,
+                                     tracker_ids: tracker_ids,
+                                     organization_ids: organization_ids,
+                                     date_range: date_range,
+                                     scorecard_template_id: scorecard_template_id,
+                                     scorecard_max_rating: scorecard_max_rating,
+                                     sort_by_field: sort_by_field,
+                                     enforce_contact_boundary: enforce_contact_boundary,
+                                     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} page: #{@page}, num_fetch_result: #{@num_fetch_result}, conversation_type:"\
+      " #{@conversation_type}, account_id: #{@account_id}, contact_ids: #{@contact_ids}, tag_ids:"\
+      " #{@tag_ids}, tracker_ids: #{@tracker_ids}, organization_ids: #{@organization_ids},"\
+      " date_range: #{@date_range}, scorecard_template_id: #{@scorecard_template_id},"\
+      " scorecard_max_rating: #{@scorecard_max_rating}, sort_by_field: #{@sort_by_field},"\
+      " enforce_contact_boundary: #{@enforce_contact_boundary}, 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} page: #{@page.inspect}, num_fetch_result: #{@num_fetch_result.inspect},"\
+      " conversation_type: #{@conversation_type.inspect}, account_id: #{@account_id.inspect},"\
+      " contact_ids: #{@contact_ids.inspect}, tag_ids: #{@tag_ids.inspect}, tracker_ids:"\
+      " #{@tracker_ids.inspect}, organization_ids: #{@organization_ids.inspect}, date_range:"\
+      " #{@date_range.inspect}, scorecard_template_id: #{@scorecard_template_id.inspect},"\
+      " scorecard_max_rating: #{@scorecard_max_rating.inspect}, sort_by_field:"\
+      " #{@sort_by_field.inspect}, enforce_contact_boundary: #{@enforce_contact_boundary.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/conversations_search_response.rb

@@ -0,0 +1,130 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ConversationsSearchResponse Model.
+  class ConversationsSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Pagination metadata for the result set.
+    # @return [Object]
+    attr_accessor :pagination
+
+    # Breadcrumbs data associated with the results.
+    # @return [Object]
+    attr_accessor :breadcrumbs
+
+    # Number of results returned.
+    # @return [Integer]
+    attr_accessor :num_fetch_result
+
+    # IDs of playlist clips associated with the results.
+    # @return [Array[String]]
+    attr_accessor :playlist_clip_ids
+
+    # List of conversation summaries matching the search criteria.
+    # @return [Array[Conversation]]
+    attr_accessor :conversations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination'] = 'pagination'
+      @_hash['breadcrumbs'] = 'breadcrumbs'
+      @_hash['num_fetch_result'] = 'num_fetch_result'
+      @_hash['playlist_clip_ids'] = 'playlist_clip_ids'
+      @_hash['conversations'] = 'conversations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination
+        breadcrumbs
+        num_fetch_result
+        playlist_clip_ids
+        conversations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        playlist_clip_ids
+      ]
+    end
+
+    def initialize(pagination: SKIP, breadcrumbs: SKIP, num_fetch_result: SKIP,
+                   playlist_clip_ids: SKIP, conversations: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pagination = pagination unless pagination == SKIP
+      @breadcrumbs = breadcrumbs unless breadcrumbs == SKIP
+      @num_fetch_result = num_fetch_result unless num_fetch_result == SKIP
+      @playlist_clip_ids = playlist_clip_ids unless playlist_clip_ids == SKIP
+      @conversations = conversations unless conversations == 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.
+      pagination = hash.key?('pagination') ? hash['pagination'] : SKIP
+      breadcrumbs = hash.key?('breadcrumbs') ? hash['breadcrumbs'] : SKIP
+      num_fetch_result =
+        hash.key?('num_fetch_result') ? hash['num_fetch_result'] : SKIP
+      playlist_clip_ids =
+        hash.key?('playlist_clip_ids') ? hash['playlist_clip_ids'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      conversations = nil
+      unless hash['conversations'].nil?
+        conversations = []
+        hash['conversations'].each do |structure|
+          conversations << (Conversation.from_hash(structure) if structure)
+        end
+      end
+
+      conversations = SKIP unless hash.key?('conversations')
+
+      # 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.
+      ConversationsSearchResponse.new(pagination: pagination,
+                                      breadcrumbs: breadcrumbs,
+                                      num_fetch_result: num_fetch_result,
+                                      playlist_clip_ids: playlist_clip_ids,
+                                      conversations: conversations,
+                                      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} pagination: #{@pagination}, breadcrumbs: #{@breadcrumbs}, num_fetch_result:"\
+      " #{@num_fetch_result}, playlist_clip_ids: #{@playlist_clip_ids}, conversations:"\
+      " #{@conversations}, 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} pagination: #{@pagination.inspect}, breadcrumbs: #{@breadcrumbs.inspect},"\
+      " num_fetch_result: #{@num_fetch_result.inspect}, playlist_clip_ids:"\
+      " #{@playlist_clip_ids.inspect}, conversations: #{@conversations.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end