purecloudplatformclientv2 17.0.0 → 18.0.0

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -1556,8 +1556,8 @@ module PureCloud
       
       
       
-      if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
-        fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
+      if opts[:'state'] && !['active', 'inactive', 'deleted'].include?(opts[:'state'])
+        fail ArgumentError, 'invalid value for "state", must be one of active, inactive, deleted'
       end
       
       

data/lib/purecloudplatformclientv2/api_client.rb

@@ -76,7 +76,7 @@ module PureCloud
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
-      header_params['purecloud-sdk'] = '17.0.0'
+      header_params['purecloud-sdk'] = '18.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/analytics_conversation.rb

@@ -18,16 +18,19 @@ require 'date'
 
 module PureCloud
   class AnalyticsConversation
+    # Unique identifier for the conversation
     attr_accessor :conversation_id
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :conversation_start
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :conversation_end
 
+    # Participants in the conversation
     attr_accessor :participants
 
+    # Evaluations tied to this conersation
     attr_accessor :evaluations
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb

@@ -18,30 +18,36 @@ require 'date'
 
 module PureCloud
   class AnalyticsConversationSegment
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :segment_start
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :segment_end
 
+    # Queue identifier
     attr_accessor :queue_id
 
+    # Wrapup Code id
     attr_accessor :wrap_up_code
 
+    # Note entered by an agent during after-call work
     attr_accessor :wrap_up_note
 
     attr_accessor :wrap_up_tags
 
     attr_accessor :error_code
 
+    # A description of the event that disconnected the segment
     attr_accessor :disconnect_type
 
+    # The activity taking place for the participant in the segment
     attr_accessor :segment_type
 
     attr_accessor :requested_routing_user_ids
 
     attr_accessor :requested_routing_skill_ids
 
+    # A unique identifier for the language requested for an interaction.
     attr_accessor :requested_language_id
 
     attr_accessor :properties
@@ -58,6 +64,7 @@ module PureCloud
 
     attr_accessor :q850_response_codes
 
+    # Indicates whether the segment was a conference
     attr_accessor :conference
 
     attr_accessor :group_id

data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb

@@ -18,24 +18,34 @@ require 'date'
 
 module PureCloud
   class AnalyticsEvaluation
+    # Unique identifier for the evaluation
     attr_accessor :evaluation_id
 
+    # A unique identifier of the PureCloud user who evaluated the interaction
     attr_accessor :evaluator_id
 
+    # Unique identifier for the user being evaluated
     attr_accessor :user_id
 
+    # Specifies when an evaluation occurred
     attr_accessor :event_time
 
+    # Unique identifier for the queue the conversation was on
     attr_accessor :queue_id
 
+    # Unique identifier for the form used to evaluate the conversation/agent
     attr_accessor :form_id
 
+    # A unique identifier for an evaluation form, regardless of version
     attr_accessor :context_id
 
+    # Name of the evaluation form
     attr_accessor :form_name
 
+    # The total evaluation for interactions
     attr_accessor :geto_total_score
 
+    # The score for critical evaluation questions
     attr_accessor :geto_total_critical_score
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloudplatformclientv2/models/analytics_participant.rb

@@ -18,18 +18,25 @@ require 'date'
 
 module PureCloud
   class AnalyticsParticipant
+    # Unique identifier for the participant
     attr_accessor :participant_id
 
+    # A human readable name identifying the participant
     attr_accessor :participant_name
 
+    # If a user, then this will be the unique identifier for the user
     attr_accessor :user_id
 
+    # The participant's purpose
     attr_accessor :purpose
 
+    # External Contact Identifier
     attr_accessor :external_contact_id
 
+    # External Organization Identifier
     attr_accessor :external_organization_id
 
+    # List of sessions associated to this participant
     attr_accessor :sessions
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloudplatformclientv2/models/analytics_session.rb

@@ -18,69 +18,95 @@ require 'date'
 
 module PureCloud
   class AnalyticsSession
+    # The session media type
     attr_accessor :media_type
 
+    # The unique identifier of this session
     attr_accessor :session_id
 
     attr_accessor :address_other
 
     attr_accessor :address_self
 
+    # Automatic Number Identification (caller's number)
     attr_accessor :ani
 
+    # Direction
     attr_accessor :direction
 
+    # Automatic Number Identification (caller's number)
     attr_accessor :dnis
 
+    # (Dialer) Unique identifier of the outbound campaign
     attr_accessor :outbound_campaign_id
 
+    # (Dialer) Unique identifier of the contact
     attr_accessor :outbound_contact_id
 
+    # (Dialer) Unique identifier of the contact list that this contact belongs to
     attr_accessor :outbound_contact_list_id
 
+    # (Dialer) Unique identifier of the contact list that this contact belongs to
     attr_accessor :disposition_analyzer
 
+    # (Dialer) Result of the analysis (for example disposition.classification.callable.machine) 
     attr_accessor :disposition_name
 
+    # Unique identifier of the edge device
     attr_accessor :edge_id
 
     attr_accessor :remote_name_displayable
 
+    # Unique identifier for the room
     attr_accessor :room_id
 
+    # The sessionID being monitored
     attr_accessor :monitored_session_id
 
     attr_accessor :monitored_participant_id
 
+    # The name of the user requesting a call back
     attr_accessor :callback_user_name
 
+    # List of numbers to callback
     attr_accessor :callback_numbers
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :callback_scheduled_time
 
+    # Scheduled callback date/time, Date time is represented as an ISO-8601 string. 
     attr_accessor :script_id
 
+    # (Dialer) Whether the agent can skip the dialer contact
     attr_accessor :skip_enabled
 
+    # The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling
     attr_accessor :timeout_seconds
 
+    # Describe side of the cobrowse (sharer or viewer)
     attr_accessor :cobrowse_role
 
+    # A unique identifier for a PureCloud Cobrowse room.
     attr_accessor :cobrowse_room_id
 
     attr_accessor :media_bridge_id
 
+    # Direct ScreenShare address
     attr_accessor :screen_share_address_self
 
+    # Flag determining if screenShare is started or not (true/false)
     attr_accessor :sharing_screen
 
+    # A unique identifier for a PureCloud ScreenShare room.
     attr_accessor :screen_share_room_id
 
+    # A unique identifier for a PureCloud video room.
     attr_accessor :video_room_id
 
+    # Direct Video address
     attr_accessor :video_address_self
 
+    # List of segments for this session
     attr_accessor :segments
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -597,6 +623,11 @@ module PureCloud
       
       
       
+      allowed_values = ["disconnect", "person", "busy", "machine", "noanswer", "fax", "sit"]
+      if @disposition_name && !allowed_values.include?(@disposition_name)
+        return false
+      end
+      
       
       
       
@@ -756,7 +787,16 @@ module PureCloud
     
     
     
-    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] disposition_name Object to be assigned
+    def disposition_name=(disposition_name)
+      allowed_values = ["disconnect", "person", "busy", "machine", "noanswer", "fax", "sit"]
+      if disposition_name && !allowed_values.include?(disposition_name)
+        fail ArgumentError, "invalid value for 'disposition_name', must be one of #{allowed_values}."
+      end
+      @disposition_name = disposition_name
+    end
+
     
     
     

data/lib/purecloudplatformclientv2/models/billing_usage.rb

@@ -0,0 +1,271 @@
+=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
+  class BillingUsage
+    # Identifies the billable usage.
+    attr_accessor :name
+
+    # The total amount of usage, expressed as a decimal number in string format.
+    attr_accessor :total_usage
+
+    # The resources for which usage was observed (e.g. license users, devices).
+    attr_accessor :resources
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'name' => :'name',
+        
+        :'total_usage' => :'totalUsage',
+        
+        :'resources' => :'resources'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'name' => :'String',
+        
+        :'total_usage' => :'String',
+        
+        :'resources' => :'Array<BillingUsageResource>'
+        
+      }
+    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?(:'totalUsage')
+        
+        
+        self.total_usage = attributes[:'totalUsage']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'resources')
+        
+        if (value = attributes[:'resources']).is_a?(Array)
+          self.resources = value
+        end
+        
+        
+      
+      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 @total_usage.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @resources.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 &&
+          total_usage == o.total_usage &&
+          resources == o.resources
+    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, total_usage, resources].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