purecloudplatformclientv2 20.0.0 → 21.0.0

data/lib/purecloudplatformclientv2/models/message_details.rb

@@ -24,6 +24,12 @@ module PureCloud
     # A URI for this message entity.
     attr_accessor :message_uri
 
+    # Indicates the delivery status of the message.
+    attr_accessor :message_status
+
+    # The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits.
+    attr_accessor :message_segment_count
+
     # The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :message_time
 
@@ -35,6 +41,10 @@ module PureCloud
         
         :'message_uri' => :'messageURI',
         
+        :'message_status' => :'messageStatus',
+        
+        :'message_segment_count' => :'messageSegmentCount',
+        
         :'message_time' => :'messageTime'
         
       }
@@ -48,6 +58,10 @@ module PureCloud
         
         :'message_uri' => :'String',
         
+        :'message_status' => :'String',
+        
+        :'message_segment_count' => :'Integer',
+        
         :'message_time' => :'DateTime'
         
       }
@@ -80,6 +94,24 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'messageStatus')
+        
+        
+        self.message_status = attributes[:'messageStatus']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'messageSegmentCount')
+        
+        
+        self.message_segment_count = attributes[:'messageSegmentCount']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'messageTime')
         
         
@@ -114,6 +146,19 @@ module PureCloud
       
       
       
+      allowed_values = ["queued", "sent", "failed", "received"]
+      if @message_status && !allowed_values.include?(@message_status)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
       
       
     end
@@ -130,6 +175,25 @@ module PureCloud
     
     
     
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] message_status Object to be assigned
+    def message_status=(message_status)
+      allowed_values = ["queued", "sent", "failed", "received"]
+      if message_status && !allowed_values.include?(message_status)
+        fail ArgumentError, "invalid value for 'message_status', must be one of #{allowed_values}."
+      end
+      @message_status = message_status
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -141,6 +205,8 @@ module PureCloud
       self.class == o.class &&
           message_id == o.message_id &&
           message_uri == o.message_uri &&
+          message_status == o.message_status &&
+          message_segment_count == o.message_segment_count &&
           message_time == o.message_time
     end
 
@@ -153,7 +219,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [message_id, message_uri, message_time].hash
+      [message_id, message_uri, message_status, message_segment_count, message_time].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/participant.rb

@@ -831,7 +831,7 @@ module PureCloud
       
       
       
-      allowed_values = ["requested", "active", "paused", "stopped", "error"]
+      allowed_values = ["requested", "active", "paused", "stopped", "error", "timeout"]
       if @screen_recording_state && !allowed_values.include?(@screen_recording_state)
         return false
       end
@@ -1039,7 +1039,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] screen_recording_state Object to be assigned
     def screen_recording_state=(screen_recording_state)
-      allowed_values = ["requested", "active", "paused", "stopped", "error"]
+      allowed_values = ["requested", "active", "paused", "stopped", "error", "timeout"]
       if screen_recording_state && !allowed_values.include?(screen_recording_state)
         fail ArgumentError, "invalid value for 'screen_recording_state', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/participant_basic.rb

@@ -831,7 +831,7 @@ module PureCloud
       
       
       
-      allowed_values = ["requested", "active", "paused", "stopped", "error"]
+      allowed_values = ["requested", "active", "paused", "stopped", "error", "timeout"]
       if @screen_recording_state && !allowed_values.include?(@screen_recording_state)
         return false
       end
@@ -1039,7 +1039,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] screen_recording_state Object to be assigned
     def screen_recording_state=(screen_recording_state)
-      allowed_values = ["requested", "active", "paused", "stopped", "error"]
+      allowed_values = ["requested", "active", "paused", "stopped", "error", "timeout"]
       if screen_recording_state && !allowed_values.include?(screen_recording_state)
         fail ArgumentError, "invalid value for 'screen_recording_state', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/queue.rb

@@ -65,6 +65,12 @@ module PureCloud
     # The in-queue flow to use for conversations waiting in queue.
     attr_accessor :queue_flow
 
+    # The prompt used for whisper audio on the queue, if configured.
+    attr_accessor :whisper
+
+    # Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered.
+    attr_accessor :auto_answer_only
+
     # The name to use for caller identification for outbound calls from this queue.
     attr_accessor :calling_party_name
 
@@ -117,6 +123,10 @@ module PureCloud
         
         :'queue_flow' => :'queueFlow',
         
+        :'whisper' => :'whisper',
+        
+        :'auto_answer_only' => :'autoAnswerOnly',
+        
         :'calling_party_name' => :'callingPartyName',
         
         :'calling_party_number' => :'callingPartyNumber',
@@ -168,6 +178,10 @@ module PureCloud
         
         :'queue_flow' => :'UriReference',
         
+        :'whisper' => :'UriReference',
+        
+        :'auto_answer_only' => :'BOOLEAN',
+        
         :'calling_party_name' => :'String',
         
         :'calling_party_number' => :'String',
@@ -338,6 +352,24 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'whisper')
+        
+        
+        self.whisper = attributes[:'whisper']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'autoAnswerOnly')
+        
+        
+        self.auto_answer_only = attributes[:'autoAnswerOnly']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'callingPartyName')
         
         
@@ -513,6 +545,14 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -642,6 +682,16 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -674,6 +724,8 @@ module PureCloud
           acw_settings == o.acw_settings &&
           skill_evaluation_method == o.skill_evaluation_method &&
           queue_flow == o.queue_flow &&
+          whisper == o.whisper &&
+          auto_answer_only == o.auto_answer_only &&
           calling_party_name == o.calling_party_name &&
           calling_party_number == o.calling_party_number &&
           default_scripts == o.default_scripts &&
@@ -691,7 +743,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, default_scripts, outbound_email_address, member_count, self_uri].hash
+      [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper, auto_answer_only, calling_party_name, calling_party_number, default_scripts, outbound_email_address, member_count, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/scheduling_settings.rb

@@ -0,0 +1,229 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  # Scheduling Settings
+  class SchedulingSettings
+    # Max occupancy percent for deferred work
+    attr_accessor :max_occupancy_percent_for_deferred_work
+
+    # Default shrinkage percent for scheduling
+    attr_accessor :default_shrinkage_percent
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'max_occupancy_percent_for_deferred_work' => :'maxOccupancyPercentForDeferredWork',
+        
+        :'default_shrinkage_percent' => :'defaultShrinkagePercent'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'max_occupancy_percent_for_deferred_work' => :'Integer',
+        
+        :'default_shrinkage_percent' => :'Float'
+        
+      }
+    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?(:'maxOccupancyPercentForDeferredWork')
+        
+        
+        self.max_occupancy_percent_for_deferred_work = attributes[:'maxOccupancyPercentForDeferredWork']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'defaultShrinkagePercent')
+        
+        
+        self.default_shrinkage_percent = attributes[:'defaultShrinkagePercent']
+        
+      
+      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 &&
+          max_occupancy_percent_for_deferred_work == o.max_occupancy_percent_for_deferred_work &&
+          default_shrinkage_percent == o.default_shrinkage_percent
+    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
+      [max_occupancy_percent_for_deferred_work, default_shrinkage_percent].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