purecloudplatformclientv2 85.0.0 → 89.0.0

data/lib/purecloudplatformclientv2/models/{update_week_schedule_request.rb → nlu_domain_version.rb}

@@ -17,55 +17,75 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class UpdateWeekScheduleRequest
-    # Description of the week schedule
+  class NluDomainVersion
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    # The NLU domain of the version.
+    attr_accessor :domain
+
+    # The description of the NLU domain version.
     attr_accessor :description
 
-    # Whether the week schedule is published
-    attr_accessor :published
+    # The language that the NLU domain version supports.
+    attr_accessor :language
+
+    # The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_created
 
-    # User schedules in the week
-    attr_accessor :user_schedules
+    # The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_modified
 
-    # IDs of partial uploads to include in this imported schedule. It is applicable only for large schedules where activity count in schedule is greater than 17500
-    attr_accessor :partial_upload_ids
+    # The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_trained
 
-    # Version metadata for this work plan
-    attr_accessor :metadata
+    # The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_published
 
-    # Version of agent schedules in the week schedule
-    attr_accessor :agent_schedules_version
+    # The training status of the NLU domain version.
+    attr_accessor :training_status
 
-    # Reference to optionally point the schedule at a new short term forecast
-    attr_accessor :short_term_forecast
+    # The evaluation status of the NLU domain version.
+    attr_accessor :evaluation_status
 
-    # The headcount forecast associated with the schedule.  If not null, existing values will be irrecoverably replaced
-    attr_accessor :headcount_forecast
+    # The intents defined for this NLU domain version.
+    attr_accessor :intents
 
-    # For a published schedule, this determines whether a notification will be shown to agents in the default PureCloud user interface.  The CPC notification will always be sent and the value specified here affects what data is returned in the 'updates' property.  In the default PureCloud UI, \"None\" means that agents will not be notified, \"ShiftTimesOnly\" means agents will only be notified for changes to shift start and end times,  and \"All\" means that agents will be notified for any change to a shift or activity (except for full day off activities).  When building a custom client, use this property to specify the level of detail you need. Defaults to \"ShiftTimesOnly\".
-    attr_accessor :agent_update_filter
+    # The entity types defined for this NLU domain version.
+    attr_accessor :entity_types
+
+    # The URI for this object
+    attr_accessor :self_uri
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
+        :'id' => :'id',
+        
+        :'domain' => :'domain',
+        
         :'description' => :'description',
         
-        :'published' => :'published',
+        :'language' => :'language',
         
-        :'user_schedules' => :'userSchedules',
+        :'date_created' => :'dateCreated',
         
-        :'partial_upload_ids' => :'partialUploadIds',
+        :'date_modified' => :'dateModified',
         
-        :'metadata' => :'metadata',
+        :'date_trained' => :'dateTrained',
         
-        :'agent_schedules_version' => :'agentSchedulesVersion',
+        :'date_published' => :'datePublished',
         
-        :'short_term_forecast' => :'shortTermForecast',
+        :'training_status' => :'trainingStatus',
         
-        :'headcount_forecast' => :'headcountForecast',
+        :'evaluation_status' => :'evaluationStatus',
         
-        :'agent_update_filter' => :'agentUpdateFilter'
+        :'intents' => :'intents',
+        
+        :'entity_types' => :'entityTypes',
+        
+        :'self_uri' => :'selfUri'
         
       }
     end
@@ -74,23 +94,31 @@ module PureCloud
     def self.swagger_types
       {
         
+        :'id' => :'String',
+        
+        :'domain' => :'NluDomain',
+        
         :'description' => :'String',
         
-        :'published' => :'BOOLEAN',
+        :'language' => :'String',
+        
+        :'date_created' => :'DateTime',
+        
+        :'date_modified' => :'DateTime',
         
-        :'user_schedules' => :'Hash<String, UserSchedule>',
+        :'date_trained' => :'DateTime',
         
-        :'partial_upload_ids' => :'Array<String>',
+        :'date_published' => :'DateTime',
         
-        :'metadata' => :'WfmVersionedEntityMetadata',
+        :'training_status' => :'String',
         
-        :'agent_schedules_version' => :'Integer',
+        :'evaluation_status' => :'String',
         
-        :'short_term_forecast' => :'ShortTermForecastReference',
+        :'intents' => :'Array<IntentDefinition>',
         
-        :'headcount_forecast' => :'HeadcountForecast',
+        :'entity_types' => :'Array<NamedEntityTypeDefinition>',
         
-        :'agent_update_filter' => :'String'
+        :'self_uri' => :'String'
         
       }
     end
@@ -104,6 +132,24 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
+      if attributes.has_key?(:'id')
+        
+        
+        self.id = attributes[:'id']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'domain')
+        
+        
+        self.domain = attributes[:'domain']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'description')
         
         
@@ -113,77 +159,95 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'published')
+      if attributes.has_key?(:'language')
         
         
-        self.published = attributes[:'published']
+        self.language = attributes[:'language']
         
       
       end
 
       
-      if attributes.has_key?(:'userSchedules')
+      if attributes.has_key?(:'dateCreated')
         
-        if (value = attributes[:'userSchedules']).is_a?(Array)
-          self.user_schedules = value
-        end
         
+        self.date_created = attributes[:'dateCreated']
         
       
       end
 
       
-      if attributes.has_key?(:'partialUploadIds')
+      if attributes.has_key?(:'dateModified')
         
-        if (value = attributes[:'partialUploadIds']).is_a?(Array)
-          self.partial_upload_ids = value
-        end
+        
+        self.date_modified = attributes[:'dateModified']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'dateTrained')
         
         
+        self.date_trained = attributes[:'dateTrained']
+        
       
       end
 
       
-      if attributes.has_key?(:'metadata')
+      if attributes.has_key?(:'datePublished')
         
         
-        self.metadata = attributes[:'metadata']
+        self.date_published = attributes[:'datePublished']
         
       
       end
 
       
-      if attributes.has_key?(:'agentSchedulesVersion')
+      if attributes.has_key?(:'trainingStatus')
         
         
-        self.agent_schedules_version = attributes[:'agentSchedulesVersion']
+        self.training_status = attributes[:'trainingStatus']
         
       
       end
 
       
-      if attributes.has_key?(:'shortTermForecast')
+      if attributes.has_key?(:'evaluationStatus')
         
         
-        self.short_term_forecast = attributes[:'shortTermForecast']
+        self.evaluation_status = attributes[:'evaluationStatus']
         
       
       end
 
       
-      if attributes.has_key?(:'headcountForecast')
+      if attributes.has_key?(:'intents')
         
+        if (value = attributes[:'intents']).is_a?(Array)
+          self.intents = value
+        end
         
-        self.headcount_forecast = attributes[:'headcountForecast']
         
       
       end
 
       
-      if attributes.has_key?(:'agentUpdateFilter')
+      if attributes.has_key?(:'entityTypes')
         
+        if (value = attributes[:'entityTypes']).is_a?(Array)
+          self.entity_types = value
+        end
         
-        self.agent_update_filter = attributes[:'agentUpdateFilter']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selfUri')
+        
+        
+        self.self_uri = attributes[:'selfUri']
         
       
       end
@@ -221,19 +285,11 @@ module PureCloud
       
       
       
-      if @metadata.nil?
-        return false
-      end
-
       
       
       
       
       
-      if @agent_schedules_version.nil?
-        return false
-      end
-
       
       
       
@@ -244,17 +300,36 @@ module PureCloud
       
       
       
+      
+      
+      allowed_values = ["Untrained", "Training", "Trained", "Error", "Unknown"]
+      if @training_status && !allowed_values.include?(@training_status)
+        return false
+      end
       
       
       
       
-      allowed_values = ["All", "ShiftTimeChange", "None"]
-      if @agent_update_filter && !allowed_values.include?(@agent_update_filter)
+      
+      allowed_values = ["Unevaluated", "Evaluating", "Evaluated", "Error"]
+      if @evaluation_status && !allowed_values.include?(@evaluation_status)
         return false
       end
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
     end
 
     
@@ -300,32 +375,65 @@ module PureCloud
     
     
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] agent_update_filter Object to be assigned
-    def agent_update_filter=(agent_update_filter)
-      allowed_values = ["All", "ShiftTimeChange", "None"]
-      if agent_update_filter && !allowed_values.include?(agent_update_filter)
-        fail ArgumentError, "invalid value for 'agent_update_filter', must be one of #{allowed_values}."
+    # @param [Object] training_status Object to be assigned
+    def training_status=(training_status)
+      allowed_values = ["Untrained", "Training", "Trained", "Error", "Unknown"]
+      if training_status && !allowed_values.include?(training_status)
+        fail ArgumentError, "invalid value for 'training_status', must be one of #{allowed_values}."
       end
-      @agent_update_filter = agent_update_filter
+      @training_status = training_status
     end
 
     
     
     
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] evaluation_status Object to be assigned
+    def evaluation_status=(evaluation_status)
+      allowed_values = ["Unevaluated", "Evaluating", "Evaluated", "Error"]
+      if evaluation_status && !allowed_values.include?(evaluation_status)
+        fail ArgumentError, "invalid value for 'evaluation_status', must be one of #{allowed_values}."
+      end
+      @evaluation_status = evaluation_status
+    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 &&
+          id == o.id &&
+          domain == o.domain &&
           description == o.description &&
-          published == o.published &&
-          user_schedules == o.user_schedules &&
-          partial_upload_ids == o.partial_upload_ids &&
-          metadata == o.metadata &&
-          agent_schedules_version == o.agent_schedules_version &&
-          short_term_forecast == o.short_term_forecast &&
-          headcount_forecast == o.headcount_forecast &&
-          agent_update_filter == o.agent_update_filter
+          language == o.language &&
+          date_created == o.date_created &&
+          date_modified == o.date_modified &&
+          date_trained == o.date_trained &&
+          date_published == o.date_published &&
+          training_status == o.training_status &&
+          evaluation_status == o.evaluation_status &&
+          intents == o.intents &&
+          entity_types == o.entity_types &&
+          self_uri == o.self_uri
     end
 
     # @see the `==` method
@@ -337,7 +445,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [description, published, user_schedules, partial_upload_ids, metadata, agent_schedules_version, short_term_forecast, headcount_forecast, agent_update_filter].hash
+      [id, domain, description, language, date_created, date_modified, date_trained, date_published, training_status, evaluation_status, intents, entity_types, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/nlu_domain_version_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 NluDomainVersionListing
+    attr_accessor :entities
+
+    attr_accessor :page_size
+
+    attr_accessor :page_number
+
+    attr_accessor :total
+
+    attr_accessor :first_uri
+
+    attr_accessor :previous_uri
+
+    attr_accessor :self_uri
+
+    attr_accessor :next_uri
+
+    attr_accessor :last_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',
+        
+        :'previous_uri' => :'previousUri',
+        
+        :'self_uri' => :'selfUri',
+        
+        :'next_uri' => :'nextUri',
+        
+        :'last_uri' => :'lastUri',
+        
+        :'page_count' => :'pageCount'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'entities' => :'Array<NluDomainVersion>',
+        
+        :'page_size' => :'Integer',
+        
+        :'page_number' => :'Integer',
+        
+        :'total' => :'Integer',
+        
+        :'first_uri' => :'String',
+        
+        :'previous_uri' => :'String',
+        
+        :'self_uri' => :'String',
+        
+        :'next_uri' => :'String',
+        
+        :'last_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?(:'previousUri')
+        
+        
+        self.previous_uri = attributes[:'previousUri']
+        
+      
+      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?(:'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 &&
+          previous_uri == o.previous_uri &&
+          self_uri == o.self_uri &&
+          next_uri == o.next_uri &&
+          last_uri == o.last_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, previous_uri, self_uri, next_uri, last_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