purecloudplatformclientv2 64.0.0 → 68.0.0

data/lib/purecloudplatformclientv2/models/sip_download_response.rb

@@ -0,0 +1,228 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require 'date'
+
+module PureCloud
+  class SipDownloadResponse
+    # unique id of the downloaded file
+    attr_accessor :download_id
+
+    # Document id of pcap file
+    attr_accessor :document_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'download_id' => :'downloadId',
+        
+        :'document_id' => :'documentId'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'download_id' => :'String',
+        
+        :'document_id' => :'String'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'downloadId')
+        
+        
+        self.download_id = attributes[:'downloadId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'documentId')
+        
+        
+        self.document_id = attributes[:'documentId']
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          download_id == o.download_id &&
+          document_id == o.document_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [download_id, document_id].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/purecloudplatformclientv2/models/{data_table_import_job.rb → sip_search_public_request.rb}

@@ -17,39 +17,32 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  # State information for an import job of rows to a datatable
-  class DataTableImportJob
+  class SIPSearchPublicRequest
     # The globally unique identifier for the object.
     attr_accessor :id
 
     attr_accessor :name
 
-    # The PureCloud user who started the import job
-    attr_accessor :owner
+    # unique identification of the placed call
+    attr_accessor :call_id
 
-    # The status of the import job
-    attr_accessor :status
+    # SIP user to who the call was placed
+    attr_accessor :to_user
 
-    # The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :date_created
+    # SIP user who placed the call
+    attr_accessor :from_user
 
-    # The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :date_completed
+    # Unique identification of the conversation
+    attr_accessor :conversation_id
 
-    # The URL of the location at which the caller can upload the file to be imported
-    attr_accessor :upload_uri
+    # Unique identification of the participant
+    attr_accessor :participant_id
 
-    # The indication of whether the processing should remove rows that don't appear in the import file
-    attr_accessor :import_mode
+    # Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_start
 
-    # Any error information, or null of the processing is not in an error state
-    attr_accessor :error_information
-
-    # The current count of the number of records processed
-    attr_accessor :count_records_processed
-
-    # The current count of the number of records that failed to import
-    attr_accessor :count_records_failed
+    # End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_end
 
     # The URI for this object
     attr_accessor :self_uri
@@ -62,23 +55,19 @@ module PureCloud
         
         :'name' => :'name',
         
-        :'owner' => :'owner',
-        
-        :'status' => :'status',
-        
-        :'date_created' => :'dateCreated',
+        :'call_id' => :'callId',
         
-        :'date_completed' => :'dateCompleted',
+        :'to_user' => :'toUser',
         
-        :'upload_uri' => :'uploadURI',
+        :'from_user' => :'fromUser',
         
-        :'import_mode' => :'importMode',
+        :'conversation_id' => :'conversationId',
         
-        :'error_information' => :'errorInformation',
+        :'participant_id' => :'participantId',
         
-        :'count_records_processed' => :'countRecordsProcessed',
+        :'date_start' => :'dateStart',
         
-        :'count_records_failed' => :'countRecordsFailed',
+        :'date_end' => :'dateEnd',
         
         :'self_uri' => :'selfUri'
         
@@ -93,23 +82,19 @@ module PureCloud
         
         :'name' => :'String',
         
-        :'owner' => :'AddressableEntityRef',
+        :'call_id' => :'String',
         
-        :'status' => :'String',
+        :'to_user' => :'String',
         
-        :'date_created' => :'DateTime',
+        :'from_user' => :'String',
         
-        :'date_completed' => :'DateTime',
+        :'conversation_id' => :'String',
         
-        :'upload_uri' => :'String',
+        :'participant_id' => :'String',
         
-        :'import_mode' => :'String',
+        :'date_start' => :'DateTime',
         
-        :'error_information' => :'ErrorBody',
-        
-        :'count_records_processed' => :'Integer',
-        
-        :'count_records_failed' => :'Integer',
+        :'date_end' => :'DateTime',
         
         :'self_uri' => :'String'
         
@@ -143,82 +128,64 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'owner')
-        
-        
-        self.owner = attributes[:'owner']
-        
-      
-      end
-
-      
-      if attributes.has_key?(:'status')
+      if attributes.has_key?(:'callId')
         
         
-        self.status = attributes[:'status']
+        self.call_id = attributes[:'callId']
         
       
       end
 
       
