purecloudplatformclientv2 85.0.1 → 90.0.0

data/lib/purecloudplatformclientv2/models/coretype_listing.rb

@@ -0,0 +1,253 @@
+=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 CoretypeListing
+    attr_accessor :total
+
+    attr_accessor :entities
+
+    attr_accessor :self_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'total' => :'total',
+        
+        :'entities' => :'entities',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'total' => :'Integer',
+        
+        :'entities' => :'Array<Coretype>',
+        
+        :'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?(:'total')
+        
+        
+        self.total = attributes[:'total']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'entities')
+        
+        if (value = attributes[:'entities']).is_a?(Array)
+          self.entities = value
+        end
+        
+        
+      
+      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 &&
+          total == o.total &&
+          entities == o.entities &&
+          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
+      [total, entities, 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

data/lib/purecloudplatformclientv2/models/{intraday_historical_queue_data.rb → create_coaching_appointment_request.rb}

@@ -17,50 +17,51 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class IntradayHistoricalQueueData
-    # The number of interactions routed into the queue for the given media type(s) for an agent to answer
-    attr_accessor :offered
+  # Create coaching appointment request
+  class CreateCoachingAppointmentRequest
+    # The name of coaching appointment.
+    attr_accessor :name
 
-    # The number of interactions completed
-    attr_accessor :completed
+    # The description of coaching appointment.
+    attr_accessor :description
 
-    # The number of interactions answered by an agent in a given period
-    attr_accessor :answered
+    # The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_start
 
-    # The number of customers who disconnect before connecting with an agent
-    attr_accessor :abandoned
+    # The duration of coaching appointment in minutes.
+    attr_accessor :length_in_minutes
 
-    # The average time in seconds an agent spends interacting with a customer per talk segment for a defined period of time
-    attr_accessor :average_talk_time_seconds
+    # The facilitator ID of coaching appointment.
+    attr_accessor :facilitator_id
 
-    # The average time in seconds spent in after-call work. After-call work is the work that an agent performs immediately following an interaction
-    attr_accessor :average_after_call_work_seconds
+    # IDs of attendees in the coaching appointment.
+    attr_accessor :attendee_ids
 
-    # Percent of interactions answered in X seconds, where X is the service level objective configured in the service goal group matching this intraday group
-    attr_accessor :service_level_percent
+    # IDs of conversations associated with this coaching appointment.
+    attr_accessor :conversation_ids
 
-    # The average time in seconds it takes to answer an interaction once the interaction becomes available to be routed
-    attr_accessor :average_speed_of_answer_seconds
+    # IDs of documents associated with this coaching appointment.
+    attr_accessor :document_ids
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'offered' => :'offered',
+        :'name' => :'name',
         
-        :'completed' => :'completed',
+        :'description' => :'description',
         
-        :'answered' => :'answered',
+        :'date_start' => :'dateStart',
         
-        :'abandoned' => :'abandoned',
+        :'length_in_minutes' => :'lengthInMinutes',
         
-        :'average_talk_time_seconds' => :'averageTalkTimeSeconds',
+        :'facilitator_id' => :'facilitatorId',
         
-        :'average_after_call_work_seconds' => :'averageAfterCallWorkSeconds',
+        :'attendee_ids' => :'attendeeIds',
         
-        :'service_level_percent' => :'serviceLevelPercent',
+        :'conversation_ids' => :'conversationIds',
         
-        :'average_speed_of_answer_seconds' => :'averageSpeedOfAnswerSeconds'
+        :'document_ids' => :'documentIds'
         
       }
     end
@@ -69,21 +70,21 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'offered' => :'Integer',
+        :'name' => :'String',
         
-        :'completed' => :'Integer',
+        :'description' => :'String',
         
-        :'answered' => :'Integer',
+        :'date_start' => :'DateTime',
         
-        :'abandoned' => :'Integer',
+        :'length_in_minutes' => :'Integer',
         
-        :'average_talk_time_seconds' => :'Float',
+        :'facilitator_id' => :'String',
         
-        :'average_after_call_work_seconds' => :'Float',
+        :'attendee_ids' => :'Array<String>',
         
-        :'service_level_percent' => :'Float',
+        :'conversation_ids' => :'Array<String>',
         
