purecloudplatformclientv2 85.0.1 → 86.0.0

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

@@ -17,37 +17,42 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  # Short Term Forecast
-  class ShortTermForecast
+  class NluDomainVersion
     # The globally unique identifier for the object.
     attr_accessor :id
 
-    # The URI for this object
-    attr_accessor :self_uri
-
-    # The weekDate of the short term forecast in yyyy-MM-dd format
-    attr_accessor :week_date
+    # The NLU domain of the version.
+    attr_accessor :domain
 
-    # The description of the short term forecast
+    # The description of the NLU domain version.
     attr_accessor :description
 
-    # The method used to create this forecast
-    attr_accessor :creation_method
+    # 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
+
+    # 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
 
-    # Metadata for this forecast
-    attr_accessor :metadata
+    # 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
 
-    # The source data references and metadata for this forecast
-    attr_accessor :source_data
+    # 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
 
-    # ISO-8601 date that serves as the reference date for interval-based modifications
-    attr_accessor :reference_start_date
+    # The training status of the NLU domain version.
+    attr_accessor :training_status
 
-    # The modifications that have been applied to this forecast
-    attr_accessor :modifications
+    # The intents defined for this NLU domain version.
+    attr_accessor :intents
 
-    # Forecast generation results, if applicable
-    attr_accessor :generation_results
+    # 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
@@ -55,23 +60,27 @@ module PureCloud
         
         :'id' => :'id',
         
-        :'self_uri' => :'selfUri',
-        
-        :'week_date' => :'weekDate',
+        :'domain' => :'domain',
         
         :'description' => :'description',
         
-        :'creation_method' => :'creationMethod',
+        :'language' => :'language',
+        
+        :'date_created' => :'dateCreated',
         
-        :'metadata' => :'metadata',
+        :'date_modified' => :'dateModified',
         
-        :'source_data' => :'sourceData',
+        :'date_trained' => :'dateTrained',
         
-        :'reference_start_date' => :'referenceStartDate',
+        :'date_published' => :'datePublished',
         
-        :'modifications' => :'modifications',
+        :'training_status' => :'trainingStatus',
         
-        :'generation_results' => :'generationResults'
+        :'intents' => :'intents',
+        
+        :'entity_types' => :'entityTypes',
+        
+        :'self_uri' => :'selfUri'
         
       }
     end
@@ -82,23 +91,27 @@ module PureCloud
         
         :'id' => :'String',
         
-        :'self_uri' => :'String',
-        
-        :'week_date' => :'String',
+        :'domain' => :'NluDomain',
         
         :'description' => :'String',
         
-        :'creation_method' => :'String',
+        :'language' => :'String',
+        
+        :'date_created' => :'DateTime',
+        
+        :'date_modified' => :'DateTime',
         
-        :'metadata' => :'WfmVersionedEntityMetadata',
+        :'date_trained' => :'DateTime',
         
-        :'source_data' => :'ListWrapperForecastSourceDayPointer',
+        :'date_published' => :'DateTime',
         
-        :'reference_start_date' => :'DateTime',
+        :'training_status' => :'String',
         
-        :'modifications' => :'ListWrapperWfmForecastModification',
+        :'intents' => :'Array<IntentDefinition>',
         
-        :'generation_results' => :'ForecastGenerationResult'
+        :'entity_types' => :'Array<NamedEntityTypeDefinition>',
+        
+        :'self_uri' => :'String'
         
       }
     end
@@ -121,82 +134,104 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'domain')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.domain = attributes[:'domain']
         
       
       end
 
       
-      if attributes.has_key?(:'weekDate')
+      if attributes.has_key?(:'description')
         
         
-        self.week_date = attributes[:'weekDate']
+        self.description = attributes[:'description']
         
       
       end
 
       
