apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/conversation.rb

@@ -0,0 +1,284 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Conversation Model.
+  class Conversation < 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
+
+    # Filter by dialer calls, or video conference calls.
+    # @return [ConversationType]
+    attr_accessor :conversation_type
+
+    # Whether the authenticated user can access this conversation.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_access_conversation
+
+    # Label names associated with the conversation.
+    # @return [Object]
+    attr_accessor :label_id_names
+
+    # Names of the conversation participants.
+    # @return [Array[String]]
+    attr_accessor :participant_names
+
+    # Number of comments on the conversation.
+    # @return [Integer]
+    attr_accessor :comment_count
+
+    # Names of associated accounts.
+    # @return [Array[String]]
+    attr_accessor :account_names
+
+    # IDs of associated accounts.
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # Organization associated with the result.
+    # @return [Organization7]
+    attr_accessor :organization
+
+    # Detailed information about conversation participants.
+    # @return [Array[Object]]
+    attr_accessor :participants_info
+
+    # URL of the conversation thumbnail image.
+    # @return [String]
+    attr_accessor :thumbnail_url
+
+    # Whether the conversation is internal.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_internal
+
+    # Deals associated with the conversation.
+    # @return [Array[Deal]]
+    attr_accessor :deals
+
+    # 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['conversation_type'] = 'conversation_type'
+      @_hash['can_access_conversation'] = 'can_access_conversation'
+      @_hash['label_id_names'] = 'label_id_names'
+      @_hash['participant_names'] = 'participant_names'
+      @_hash['comment_count'] = 'comment_count'
+      @_hash['account_names'] = 'account_names'
+      @_hash['account_ids'] = 'account_ids'
+      @_hash['organization'] = 'organization'
+      @_hash['participants_info'] = 'participants_info'
+      @_hash['thumbnail_url'] = 'thumbnail_url'
+      @_hash['is_internal'] = 'is_internal'
+      @_hash['deals'] = 'deals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        topic
+        start_time
+        duration
+        state
+        host
+        host_id
+        is_private
+        conversation_type
+        can_access_conversation
+        label_id_names
+        participant_names
+        comment_count
+        account_names
+        account_ids
+        organization
+        participants_info
+        thumbnail_url
+        is_internal
+        deals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, topic: SKIP, start_time: SKIP, duration: SKIP,
+                   state: SKIP, host: SKIP, host_id: SKIP, is_private: SKIP,
+                   conversation_type: SKIP, can_access_conversation: SKIP,
+                   label_id_names: SKIP, participant_names: SKIP,
+                   comment_count: SKIP, account_names: SKIP, account_ids: SKIP,
+                   organization: SKIP, participants_info: SKIP,
+                   thumbnail_url: SKIP, is_internal: SKIP, deals: 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
+      @conversation_type = conversation_type unless conversation_type == SKIP
+      @can_access_conversation = can_access_conversation unless can_access_conversation == SKIP
+      @label_id_names = label_id_names unless label_id_names == SKIP
+      @participant_names = participant_names unless participant_names == SKIP
+      @comment_count = comment_count unless comment_count == SKIP
+      @account_names = account_names unless account_names == SKIP
+      @account_ids = account_ids unless account_ids == SKIP
+      @organization = organization unless organization == SKIP
+      @participants_info = participants_info unless participants_info == SKIP
+      @thumbnail_url = thumbnail_url unless thumbnail_url == SKIP
+      @is_internal = is_internal unless is_internal == SKIP
+      @deals = deals unless deals == 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
+      conversation_type =
+        hash.key?('conversation_type') ? hash['conversation_type'] : SKIP
+      can_access_conversation =
+        hash.key?('can_access_conversation') ? hash['can_access_conversation'] : SKIP
+      label_id_names =
+        hash.key?('label_id_names') ? hash['label_id_names'] : SKIP
+      participant_names =
+        hash.key?('participant_names') ? hash['participant_names'] : SKIP
+      comment_count = hash.key?('comment_count') ? hash['comment_count'] : SKIP
+      account_names = hash.key?('account_names') ? hash['account_names'] : SKIP
+      account_ids = hash.key?('account_ids') ? hash['account_ids'] : SKIP
+      organization = Organization7.from_hash(hash['organization']) if hash['organization']
+      participants_info =
+        hash.key?('participants_info') ? hash['participants_info'] : SKIP
+      thumbnail_url = hash.key?('thumbnail_url') ? hash['thumbnail_url'] : SKIP
+      is_internal = hash.key?('is_internal') ? hash['is_internal'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      deals = nil
+      unless hash['deals'].nil?
+        deals = []
+        hash['deals'].each do |structure|
+          deals << (Deal.from_hash(structure) if structure)
+        end
+      end
+
+      deals = SKIP unless hash.key?('deals')
+
+      # 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.
+      Conversation.new(id: id,
+                       topic: topic,
+                       start_time: start_time,
+                       duration: duration,
+                       state: state,
+                       host: host,
+                       host_id: host_id,
+                       is_private: is_private,
+                       conversation_type: conversation_type,
+                       can_access_conversation: can_access_conversation,
+                       label_id_names: label_id_names,
+                       participant_names: participant_names,
+                       comment_count: comment_count,
+                       account_names: account_names,
+                       account_ids: account_ids,
+                       organization: organization,
+                       participants_info: participants_info,
+                       thumbnail_url: thumbnail_url,
+                       is_internal: is_internal,
+                       deals: deals,
+                       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}, conversation_type: #{@conversation_type}, can_access_conversation:"\
+      " #{@can_access_conversation}, label_id_names: #{@label_id_names}, participant_names:"\
+      " #{@participant_names}, comment_count: #{@comment_count}, account_names: #{@account_names},"\
+      " account_ids: #{@account_ids}, organization: #{@organization}, participants_info:"\
+      " #{@participants_info}, thumbnail_url: #{@thumbnail_url}, is_internal: #{@is_internal},"\
+      " deals: #{@deals}, 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},"\
+      " conversation_type: #{@conversation_type.inspect}, can_access_conversation:"\
+      " #{@can_access_conversation.inspect}, label_id_names: #{@label_id_names.inspect},"\
+      " participant_names: #{@participant_names.inspect}, comment_count:"\
+      " #{@comment_count.inspect}, account_names: #{@account_names.inspect}, account_ids:"\
+      " #{@account_ids.inspect}, organization: #{@organization.inspect}, participants_info:"\
+      " #{@participants_info.inspect}, thumbnail_url: #{@thumbnail_url.inspect}, is_internal:"\
+      " #{@is_internal.inspect}, deals: #{@deals.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/conversation_type.rb

@@ -0,0 +1,36 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Filter by dialer calls, or video conference calls.
+  class ConversationType
+    CONVERSATION_TYPE = [
+      # TODO: Write general description for VIDEO_CONFERENCE
+      VIDEO_CONFERENCE = 'video_conference'.freeze,
+
+      # TODO: Write general description for PHONE_CALL
+      PHONE_CALL = 'phone_call'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONVERSATION_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = VIDEO_CONFERENCE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'video_conference' then VIDEO_CONFERENCE
+      when 'phone_call' then PHONE_CALL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/conversation_type2.rb

@@ -0,0 +1,36 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Type of conversation.
+  class ConversationType2
+    CONVERSATION_TYPE2 = [
+      # TODO: Write general description for VIDEO_CONFERENCE
+      VIDEO_CONFERENCE = 'video_conference'.freeze,
+
+      # TODO: Write general description for PHONE_CALL
+      PHONE_CALL = 'phone_call'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONVERSATION_TYPE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = VIDEO_CONFERENCE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'video_conference' then VIDEO_CONFERENCE
+      when 'phone_call' then PHONE_CALL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/conversations_export_request.rb

@@ -0,0 +1,94 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ConversationsExportRequest Model.
+  class ConversationsExportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start of the export time range (ISO 8601). Apollo uses Greenwich Mean Time
+    # (GMT) for all date and time values. Must be earlier than
+    # <code>end_time</code>.<br><br>Example: <code>2024-01-01T00:00:00Z</code>
+    # @return [String]
+    attr_accessor :start_time
+
+    # End of the export time range (ISO 8601). Apollo uses Greenwich Mean Time
+    # (GMT) for all date and time values. Must be later than
+    # <code>start_time</code>.<br><br>Example: <code>2024-03-31T23:59:59Z</code>
+    # @return [String]
+    attr_accessor :end_time
+
+    # Email address of a valid team member to notify when the export is ready.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_time'] = 'start_time'
+      @_hash['end_time'] = 'end_time'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_time:, end_time:, email:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_time = start_time
+      @end_time = end_time
+      @email = email
+      @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.
+      start_time = hash.key?('start_time') ? hash['start_time'] : nil
+      end_time = hash.key?('end_time') ? hash['end_time'] : nil
+      email = hash.key?('email') ? hash['email'] : 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.
+      ConversationsExportRequest.new(start_time: start_time,
+                                     end_time: end_time,
+                                     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} start_time: #{@start_time}, end_time: #{@end_time}, 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} start_time: #{@start_time.inspect}, end_time: #{@end_time.inspect}, email:"\
+      " #{@email.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/conversations_export_response.rb

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

data/lib/apollo_rest_api/models/conversations_export_response1.rb

@@ -0,0 +1,76 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ConversationsExportResponse1 Model.
+  class ConversationsExportResponse1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A signed URL to download the exported conversations file.
+    # @return [String]
+    attr_accessor :redirect_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['redirect_url'] = 'redirect_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        redirect_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(redirect_url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @redirect_url = redirect_url unless redirect_url == 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.
+      redirect_url = hash.key?('redirect_url') ? hash['redirect_url'] : 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.
+      ConversationsExportResponse1.new(redirect_url: redirect_url,
+                                       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} redirect_url: #{@redirect_url}, 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} redirect_url: #{@redirect_url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end