purecloudplatformclientv2 86.0.0 → 91.0.0

data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb

@@ -0,0 +1,426 @@
+=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
+  # Create coaching appointment request
+  class CreateCoachingAppointmentRequest
+    # The name of coaching appointment.
+    attr_accessor :name
+
+    # The description of coaching appointment.
+    attr_accessor :description
+
+    # 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 duration of coaching appointment in minutes.
+    attr_accessor :length_in_minutes
+
+    # The facilitator ID of coaching appointment.
+    attr_accessor :facilitator_id
+
+    # IDs of attendees in the coaching appointment.
+    attr_accessor :attendee_ids
+
+    # IDs of conversations associated with this coaching appointment.
+    attr_accessor :conversation_ids
+
+    # 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
+      {
+        
+        :'name' => :'name',
+        
+        :'description' => :'description',
+        
+        :'date_start' => :'dateStart',
+        
+        :'length_in_minutes' => :'lengthInMinutes',
+        
+        :'facilitator_id' => :'facilitatorId',
+        
+        :'attendee_ids' => :'attendeeIds',
+        
+        :'conversation_ids' => :'conversationIds',
+        
+        :'document_ids' => :'documentIds'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'name' => :'String',
+        
+        :'description' => :'String',
+        
+        :'date_start' => :'DateTime',
+        
+        :'length_in_minutes' => :'Integer',
+        
+        :'facilitator_id' => :'String',
+        
+        :'attendee_ids' => :'Array<String>',
+        
+        :'conversation_ids' => :'Array<String>',
+        
+        :'document_ids' => :'Array<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?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'description')
+        
+        
+        self.description = attributes[:'description']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'dateStart')
+        
+        
+        self.date_start = attributes[:'dateStart']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'lengthInMinutes')
+        
+        
+        self.length_in_minutes = attributes[:'lengthInMinutes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'facilitatorId')
+        
+        
+        self.facilitator_id = attributes[:'facilitatorId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'attendeeIds')
+        
+        if (value = attributes[:'attendeeIds']).is_a?(Array)
+          self.attendee_ids = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'conversationIds')
+        
+        if (value = attributes[:'conversationIds']).is_a?(Array)
+          self.conversation_ids = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'documentIds')
+        
+        if (value = attributes[:'documentIds']).is_a?(Array)
+          self.document_ids = value
+        end
+        
+        
+      
+      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?
+      
+      
+      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
+
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if @attendee_ids.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @conversation_ids.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @document_ids.nil?
+        return false
+      end
+
+      
+      
+      
+      
+    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 &&
+          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
+    # @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
+      [name, description, date_start, length_in_minutes, facilitator_id, attendee_ids, conversation_ids, document_ids].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/create_queue_request.rb

@@ -48,6 +48,9 @@ module PureCloud
     # The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM
     attr_accessor :media_settings
 
+    # The routing rules for the queue, used for routing to known or preferred agents.
+    attr_accessor :routing_rules
+
     # The bulls-eye settings for the queue.
     attr_accessor :bullseye
 
@@ -110,6 +113,8 @@ module PureCloud
         
         :'media_settings' => :'mediaSettings',
         
+        :'routing_rules' => :'routingRules',
+        
         :'bullseye' => :'bullseye',
         
         :'acw_settings' => :'acwSettings',
@@ -163,6 +168,8 @@ module PureCloud
         
         :'media_settings' => :'Hash<String, MediaSetting>',
         
+        :'routing_rules' => :'Array<RoutingRule>',
+        
         :'bullseye' => :'Bullseye',
         
         :'acw_settings' => :'AcwSettings',
@@ -290,6 +297,17 @@ module PureCloud
         
         
       
+      end
+
+      
+      if attributes.has_key?(:'routingRules')
+        
+        if (value = attributes[:'routingRules']).is_a?(Array)
+          self.routing_rules = value
+        end
+        
+        
+      
       end
 
       
@@ -477,6 +495,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -587,6 +609,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -671,6 +698,7 @@ module PureCloud
           created_by == o.created_by &&
           member_count == o.member_count &&
           media_settings == o.media_settings &&
+          routing_rules == o.routing_rules &&
           bullseye == o.bullseye &&
           acw_settings == o.acw_settings &&
           skill_evaluation_method == o.skill_evaluation_method &&
@@ -695,7 +723,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, division, description, date_created, date_modified, modified_by, created_by, member_count, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper_prompt, auto_answer_only, calling_party_name, calling_party_number, default_scripts, outbound_messaging_addresses, outbound_email_address, source_queue_id, self_uri].hash
+      [id, name, division, description, date_created, date_modified, modified_by, created_by, member_count, media_settings, routing_rules, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper_prompt, auto_answer_only, calling_party_name, calling_party_number, default_scripts, outbound_messaging_addresses, outbound_email_address, source_queue_id, self_uri].hash
     end
 
     # build the object from hash