purecloudplatformclientv2 91.0.0 → 96.0.0

data/lib/purecloudplatformclientv2/models/analytics_proposed_agent.rb

@@ -0,0 +1,228 @@
+=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 AnalyticsProposedAgent
+    # Unique identifier of an agent that was proposed by predictive routing
+    attr_accessor :proposed_agent_id
+
+    # Proposed agent rank for this conversation from predictive routing (lower is better)
+    attr_accessor :agent_rank
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'proposed_agent_id' => :'proposedAgentId',
+        
+        :'agent_rank' => :'agentRank'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'proposed_agent_id' => :'String',
+        
+        :'agent_rank' => :'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?(:'proposedAgentId')
+        
+        
+        self.proposed_agent_id = attributes[:'proposedAgentId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'agentRank')
+        
+        
+        self.agent_rank = attributes[:'agentRank']
+        
+      
+      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 &&
+          proposed_agent_id == o.proposed_agent_id &&
+          agent_rank == o.agent_rank
+    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
+      [proposed_agent_id, agent_rank].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/analytics_session.rb

@@ -170,6 +170,24 @@ module PureCloud
     # Type of flow out that occurred, e.g. voicemail, callback, or acd
     attr_accessor :flow_out_type
 
+    # All routing types for requested/attempted routing methods.
+    attr_accessor :requested_routings
+
+    # Complete routing method
+    attr_accessor :used_routing
+
+    # Selected agent id
+    attr_accessor :selected_agent_id
+
+    # Selected agent GPR rank
+    attr_accessor :selected_agent_rank
+
+    # Unique identifier of the active virtual agent assistant
+    attr_accessor :agent_assistant_id
+
+    # Proposed agents
+    attr_accessor :proposed_agents
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -278,7 +296,19 @@ module PureCloud
         
         :'media_count' => :'mediaCount',
         
-        :'flow_out_type' => :'flowOutType'
+        :'flow_out_type' => :'flowOutType',
+        
+        :'requested_routings' => :'requestedRoutings',
+        
+        :'used_routing' => :'usedRouting',
+        
+        :'selected_agent_id' => :'selectedAgentId',
+        
+        :'selected_agent_rank' => :'selectedAgentRank',
+        
+        :'agent_assistant_id' => :'agentAssistantId',
+        
+        :'proposed_agents' => :'proposedAgents'
         
       }
     end
@@ -391,7 +421,19 @@ module PureCloud
         
         :'media_count' => :'Integer',
         
-        :'flow_out_type' => :'String'
+        :'flow_out_type' => :'String',
+        
+        :'requested_routings' => :'Array<String>',
+        
+        :'used_routing' => :'String',
+        
+        :'selected_agent_id' => :'String',
+        
+        :'selected_agent_rank' => :'Integer',
+        
+        :'agent_assistant_id' => :'String',
+        
+        :'proposed_agents' => :'Array<AnalyticsProposedAgent>'
         
       }
     end
@@ -890,6 +932,64 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'requestedRoutings')
+        
+        if (value = attributes[:'requestedRoutings']).is_a?(Array)
+          self.requested_routings = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'usedRouting')
+        
+        
+        self.used_routing = attributes[:'usedRouting']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selectedAgentId')
+        
+        
+        self.selected_agent_id = attributes[:'selectedAgentId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selectedAgentRank')
+        
+        
+        self.selected_agent_rank = attributes[:'selectedAgentRank']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'agentAssistantId')
+        
+        
+        self.agent_assistant_id = attributes[:'agentAssistantId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'proposedAgents')
+        
+        if (value = attributes[:'proposedAgents']).is_a?(Array)
+          self.proposed_agents = value
+        end
+        
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -1117,6 +1217,35 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["Predictive", "Preferred", "Manual", "Last", "Bullseye", "Standard"]
+      if @used_routing && !allowed_values.include?(@used_routing)
+        return false
+      end
+      
+      
+      
+      
       
       
       
@@ -1406,6 +1535,45 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] used_routing Object to be assigned
+    def used_routing=(used_routing)
+      allowed_values = ["Predictive", "Preferred", "Manual", "Last", "Bullseye", "Standard"]
+      if used_routing && !allowed_values.include?(used_routing)
+        fail ArgumentError, "invalid value for 'used_routing', must be one of #{allowed_values}."
+      end
+      @used_routing = used_routing
+    end
+
+    
+    
     
     
     
@@ -1484,7 +1652,13 @@ module PureCloud
           provider == o.provider &&
           remote == o.remote &&
           media_count == o.media_count &&
-          flow_out_type == o.flow_out_type
+          flow_out_type == o.flow_out_type &&
+          requested_routings == o.requested_routings &&
+          used_routing == o.used_routing &&
+          selected_agent_id == o.selected_agent_id &&
+          selected_agent_rank == o.selected_agent_rank &&
+          agent_assistant_id == o.agent_assistant_id &&
+          proposed_agents == o.proposed_agents
     end
 
     # @see the `==` method
@@ -1496,7 +1670,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [media_type, session_id, address_other, address_self, address_from, address_to, message_type, ani, direction, dnis, session_dnis, outbound_campaign_id, outbound_contact_id, outbound_contact_list_id, disposition_analyzer, disposition_name, edge_id, remote_name_displayable, room_id, monitored_session_id, monitored_participant_id, callback_user_name, callback_numbers, callback_scheduled_time, script_id, peer_id, skip_enabled, timeout_seconds, cobrowse_role, cobrowse_room_id, media_bridge_id, screen_share_address_self, sharing_screen, screen_share_room_id, video_room_id, video_address_self, segments, metrics, flow, media_endpoint_stats, recording, journey_customer_id, journey_customer_id_type, journey_customer_session_id, journey_customer_session_id_type, journey_action_id, journey_action_map_id, journey_action_map_version, protocol_call_id, provider, remote, media_count, flow_out_type].hash
+      [media_type, session_id, address_other, address_self, address_from, address_to, message_type, ani, direction, dnis, session_dnis, outbound_campaign_id, outbound_contact_id, outbound_contact_list_id, disposition_analyzer, disposition_name, edge_id, remote_name_displayable, room_id, monitored_session_id, monitored_participant_id, callback_user_name, callback_numbers, callback_scheduled_time, script_id, peer_id, skip_enabled, timeout_seconds, cobrowse_role, cobrowse_room_id, media_bridge_id, screen_share_address_self, sharing_screen, screen_share_room_id, video_room_id, video_address_self, segments, metrics, flow, media_endpoint_stats, recording, journey_customer_id, journey_customer_id_type, journey_customer_session_id, journey_customer_session_id_type, journey_action_id, journey_action_map_id, journey_action_map_version, protocol_call_id, provider, remote, media_count, flow_out_type, requested_routings, used_routing, selected_agent_id, selected_agent_rank, agent_assistant_id, proposed_agents].hash
     end
 
     # build the object from hash