purecloudplatformclientv2 90.0.0 → 95.0.0

data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb

@@ -0,0 +1,232 @@
+=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 AmazonLexRequest
+    # AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs
+    attr_accessor :request_attributes
+
+    # AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs
+    attr_accessor :session_attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'request_attributes' => :'requestAttributes',
+        
+        :'session_attributes' => :'sessionAttributes'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'request_attributes' => :'Hash<String, String>',
+        
+        :'session_attributes' => :'Hash<String, 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?(:'requestAttributes')
+        
+        if (value = attributes[:'requestAttributes']).is_a?(Array)
+          self.request_attributes = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'sessionAttributes')
+        
+        if (value = attributes[:'sessionAttributes']).is_a?(Array)
+          self.session_attributes = 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?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          request_attributes == o.request_attributes &&
+          session_attributes == o.session_attributes
+    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
+      [request_attributes, session_attributes].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,18 @@ 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -278,7 +290,15 @@ 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'
         
       }
     end
@@ -391,7 +411,15 @@ 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'
         
       }
     end
@@ -890,6 +918,44 @@ 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
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -1121,6 +1187,27 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["Predictive", "Preferred", "Manual", "Last", "Bullseye", "Standard"]
+      if @used_routing && !allowed_values.include?(@used_routing)
+        return false
+      end
       
       
       
@@ -1414,6 +1501,35 @@ 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 +1600,11 @@ 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
     end
 
     # @see the `==` method
@@ -1496,7 +1616,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].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/array_node.rb

@@ -28,25 +28,23 @@ module PureCloud
 
     attr_accessor :object
 
-    attr_accessor :missing_node
-
     attr_accessor :value_node
 
-    attr_accessor :binary
+    attr_accessor :container_node
 
-    attr_accessor :pojo
+    attr_accessor :missing_node
 
-    attr_accessor :container_node
+    attr_accessor :pojo
 
-    attr_accessor :int
+    attr_accessor :floating_point_number
 
     attr_accessor :integral_number
 
     attr_accessor :short
 
-    attr_accessor :long
+    attr_accessor :int
 
-    attr_accessor :floating_point_number
+    attr_accessor :long
 
     attr_accessor :double
 
@@ -56,6 +54,8 @@ module PureCloud
 
     attr_accessor :textual
 
+    attr_accessor :binary
+
     attr_accessor :array
 
     attr_accessor :null
@@ -74,25 +74,23 @@ module PureCloud
         
         :'object' => :'object',
         
-        :'missing_node' => :'missingNode',
-        
         :'value_node' => :'valueNode',
         
-        :'binary' => :'binary',
+        :'container_node' => :'containerNode',
         
-        :'pojo' => :'pojo',
+        :'missing_node' => :'missingNode',
         
-        :'container_node' => :'containerNode',
+        :'pojo' => :'pojo',
         
-        :'int' => :'int',
+        :'floating_point_number' => :'floatingPointNumber',
         
         :'integral_number' => :'integralNumber',
         
         :'short' => :'short',
         
-        :'long' => :'long',
+        :'int' => :'int',
         
-        :'floating_point_number' => :'floatingPointNumber',
+        :'long' => :'long',
         
         :'double' => :'double',
         
@@ -102,6 +100,8 @@ module PureCloud
         
         :'textual' => :'textual',
         
+        :'binary' => :'binary',
+        
         :'array' => :'array',
         
         :'null' => :'null'
@@ -123,25 +123,23 @@ module PureCloud
         
         :'object' => :'BOOLEAN',
         
-        :'missing_node' => :'BOOLEAN',
-        
         :'value_node' => :'BOOLEAN',
         
-        :'binary' => :'BOOLEAN',
+        :'container_node' => :'BOOLEAN',
         
-        :'pojo' => :'BOOLEAN',
+        :'missing_node' => :'BOOLEAN',
         
-        :'container_node' => :'BOOLEAN',
+        :'pojo' => :'BOOLEAN',
         
-        :'int' => :'BOOLEAN',
+        :'floating_point_number' => :'BOOLEAN',
         
         :'integral_number' => :'BOOLEAN',
         
         :'short' => :'BOOLEAN',
         
-        :'long' => :'BOOLEAN',
+        :'int' => :'BOOLEAN',
         
-        :'floating_point_number' => :'BOOLEAN',
+        :'long' => :'BOOLEAN',
         
         :'double' => :'BOOLEAN',
         
@@ -151,6 +149,8 @@ module PureCloud
         
         :'textual' => :'BOOLEAN',
         
+        :'binary' => :'BOOLEAN',
+        
         :'array' => :'BOOLEAN',
         
         :'null' => :'BOOLEAN'
@@ -212,15 +212,6 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'missingNode')
-        
-        
-        self.missing_node = attributes[:'missingNode']
-        
-      
-      end
-
-      
       if attributes.has_key?(:'valueNode')
         
         
@@ -230,37 +221,37 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'binary')
+      if attributes.has_key?(:'containerNode')
         
         
-        self.binary = attributes[:'binary']
+        self.container_node = attributes[:'containerNode']
         
       
       end
 
       
-      if attributes.has_key?(:'pojo')
+      if attributes.has_key?(:'missingNode')
         
         
-        self.pojo = attributes[:'pojo']
+        self.missing_node = attributes[:'missingNode']
         
       
       end
 
       
-      if attributes.has_key?(:'containerNode')
+      if attributes.has_key?(:'pojo')
         
         
-        self.container_node = attributes[:'containerNode']
+        self.pojo = attributes[:'pojo']
         
       
       end
 
       
-      if attributes.has_key?(:'int')
+      if attributes.has_key?(:'floatingPointNumber')
         
         
-        self.int = attributes[:'int']
+        self.floating_point_number = attributes[:'floatingPointNumber']
         
       
       end
@@ -284,19 +275,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'long')
+      if attributes.has_key?(:'int')
         
         
-        self.long = attributes[:'long']
+        self.int = attributes[:'int']
         
       
       end
 
       
-      if attributes.has_key?(:'floatingPointNumber')
+      if attributes.has_key?(:'long')
         
         
-        self.floating_point_number = attributes[:'floatingPointNumber']
+        self.long = attributes[:'long']
         
       
       end
@@ -338,6 +329,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'binary')
+        
+        
+        self.binary = attributes[:'binary']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'array')
         
         
@@ -587,20 +587,20 @@ module PureCloud
           number == o.number &&
           boolean == o.boolean &&
           object == o.object &&
-          missing_node == o.missing_node &&
           value_node == o.value_node &&
-          binary == o.binary &&
-          pojo == o.pojo &&
           container_node == o.container_node &&
-          int == o.int &&
+          missing_node == o.missing_node &&
+          pojo == o.pojo &&
+          floating_point_number == o.floating_point_number &&
           integral_number == o.integral_number &&
           short == o.short &&
+          int == o.int &&
           long == o.long &&
-          floating_point_number == o.floating_point_number &&
           double == o.double &&
           big_decimal == o.big_decimal &&
           big_integer == o.big_integer &&
           textual == o.textual &&
+          binary == o.binary &&
           array == o.array &&
           null == o.null
     end
@@ -614,7 +614,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [node_type, float, number, boolean, object, missing_node, value_node, binary, pojo, container_node, int, integral_number, short, long, floating_point_number, double, big_decimal, big_integer, textual, array, null].hash
+      [node_type, float, number, boolean, object, value_node, container_node, missing_node, pojo, floating_point_number, integral_number, short, int, long, double, big_decimal, big_integer, textual, binary, array, null].hash
     end
 
     # build the object from hash