-        :'average_speed_of_answer_seconds' => :'Float'
+        :'document_ids' => :'Array<String>'
         
       }
     end
@@ -97,73 +98,79 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
-      if attributes.has_key?(:'offered')
+      if attributes.has_key?(:'name')
         
         
-        self.offered = attributes[:'offered']
+        self.name = attributes[:'name']
         
       
       end
 
       
-      if attributes.has_key?(:'completed')
+      if attributes.has_key?(:'description')
         
         
-        self.completed = attributes[:'completed']
+        self.description = attributes[:'description']
         
       
       end
 
       
-      if attributes.has_key?(:'answered')
+      if attributes.has_key?(:'dateStart')
         
         
-        self.answered = attributes[:'answered']
+        self.date_start = attributes[:'dateStart']
         
       
       end
 
       
-      if attributes.has_key?(:'abandoned')
+      if attributes.has_key?(:'lengthInMinutes')
         
         
-        self.abandoned = attributes[:'abandoned']
+        self.length_in_minutes = attributes[:'lengthInMinutes']
         
       
       end
 
       
-      if attributes.has_key?(:'averageTalkTimeSeconds')
+      if attributes.has_key?(:'facilitatorId')
         
         
-        self.average_talk_time_seconds = attributes[:'averageTalkTimeSeconds']
+        self.facilitator_id = attributes[:'facilitatorId']
         
       
       end
 
       
-      if attributes.has_key?(:'averageAfterCallWorkSeconds')
+      if attributes.has_key?(:'attendeeIds')
         
+        if (value = attributes[:'attendeeIds']).is_a?(Array)
+          self.attendee_ids = value
+        end
         
-        self.average_after_call_work_seconds = attributes[:'averageAfterCallWorkSeconds']
         
       
       end
 
       
-      if attributes.has_key?(:'serviceLevelPercent')
+      if attributes.has_key?(:'conversationIds')
         
+        if (value = attributes[:'conversationIds']).is_a?(Array)
+          self.conversation_ids = value
+        end
         
-        self.service_level_percent = attributes[:'serviceLevelPercent']
         
       
       end
 
       
-      if attributes.has_key?(:'averageSpeedOfAnswerSeconds')
+      if attributes.has_key?(:'documentIds')
         
+        if (value = attributes[:'documentIds']).is_a?(Array)
+          self.document_ids = value
+        end
         
-        self.average_speed_of_answer_seconds = attributes[:'averageSpeedOfAnswerSeconds']
         
       
       end
@@ -185,14 +192,37 @@ module PureCloud
     def valid?
       
       
+      if @name.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @description.nil?
+        return false
+      end
+
+      
+      
       
       
       
+      if @date_start.nil?
+        return false
+      end
+
       
       
       
       
       
+      if @length_in_minutes.nil?
+        return false
+      end
+
       
       
       
@@ -202,16 +232,28 @@ module PureCloud
       
       
       
+      if @attendee_ids.nil?
+        return false
+      end
+
       
       
       
       
       
+      if @conversation_ids.nil?
+        return false
+      end
+
       
       
       
       
       
+      if @document_ids.nil?
+        return false
+      end
+
       
       
       
@@ -264,14 +306,14 @@ module PureCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          offered == o.offered &&
-          completed == o.completed &&
-          answered == o.answered &&
-          abandoned == o.abandoned &&
-          average_talk_time_seconds == o.average_talk_time_seconds &&
-          average_after_call_work_seconds == o.average_after_call_work_seconds &&
-          service_level_percent == o.service_level_percent &&
-          average_speed_of_answer_seconds == o.average_speed_of_answer_seconds
+          name == o.name &&
+          description == o.description &&
+          date_start == o.date_start &&
+          length_in_minutes == o.length_in_minutes &&
+          facilitator_id == o.facilitator_id &&
+          attendee_ids == o.attendee_ids &&
+          conversation_ids == o.conversation_ids &&
+          document_ids == o.document_ids
     end
 
     # @see the `==` method
@@ -283,7 +325,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [offered, completed, answered, abandoned, average_talk_time_seconds, average_after_call_work_seconds, service_level_percent, average_speed_of_answer_seconds].hash
+      [name, description, date_start, length_in_minutes, facilitator_id, attendee_ids, conversation_ids, document_ids].hash
     end
 
     # build the object from hash