purecloudplatformclientv2 95.0.0 → 96.0.0

data/lib/purecloudplatformclientv2/models/query_response_stats.rb

@@ -0,0 +1,202 @@
+=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 QueryResponseStats
+    # The count for this metric
+    attr_accessor :count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'count' => :'count'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'count' => :'Integer'
+        
+      }
+    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?(:'count')
+        
+        
+        self.count = attributes[:'count']
+        
+      
+      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 &&
+          count == o.count
+    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
+      [count].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/queue_conversation_event_topic_message.rb

@@ -445,7 +445,7 @@ module PureCloud
       
       
       
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if @type && !allowed_values.include?(@type)
         return false
       end
@@ -572,7 +572,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if type && !allowed_values.include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb

@@ -792,7 +792,7 @@ module PureCloud
       
       
       
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if @type && !allowed_values.include?(@type)
         return false
       end
@@ -1025,7 +1025,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if type && !allowed_values.include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb

@@ -445,7 +445,7 @@ module PureCloud
       
       
       
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if @type && !allowed_values.include?(@type)
         return false
       end
@@ -572,7 +572,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if type && !allowed_values.include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb

@@ -445,7 +445,7 @@ module PureCloud
       
       
       
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if @type && !allowed_values.include?(@type)
         return false
       end
@@ -572,7 +572,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO"]
+      allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "VIBER", "WECHAT", "WHATSAPP", "TELEGRAM", "KAKAO", "WEBMESSAGING"]
       if type && !allowed_values.include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/recipient.rb

@@ -229,7 +229,7 @@ module PureCloud
       
       
       
-      allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp"]
+      allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp", "webmessaging"]
       if @messenger_type && !allowed_values.include?(@messenger_type)
         return false
       end
@@ -282,7 +282,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] messenger_type Object to be assigned
     def messenger_type=(messenger_type)
-      allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp"]
+      allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp", "webmessaging"]
       if messenger_type && !allowed_values.include?(messenger_type)
         fail ArgumentError, "invalid value for 'messenger_type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb

@@ -20,6 +20,8 @@ module PureCloud
   class ReportingDataExportTopicDataExportNotification
     attr_accessor :id
 
+    attr_accessor :run_id
+
     attr_accessor :name
 
     attr_accessor :status
@@ -48,6 +50,8 @@ module PureCloud
         
         :'id' => :'id',
         
+        :'run_id' => :'runId',
+        
         :'name' => :'name',
         
         :'status' => :'status',
@@ -79,6 +83,8 @@ module PureCloud
         
         :'id' => :'String',
         
+        :'run_id' => :'String',
+        
         :'name' => :'String',
         
         :'status' => :'String',
@@ -122,6 +128,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'runId')
+        
+        
+        self.run_id = attributes[:'runId']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'name')
         
         
@@ -248,6 +263,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       allowed_values = ["SUBMITTED", "RUNNING", "CANCELLING", "CANCELLED", "COMPLETED", "COMPLETED_WITH_PARTIAL_RESULTS", "FAILED"]
       if @status && !allowed_values.include?(@status)
         return false
@@ -320,6 +339,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -411,6 +435,7 @@ module PureCloud
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          run_id == o.run_id &&
           name == o.name &&
           status == o.status &&
           export_format == o.export_format &&
@@ -433,7 +458,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, status, export_format, download_url, view_type, export_error_messages_type, read, created_date_time, modified_date_time, percentage_complete, email_statuses].hash
+      [id, run_id, name, status, export_format, download_url, view_type, export_error_messages_type, read, created_date_time, modified_date_time, percentage_complete, email_statuses].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb

@@ -23,6 +23,9 @@ module PureCloud
 
     attr_accessor :name
 
+    # The unique run id of the export schedule execute
+    attr_accessor :run_id
+
     # The current status of the export request
     attr_accessor :status
 
@@ -102,6 +105,8 @@ module PureCloud
         
         :'name' => :'name',
         
+        :'run_id' => :'runId',
+        
         :'status' => :'status',
         
         :'time_zone' => :'timeZone',
@@ -161,6 +166,8 @@ module PureCloud
         
         :'name' => :'String',
         
+        :'run_id' => :'String',
+        
         :'status' => :'String',
         
         :'time_zone' => :'String',
@@ -239,6 +246,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'runId')
+        
+        
+        self.run_id = attributes[:'runId']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'status')
         
         
@@ -485,6 +501,15 @@ module PureCloud
       
       
       
+      if @run_id.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
       if @status.nil?
         return false
       end
@@ -674,6 +699,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -836,6 +866,7 @@ module PureCloud
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
+          run_id == o.run_id &&
           status == o.status &&
           time_zone == o.time_zone &&
           export_format == o.export_format &&
@@ -871,7 +902,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, status, time_zone, export_format, interval, download_url, view_type, export_error_messages_type, period, filter, read, created_date_time, modified_date_time, locale, percentage_complete, has_format_durations, has_split_filters, exclude_empty_rows, has_split_by_media, selected_columns, has_custom_participant_attributes, recipient_emails, email_statuses, enabled, self_uri].hash
+      [id, name, run_id, status, time_zone, export_format, interval, download_url, view_type, export_error_messages_type, period, filter, read, created_date_time, modified_date_time, locale, percentage_complete, has_format_durations, has_split_filters, exclude_empty_rows, has_split_by_media, selected_columns, has_custom_participant_attributes, recipient_emails, email_statuses, enabled, self_uri].hash
     end
 
     # build the object from hash