purecloudplatformclientv2 22.0.0 → 23.0.0

data/lib/purecloudplatformclientv2/models/create_activity_code_request.rb

@@ -0,0 +1,358 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  # Activity Code
+  class CreateActivityCodeRequest
+    # The name of the activity code
+    attr_accessor :name
+
+    # The activity code's category
+    attr_accessor :category
+
+    # The default length of the activity in minutes
+    attr_accessor :length_in_minutes
+
+    # Whether an agent is paid while performing this activity
+    attr_accessor :counts_as_paid_time
+
+    # Indicates whether or not the activity should be counted as work time
+    attr_accessor :counts_as_work_time
+
+    # Whether an agent can select this activity code when creating or editing a time off request
+    attr_accessor :agent_time_off_selectable
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'name' => :'name',
+        
+        :'category' => :'category',
+        
+        :'length_in_minutes' => :'lengthInMinutes',
+        
+        :'counts_as_paid_time' => :'countsAsPaidTime',
+        
+        :'counts_as_work_time' => :'countsAsWorkTime',
+        
+        :'agent_time_off_selectable' => :'agentTimeOffSelectable'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'name' => :'String',
+        
+        :'category' => :'String',
+        
+        :'length_in_minutes' => :'Integer',
+        
+        :'counts_as_paid_time' => :'BOOLEAN',
+        
+        :'counts_as_work_time' => :'BOOLEAN',
+        
+        :'agent_time_off_selectable' => :'BOOLEAN'
+        
+      }
+    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?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'category')
+        
+        
+        self.category = attributes[:'category']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'lengthInMinutes')
+        
+        
+        self.length_in_minutes = attributes[:'lengthInMinutes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'countsAsPaidTime')
+        
+        
+        self.counts_as_paid_time = attributes[:'countsAsPaidTime']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'countsAsWorkTime')
+        
+        
+        self.counts_as_work_time = attributes[:'countsAsWorkTime']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'agentTimeOffSelectable')
+        
+        
+        self.agent_time_off_selectable = attributes[:'agentTimeOffSelectable']
+        
+      
+      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?
+      
+      
+      if @name.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @category.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @length_in_minutes.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @counts_as_paid_time.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @counts_as_work_time.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          name == o.name &&
+          category == o.category &&
+          length_in_minutes == o.length_in_minutes &&
+          counts_as_paid_time == o.counts_as_paid_time &&
+          counts_as_work_time == o.counts_as_work_time &&
+          agent_time_off_selectable == o.agent_time_off_selectable
+    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
+      [name, category, length_in_minutes, counts_as_paid_time, counts_as_work_time, agent_time_off_selectable].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/create_queue_request.rb

@@ -23,31 +23,34 @@ module PureCloud
 
     attr_accessor :name
 
-    # The resource's description.
+    # The queue description.
     attr_accessor :description
 
-    # The current version of the resource.
+    # The current version of the queue.
     attr_accessor :version
 
-    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The division to which this queue belongs.
+    attr_accessor :division
+
+    # The date the queue 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 of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
-    # The ID of the user that last modified the resource.
+    # The ID of the user that last modified the queue.
     attr_accessor :modified_by
 
-    # The ID of the user that created the resource.
+    # The ID of the user that created the queue.
     attr_accessor :created_by
 
-    # Indicates if the resource is active, inactive, or deleted.
+    # Indicates if the queue is active, inactive, or deleted.
     attr_accessor :state
 
-    # The application that last modified the resource.
+    # The application that last modified the queue.
     attr_accessor :modified_by_app
 
-    # The application that created the resource.
+    # The application that created the queue.
     attr_accessor :created_by_app
 
     # The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION
@@ -65,10 +68,10 @@ module PureCloud
     # The in-queue flow to use for conversations waiting in queue.
     attr_accessor :queue_flow
 
-    # The prompt used for whisper audio on the queue, if configured.
+    # ID of the whisper configured for this queue, if any.
     attr_accessor :whisper
 
-    # Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered.
+    # Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered.
     attr_accessor :auto_answer_only
 
     # The name to use for caller identification for outbound calls from this queue.
@@ -102,6 +105,8 @@ module PureCloud
         
         :'version' => :'version',
         
+        :'division' => :'division',
+        
         :'date_created' => :'dateCreated',
         
         :'date_modified' => :'dateModified',
@@ -159,6 +164,8 @@ module PureCloud
         
         :'version' => :'Integer',
         
+        :'division' => :'UriReference',
+        
         :'date_created' => :'DateTime',
         
         :'date_modified' => :'DateTime',
@@ -249,6 +256,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'division')
+        
+        
+        self.division = attributes[:'division']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'dateCreated')
         
         
@@ -486,6 +502,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -620,6 +640,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -737,6 +762,7 @@ module PureCloud
           name == o.name &&
           description == o.description &&
           version == o.version &&
+          division == o.division &&
           date_created == o.date_created &&
           date_modified == o.date_modified &&
           modified_by == o.modified_by &&
@@ -769,7 +795,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper, auto_answer_only, calling_party_name, calling_party_number, default_scripts, outbound_email_address, source_queue_id, member_count, self_uri].hash
+      [id, name, description, version, division, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper, auto_answer_only, calling_party_name, calling_party_number, default_scripts, outbound_email_address, source_queue_id, member_count, self_uri].hash
     end
 
     # build the object from hash