-      if attributes.has_key?(:'dateCreated')
+      if attributes.has_key?(:'toUser')
         
         
-        self.date_created = attributes[:'dateCreated']
+        self.to_user = attributes[:'toUser']
         
       
       end
 
       
-      if attributes.has_key?(:'dateCompleted')
+      if attributes.has_key?(:'fromUser')
         
         
-        self.date_completed = attributes[:'dateCompleted']
+        self.from_user = attributes[:'fromUser']
         
       
       end
 
       
-      if attributes.has_key?(:'uploadURI')
+      if attributes.has_key?(:'conversationId')
         
         
-        self.upload_uri = attributes[:'uploadURI']
+        self.conversation_id = attributes[:'conversationId']
         
       
       end
 
       
-      if attributes.has_key?(:'importMode')
+      if attributes.has_key?(:'participantId')
         
         
-        self.import_mode = attributes[:'importMode']
+        self.participant_id = attributes[:'participantId']
         
       
       end
 
       
-      if attributes.has_key?(:'errorInformation')
+      if attributes.has_key?(:'dateStart')
         
         
-        self.error_information = attributes[:'errorInformation']
+        self.date_start = attributes[:'dateStart']
         
       
       end
 
       
-      if attributes.has_key?(:'countRecordsProcessed')
+      if attributes.has_key?(:'dateEnd')
         
         
-        self.count_records_processed = attributes[:'countRecordsProcessed']
-        
-      
-      end
-
-      
-      if attributes.has_key?(:'countRecordsFailed')
-        
-        
-        self.count_records_failed = attributes[:'countRecordsFailed']
+        self.date_end = attributes[:'dateEnd']
         
       
       end
@@ -261,17 +228,6 @@ module PureCloud
       
       
       
-      if @status.nil?
-        return false
-      end
-
-      
-      
-      allowed_values = ["WaitingForUpload", "Processing", "Failed", "Succeeded"]
-      if @status && !allowed_values.include?(@status)
-        return false
-      end
-      
       
       
       
@@ -288,21 +244,19 @@ module PureCloud
       
       
       
-      allowed_values = ["ReplaceAll", "Append"]
-      if @import_mode && !allowed_values.include?(@import_mode)
+      if @date_start.nil?
         return false
       end
+
       
       
       
       
       
-      
-      
-      
-      
-      
-      
+      if @date_end.nil?
+        return false
+      end
+
       
       
       
@@ -330,21 +284,6 @@ module PureCloud
     
     
     
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] status Object to be assigned
-    def status=(status)
-      allowed_values = ["WaitingForUpload", "Processing", "Failed", "Succeeded"]
-      if status && !allowed_values.include?(status)
-        fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
-      end
-      @status = status
-    end
-
-    
-    
-    
-    
-    
     
     
     
@@ -358,19 +297,6 @@ module PureCloud
     
     
     
-    
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] import_mode Object to be assigned
-    def import_mode=(import_mode)
-      allowed_values = ["ReplaceAll", "Append"]
-      if import_mode && !allowed_values.include?(import_mode)
-        fail ArgumentError, "invalid value for 'import_mode', must be one of #{allowed_values}."
-      end
-      @import_mode = import_mode
-    end
-
-    
-    
     
     
     
@@ -399,15 +325,13 @@ module PureCloud
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
-          owner == o.owner &&
-          status == o.status &&
-          date_created == o.date_created &&
-          date_completed == o.date_completed &&
-          upload_uri == o.upload_uri &&
-          import_mode == o.import_mode &&
-          error_information == o.error_information &&
-          count_records_processed == o.count_records_processed &&
-          count_records_failed == o.count_records_failed &&
+          call_id == o.call_id &&
+          to_user == o.to_user &&
+          from_user == o.from_user &&
+          conversation_id == o.conversation_id &&
+          participant_id == o.participant_id &&
+          date_start == o.date_start &&
+          date_end == o.date_end &&
           self_uri == o.self_uri
     end
 
@@ -420,7 +344,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, owner, status, date_created, date_completed, upload_uri, import_mode, error_information, count_records_processed, count_records_failed, self_uri].hash
+      [id, name, call_id, to_user, from_user, conversation_id, participant_id, date_start, date_end, self_uri].hash
     end
 
     # build the object from hash