purecloudplatformclientv2 24.0.0 → 25.0.0

data/lib/purecloudplatformclientv2/models/question.rb

@@ -26,21 +26,24 @@ module PureCloud
 
     attr_accessor :type
 
-    attr_accessor :weight
-
-    attr_accessor :na_required
+    attr_accessor :na_enabled
 
     attr_accessor :comments_required
 
-    attr_accessor :is_kill
+    attr_accessor :visibility_condition
 
-    attr_accessor :is_critical
+    # Options from which to choose an answer for this question. Only used by Multiple Choice type questions.
+    attr_accessor :answer_options
 
-    attr_accessor :na_enabled
+    # How many characters are allowed in the text response to this question. Used by NPS and Free Text question types.
+    attr_accessor :max_response_characters
 
-    attr_accessor :visibility_condition
+    # Prompt for details explaining the chosen NPS score. Used by NPS questions.
+    attr_accessor :explanation_prompt
 
-    attr_accessor :answer_options
+    attr_accessor :is_kill
+
+    attr_accessor :is_critical
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -54,21 +57,21 @@ module PureCloud
         
         :'type' => :'type',
         
-        :'weight' => :'weight',
-        
-        :'na_required' => :'naRequired',
+        :'na_enabled' => :'naEnabled',
         
         :'comments_required' => :'commentsRequired',
         
-        :'is_kill' => :'isKill',
+        :'visibility_condition' => :'visibilityCondition',
         
-        :'is_critical' => :'isCritical',
+        :'answer_options' => :'answerOptions',
         
-        :'na_enabled' => :'naEnabled',
+        :'max_response_characters' => :'maxResponseCharacters',
         
-        :'visibility_condition' => :'visibilityCondition',
+        :'explanation_prompt' => :'explanationPrompt',
+        
+        :'is_kill' => :'isKill',
         
-        :'answer_options' => :'answerOptions'
+        :'is_critical' => :'isCritical'
         
       }
     end
@@ -85,21 +88,21 @@ module PureCloud
         
         :'type' => :'String',
         
-        :'weight' => :'Float',
-        
-        :'na_required' => :'BOOLEAN',
+        :'na_enabled' => :'BOOLEAN',
         
         :'comments_required' => :'BOOLEAN',
         
-        :'is_kill' => :'BOOLEAN',
+        :'visibility_condition' => :'VisibilityCondition',
         
-        :'is_critical' => :'BOOLEAN',
+        :'answer_options' => :'Array<AnswerOption>',
         
-        :'na_enabled' => :'BOOLEAN',
+        :'max_response_characters' => :'Integer',
         
-        :'visibility_condition' => :'VisibilityCondition',
+        :'explanation_prompt' => :'String',
+        
+        :'is_kill' => :'BOOLEAN',
         
-        :'answer_options' => :'Array<AnswerOption>'
+        :'is_critical' => :'BOOLEAN'
         
       }
     end
@@ -149,75 +152,75 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'weight')
+      if attributes.has_key?(:'naEnabled')
         
         
-        self.weight = attributes[:'weight']
+        self.na_enabled = attributes[:'naEnabled']
         
       
       end
 
       
-      if attributes.has_key?(:'naRequired')
+      if attributes.has_key?(:'commentsRequired')
         
         
-        self.na_required = attributes[:'naRequired']
+        self.comments_required = attributes[:'commentsRequired']
         
       
       end
 
       
-      if attributes.has_key?(:'commentsRequired')
+      if attributes.has_key?(:'visibilityCondition')
         
         
-        self.comments_required = attributes[:'commentsRequired']
+        self.visibility_condition = attributes[:'visibilityCondition']
         
       
       end
 
       
-      if attributes.has_key?(:'isKill')
+      if attributes.has_key?(:'answerOptions')
         
+        if (value = attributes[:'answerOptions']).is_a?(Array)
+          self.answer_options = value
+        end
         
-        self.is_kill = attributes[:'isKill']
         
       
       end
 
       
-      if attributes.has_key?(:'isCritical')
+      if attributes.has_key?(:'maxResponseCharacters')
         
         
-        self.is_critical = attributes[:'isCritical']
+        self.max_response_characters = attributes[:'maxResponseCharacters']
         
       
       end
 
       
-      if attributes.has_key?(:'naEnabled')
+      if attributes.has_key?(:'explanationPrompt')
         
         
-        self.na_enabled = attributes[:'naEnabled']
+        self.explanation_prompt = attributes[:'explanationPrompt']
         
       
       end
 
       
-      if attributes.has_key?(:'visibilityCondition')
+      if attributes.has_key?(:'isKill')
         
         
-        self.visibility_condition = attributes[:'visibilityCondition']
+        self.is_kill = attributes[:'isKill']
         
       
       end
 
       
-      if attributes.has_key?(:'answerOptions')
+      if attributes.has_key?(:'isCritical')
         
-        if (value = attributes[:'answerOptions']).is_a?(Array)
-          self.answer_options = value
-        end
         
+        self.is_critical = attributes[:'isCritical']
         
       
       end
