purecloudplatformclientv2 22.0.0 → 23.0.0

data/lib/purecloudplatformclientv2/api_client.rb

@@ -76,7 +76,7 @@ module PureCloud
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
-      header_params['purecloud-sdk'] = '22.0.0'
+      header_params['purecloud-sdk'] = '23.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/activity_code.rb

@@ -19,16 +19,19 @@ require 'date'
 module PureCloud
   # Activity code data
   class ActivityCode
-    # The activity code's name
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    # The name of the activity code. Default activity codes will be created with an empty name
     attr_accessor :name
 
-    # Whether this activity code is active or only used for historical schedules
+    # Whether this activity code is active or has been deleted
     attr_accessor :is_active
 
     # Whether this is a default activity code
     attr_accessor :is_default
 
-    # The activity code's category
+    # The activity code's category.
     attr_accessor :category
 
     # The default length of the activity in minutes
@@ -37,16 +40,24 @@ module PureCloud
     # Whether an agent is paid while performing this activity
     attr_accessor :counts_as_paid_time
 
-    # Indicates whether or not the activity should be counted as work time
+    # Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints
     attr_accessor :counts_as_work_time
 
-    # Whether an agent can select this activity code when creating or editing a time off request
-    attr_accessor :is_agent_time_off_selectable
+    # Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off.
+    attr_accessor :agent_time_off_selectable
+
+    # Version metadata for the associated management unit's list of activity codes
+    attr_accessor :metadata
+
+    # The URI for this object
+    attr_accessor :self_uri
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
+        :'id' => :'id',
+        
         :'name' => :'name',
         
         :'is_active' => :'isActive',
@@ -61,7 +72,11 @@ module PureCloud
         
         :'counts_as_work_time' => :'countsAsWorkTime',
         
-        :'is_agent_time_off_selectable' => :'isAgentTimeOffSelectable'
+        :'agent_time_off_selectable' => :'agentTimeOffSelectable',
+        
+        :'metadata' => :'metadata',
+        
+        :'self_uri' => :'selfUri'
         
       }
     end
@@ -70,6 +85,8 @@ module PureCloud
     def self.swagger_types
       {
         
+        :'id' => :'String',
+        
         :'name' => :'String',
         
         :'is_active' => :'BOOLEAN',
@@ -84,7 +101,11 @@ module PureCloud
         
         :'counts_as_work_time' => :'BOOLEAN',
         
-        :'is_agent_time_off_selectable' => :'BOOLEAN'
+        :'agent_time_off_selectable' => :'BOOLEAN',
+        
+        :'metadata' => :'WfmVersionedEntityMetadata',
+        
+        :'self_uri' => :'String'
         
       }
     end
@@ -98,6 +119,15 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
+      if attributes.has_key?(:'id')
+        
+        
+        self.id = attributes[:'id']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'name')
         
         
@@ -161,10 +191,28 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'isAgentTimeOffSelectable')
+      if attributes.has_key?(:'agentTimeOffSelectable')
         
         
-        self.is_agent_time_off_selectable = attributes[:'isAgentTimeOffSelectable']
+        self.agent_time_off_selectable = attributes[:'agentTimeOffSelectable']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'metadata')
+        
+        
+        self.metadata = attributes[:'metadata']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selfUri')
+        
+        
+        self.self_uri = attributes[:'selfUri']
         
       
       end
@@ -199,6 +247,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"]
       if @category && !allowed_values.include?(@category)
         return false
@@ -222,6 +274,19 @@ module PureCloud
       
       
       
+      
+      if @metadata.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      
+      
+      
     end
 
     
@@ -238,6 +303,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -263,6 +333,16 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -279,6 +359,7 @@ module PureCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
           name == o.name &&
           is_active == o.is_active &&
           is_default == o.is_default &&
@@ -286,7 +367,9 @@ module PureCloud
           length_in_minutes == o.length_in_minutes &&
           counts_as_paid_time == o.counts_as_paid_time &&
           counts_as_work_time == o.counts_as_work_time &&
-          is_agent_time_off_selectable == o.is_agent_time_off_selectable
+          agent_time_off_selectable == o.agent_time_off_selectable &&
+          metadata == o.metadata &&
+          self_uri == o.self_uri
     end
 
     # @see the `==` method