-      if attributes.has_key?(:'description')
+      if attributes.has_key?(:'language')
         
         
-        self.description = attributes[:'description']
+        self.language = attributes[:'language']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'dateCreated')
+        
+        
+        self.date_created = attributes[:'dateCreated']
         
       
       end
 
       
-      if attributes.has_key?(:'creationMethod')
+      if attributes.has_key?(:'dateModified')
         
         
-        self.creation_method = attributes[:'creationMethod']
+        self.date_modified = attributes[:'dateModified']
         
       
       end
 
       
-      if attributes.has_key?(:'metadata')
+      if attributes.has_key?(:'dateTrained')
         
         
-        self.metadata = attributes[:'metadata']
+        self.date_trained = attributes[:'dateTrained']
         
       
       end
 
       
-      if attributes.has_key?(:'sourceData')
+      if attributes.has_key?(:'datePublished')
         
         
-        self.source_data = attributes[:'sourceData']
+        self.date_published = attributes[:'datePublished']
         
       
       end
 
       
-      if attributes.has_key?(:'referenceStartDate')
+      if attributes.has_key?(:'trainingStatus')
+        
+        
+        self.training_status = attributes[:'trainingStatus']
         
+      
+      end
+
+      
+      if attributes.has_key?(:'intents')
+        
+        if (value = attributes[:'intents']).is_a?(Array)
+          self.intents = value
+        end
         
-        self.reference_start_date = attributes[:'referenceStartDate']
         
       
       end
 
       
-      if attributes.has_key?(:'modifications')
+      if attributes.has_key?(:'entityTypes')
         
+        if (value = attributes[:'entityTypes']).is_a?(Array)
+          self.entity_types = value
+        end
         
-        self.modifications = attributes[:'modifications']
         
       
       end
 
       
-      if attributes.has_key?(:'generationResults')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.generation_results = attributes[:'generationResults']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
@@ -226,10 +261,6 @@ module PureCloud
       
       
       
-      if @week_date.nil?
-        return false
-      end
-
       
       
       
@@ -240,23 +271,25 @@ module PureCloud
       
       
       
-      allowed_values = ["Import", "HistoricalWeightedAverage", "Advanced"]
-      if @creation_method && !allowed_values.include?(@creation_method)
-        return false
-      end
       
       
       
       
-      if @metadata.nil?
-        return false
-      end
-
       
       
       
       
       
+      
+      
+      
+      
+      
+      
+      allowed_values = ["Untrained", "Training", "Trained", "Error", "Unknown"]
+      if @training_status && !allowed_values.include?(@training_status)
+        return false
+      end
       
       
       
@@ -296,16 +329,6 @@ module PureCloud
     
     
     
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] creation_method Object to be assigned
-    def creation_method=(creation_method)
-      allowed_values = ["Import", "HistoricalWeightedAverage", "Advanced"]
-      if creation_method && !allowed_values.include?(creation_method)
-        fail ArgumentError, "invalid value for 'creation_method', must be one of #{allowed_values}."
-      end
-      @creation_method = creation_method
-    end
-
     
     
     
@@ -316,6 +339,26 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @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
+      @training_status = training_status
+    end
+
     
     
     
@@ -340,15 +383,17 @@ module PureCloud
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          self_uri == o.self_uri &&
-          week_date == o.week_date &&
+          domain == o.domain &&
           description == o.description &&
-          creation_method == o.creation_method &&
-          metadata == o.metadata &&
-          source_data == o.source_data &&
-          reference_start_date == o.reference_start_date &&
-          modifications == o.modifications &&
-          generation_results == o.generation_results
+          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 &&
+          intents == o.intents &&
+          entity_types == o.entity_types &&
+          self_uri == o.self_uri
     end
 
     # @see the `==` method
@@ -360,7 +405,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, self_uri, week_date, description, creation_method, metadata, source_data, reference_start_date, modifications, generation_results].hash
+      [id, domain, description, language, date_created, date_modified, date_trained, date_published, training_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 :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<NluDomainVersion>',
+        
+        :'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