@@ -252,6 +255,11 @@ module PureCloud
       
       
       
+      allowed_values = ["multipleChoiceQuestion", "freeTextQuestion", "npsQuestion", "readOnlyTextBlockQuestion"]
+      if @type && !allowed_values.include?(@type)
+        return false
+      end
+      
       
       
       
@@ -305,7 +313,16 @@ module PureCloud
     
     
     
-    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      allowed_values = ["multipleChoiceQuestion", "freeTextQuestion", "npsQuestion", "readOnlyTextBlockQuestion"]
+      if type && !allowed_values.include?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
+      end
+      @type = type
+    end
+
     
     
     
@@ -358,14 +375,14 @@ module PureCloud
           text == o.text &&
           help_text == o.help_text &&
           type == o.type &&
-          weight == o.weight &&
-          na_required == o.na_required &&
-          comments_required == o.comments_required &&
-          is_kill == o.is_kill &&
-          is_critical == o.is_critical &&
           na_enabled == o.na_enabled &&
+          comments_required == o.comments_required &&
           visibility_condition == o.visibility_condition &&
-          answer_options == o.answer_options
+          answer_options == o.answer_options &&
+          max_response_characters == o.max_response_characters &&
+          explanation_prompt == o.explanation_prompt &&
+          is_kill == o.is_kill &&
+          is_critical == o.is_critical
     end
 
     # @see the `==` method
@@ -377,7 +394,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, text, help_text, type, weight, na_required, comments_required, is_kill, is_critical, na_enabled, visibility_condition, answer_options].hash
+      [id, text, help_text, type, na_enabled, comments_required, visibility_condition, answer_options, max_response_characters, explanation_prompt, is_kill, is_critical].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb

@@ -26,16 +26,16 @@ module PureCloud
 
     attr_accessor :total
 
+    attr_accessor :self_uri
+
+    attr_accessor :first_uri
+
     attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :self_uri
-
-    attr_accessor :first_uri
-
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,16 +50,16 @@ module PureCloud
         
         :'total' => :'total',
         
+        :'self_uri' => :'selfUri',
+        
+        :'first_uri' => :'firstUri',
+        
         :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
         :'last_uri' => :'lastUri',
         
-        :'self_uri' => :'selfUri',
-        
-        :'first_uri' => :'firstUri',
-        
         :'page_count' => :'pageCount'
         
       }
@@ -77,16 +77,16 @@ module PureCloud
         
         :'total' => :'Integer',
         
+        :'self_uri' => :'String',
+        
+        :'first_uri' => :'String',
+        
         :'previous_uri' => :'String',
         
         :'next_uri' => :'String',
         
         :'last_uri' => :'String',
         
-        :'self_uri' => :'String',
-        
-        :'first_uri' => :'String',
-        
         :'page_count' => :'Integer'
         
       }
@@ -139,46 +139,46 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'firstUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.first_uri = attributes[:'firstUri']
         
       
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'firstUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.first_uri = attributes[:'firstUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -310,11 +310,11 @@ module PureCloud
           page_size == o.page_size &&
           page_number == o.page_number &&
           total == o.total &&
+          self_uri == o.self_uri &&
+          first_uri == o.first_uri &&
           previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
           last_uri == o.last_uri &&
-          self_uri == o.self_uri &&
-          first_uri == o.first_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, previous_uri, next_uri, last_uri, self_uri, first_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb

@@ -26,16 +26,16 @@ module PureCloud
 
     attr_accessor :total
 
+    attr_accessor :self_uri
+
+    attr_accessor :first_uri
+
     attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :self_uri
-
-    attr_accessor :first_uri
-
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,16 +50,16 @@ module PureCloud
         
         :'total' => :'total',
         
+        :'self_uri' => :'selfUri',
+        
+        :'first_uri' => :'firstUri',
+        
         :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
         :'last_uri' => :'lastUri',
         
-        :'self_uri' => :'selfUri',
-        
-        :'first_uri' => :'firstUri',
-        
         :'page_count' => :'pageCount'
         
       }
@@ -77,16 +77,16 @@ module PureCloud
         
         :'total' => :'Integer',
         
+        :'self_uri' => :'String',
+        
+        :'first_uri' => :'String',
+        
         :'previous_uri' => :'String',
         
         :'next_uri' => :'String',
         
         :'last_uri' => :'String',
         
-        :'self_uri' => :'String',
-        
-        :'first_uri' => :'String',
-        
         :'page_count' => :'Integer'
         
       }
@@ -139,46 +139,46 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'firstUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.first_uri = attributes[:'firstUri']
         
       
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'firstUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.first_uri = attributes[:'firstUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -310,11 +310,11 @@ module PureCloud
           page_size == o.page_size &&
           page_number == o.page_number &&
           total == o.total &&
+          self_uri == o.self_uri &&
+          first_uri == o.first_uri &&
           previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
           last_uri == o.last_uri &&
-          self_uri == o.self_uri &&
-          first_uri == o.first_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, previous_uri, next_uri, last_uri, self_uri, first_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash