purecloudplatformclientv2 92.0.0 → 93.0.0

data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb

@@ -0,0 +1,428 @@
+=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 MessagingCampaignEntityListing
+    attr_accessor :entities
+
+    attr_accessor :page_size
+
+    attr_accessor :page_number
+
+    attr_accessor :total
+
+    attr_accessor :first_uri
+
+    attr_accessor :self_uri
+
+    attr_accessor :next_uri
+
+    attr_accessor :last_uri
+
+    attr_accessor :previous_uri
+
+    attr_accessor :page_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'entities' => :'entities',
+        
+        :'page_size' => :'pageSize',
+        
+        :'page_number' => :'pageNumber',
+        
+        :'total' => :'total',
+        
+        :'first_uri' => :'firstUri',
+        
+        :'self_uri' => :'selfUri',
+        
+        :'next_uri' => :'nextUri',
+        
+        :'last_uri' => :'lastUri',
+        
+        :'previous_uri' => :'previousUri',
+        
+        :'page_count' => :'pageCount'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'entities' => :'Array<MessagingCampaign>',
+        
+        :'page_size' => :'Integer',
+        
+        :'page_number' => :'Integer',
+        
+        :'total' => :'Integer',
+        
+        :'first_uri' => :'String',
+        
+        :'self_uri' => :'String',
+        
+        :'next_uri' => :'String',
+        
+        :'last_uri' => :'String',
+        
+        :'previous_uri' => :'String',
+        
+        :'page_count' => :'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?(:'entities')
+        
+        if (value = attributes[:'entities']).is_a?(Array)
+          self.entities = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'pageSize')
+        
+        
+        self.page_size = attributes[:'pageSize']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'pageNumber')
+        
+        
+        self.page_number = attributes[:'pageNumber']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'total')
+        
+        
+        self.total = attributes[:'total']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'firstUri')
+        
+        
+        self.first_uri = attributes[:'firstUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selfUri')
+        
+        
+        self.self_uri = attributes[:'selfUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'nextUri')
+        
+        
+        self.next_uri = attributes[:'nextUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'lastUri')
+        
+        
+        self.last_uri = attributes[:'lastUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'previousUri')
+        
+        
+        self.previous_uri = attributes[:'previousUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'pageCount')
+        
+        
+        self.page_count = attributes[:'pageCount']
+        
+      
+      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 &&
+          entities == o.entities &&
+          page_size == o.page_size &&
+          page_number == o.page_number &&
+          total == o.total &&
+          first_uri == o.first_uri &&
+          self_uri == o.self_uri &&
+          next_uri == o.next_uri &&
+          last_uri == o.last_uri &&
+          previous_uri == o.previous_uri &&
+          page_count == o.page_count
+    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
+      [entities, page_size, page_number, total, first_uri, self_uri, next_uri, last_uri, previous_uri, page_count].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/observation_value.rb

@@ -63,9 +63,15 @@ module PureCloud
     # Dialed number identification service (number dialed by the calling party)
     attr_accessor :dnis
 
-    # The team Id the user is a member of
+    # The team id the user is a member of
     attr_accessor :team_id
 
+    # All routing types for requested/attempted routing methods
+    attr_accessor :requested_routings
+
+    # Complete routing method
+    attr_accessor :used_routing
+
     attr_accessor :scored_agents
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -104,6 +110,10 @@ module PureCloud
         
         :'team_id' => :'teamId',
         
+        :'requested_routings' => :'requestedRoutings',
+        
+        :'used_routing' => :'usedRouting',
+        
         :'scored_agents' => :'scoredAgents'
         
       }
@@ -145,6 +155,10 @@ module PureCloud
         
         :'team_id' => :'String',
         
+        :'requested_routings' => :'Array<String>',
+        
+        :'used_routing' => :'String',
+        
         :'scored_agents' => :'Array<AnalyticsScoredAgent>'
         
       }
@@ -305,6 +319,26 @@ 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?(:'scoredAgents')
         
         if (value = attributes[:'scoredAgents']).is_a?(Array)
@@ -402,6 +436,19 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["Predictive", "Preferred", "Manual", "Last", "Bullseye", "Standard"]
+      if @used_routing && !allowed_values.include?(@used_routing)
+        return false
+      end
       
       
       
@@ -498,6 +545,25 @@ 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
+
     
     
     
@@ -527,6 +593,8 @@ module PureCloud
           ani == o.ani &&
           dnis == o.dnis &&
           team_id == o.team_id &&
+          requested_routings == o.requested_routings &&
+          used_routing == o.used_routing &&
           scored_agents == o.scored_agents
     end
 
@@ -539,7 +607,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [observation_date, conversation_id, session_id, requested_routing_skill_ids, requested_language_id, routing_priority, participant_name, user_id, direction, converted_from, converted_to, address_from, address_to, ani, dnis, team_id, scored_agents].hash
+      [observation_date, conversation_id, session_id, requested_routing_skill_ids, requested_language_id, routing_priority, participant_name, user_id, direction, converted_from, converted_to, address_from, address_to, ani, dnis, team_id, requested_routings, used_routing, scored_agents].hash
     end
 
     # build the object from hash