@@ -298,7 +381,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, is_active, is_default, category, length_in_minutes, counts_as_paid_time, counts_as_work_time, is_agent_time_off_selectable].hash
+      [id, name, is_active, is_default, category, length_in_minutes, counts_as_paid_time, counts_as_work_time, agent_time_off_selectable, metadata, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/activity_code_container.rb

@@ -22,11 +22,16 @@ module PureCloud
     # Map of activity code id to activity code
     attr_accessor :activity_codes
 
+    # Version metadata for the associated management unit's list of activity codes
+    attr_accessor :metadata
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'activity_codes' => :'activityCodes'
+        :'activity_codes' => :'activityCodes',
+        
+        :'metadata' => :'metadata'
         
       }
     end
@@ -35,7 +40,9 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'activity_codes' => :'Hash<String, ActivityCode>'
+        :'activity_codes' => :'Hash<String, ActivityCode>',
+        
+        :'metadata' => :'WfmVersionedEntityMetadata'
         
       }
     end
@@ -60,6 +67,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'metadata')
+        
+        
+        self.metadata = attributes[:'metadata']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -79,6 +95,15 @@ module PureCloud
       
       
       
+      
+      if @metadata.nil?
+        return false
+      end
+
+      
+      
+      
+      
     end
 
     
@@ -87,12 +112,18 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          activity_codes == o.activity_codes
+          activity_codes == o.activity_codes &&
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -104,7 +135,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activity_codes].hash
+      [activity_codes, metadata].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/adherence_settings.rb

@@ -70,7 +70,7 @@ module PureCloud
         
         :'track_on_queue_activity' => :'BOOLEAN',
         
-        :'ignored_activity_categories' => :'Array<String>'
+        :'ignored_activity_categories' => :'IgnoredActivityCategories'
         
       }
     end
@@ -131,10 +131,8 @@ module PureCloud
       
       if attributes.has_key?(:'ignoredActivityCategories')
         
-        if (value = attributes[:'ignoredActivityCategories']).is_a?(Array)
-          self.ignored_activity_categories = value
-        end
         
+        self.ignored_activity_categories = attributes[:'ignoredActivityCategories']
         
       
       end

data/lib/purecloudplatformclientv2/models/batch_download_job_result.rb

@@ -0,0 +1,383 @@
+=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
+  class BatchDownloadJobResult
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # Conversation id of the result
+    attr_accessor :conversation_id
+
+    # Recording id of the result
+    attr_accessor :recording_id
+
+    # URL of results... HTTP GET from this location to download results for this item
+    attr_accessor :result_url
+
+    # Content type of this result
+    attr_accessor :content_type
+
+    # An error message, in case of failed processing will indicate the cause of the failure
+    attr_accessor :error_msg
+
+    # The URI for this object
+    attr_accessor :self_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'name' => :'name',
+        
+        :'conversation_id' => :'conversationId',
+        
+        :'recording_id' => :'recordingId',
+        
+        :'result_url' => :'resultUrl',
+        
+        :'content_type' => :'contentType',
+        
+        :'error_msg' => :'errorMsg',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'name' => :'String',
+        
+        :'conversation_id' => :'String',
+        
+        :'recording_id' => :'String',
+        
+        :'result_url' => :'String',
+        
+        :'content_type' => :'String',
+        
+        :'error_msg' => :'String',
+        
+        :'self_uri' => :'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?(:'id')
+        
+        
+        self.id = attributes[:'id']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'conversationId')
+        
+        
+        self.conversation_id = attributes[:'conversationId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'recordingId')
+        
+        
+        self.recording_id = attributes[:'recordingId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'resultUrl')
+        
+        
+        self.result_url = attributes[:'resultUrl']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'contentType')
+        
+        
+        self.content_type = attributes[:'contentType']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'errorMsg')
+        
+        
+        self.error_msg = attributes[:'errorMsg']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selfUri')
+        
+        
+        self.self_uri = attributes[:'selfUri']
+        
+      
+      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 &&
+          id == o.id &&
+          name == o.name &&
+          conversation_id == o.conversation_id &&
+          recording_id == o.recording_id &&
+          result_url == o.result_url &&
+          content_type == o.content_type &&
+          error_msg == o.error_msg &&
+          self_uri == o.self_uri
+    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
+      [id, name, conversation_id, recording_id, result_url, content_type, error_msg, self_uri].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