purecloud 0.28.0 → 0.29.1

data/lib/purecloud/models/interaction_stats_alert_container.rb

@@ -0,0 +1,238 @@
+require 'date'
+
+module PureCloud
+  class InteractionStatsAlertContainer
+    attr_accessor :page_size
+
+    attr_accessor :page_number
+
+    attr_accessor :total
+
+    attr_accessor :entities
+
+    attr_accessor :self_uri
+
+    attr_accessor :first_uri
+
+    attr_accessor :previous_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
+      {
+        
+        :'page_size' => :'pageSize',
+        
+        :'page_number' => :'pageNumber',
+        
+        :'total' => :'total',
+        
+        :'entities' => :'entities',
+        
+        :'self_uri' => :'selfUri',
+        
+        :'first_uri' => :'firstUri',
+        
+        :'previous_uri' => :'previousUri',
+        
+        :'next_uri' => :'nextUri',
+        
+        :'last_uri' => :'lastUri',
+        
+        :'page_count' => :'pageCount'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'page_size' => :'Integer',
+        :'page_number' => :'Integer',
+        :'total' => :'Integer',
+        :'entities' => :'Array<InteractionStatsAlert>',
+        :'self_uri' => :'String',
+        :'first_uri' => :'String',
+        :'previous_uri' => :'String',
+        :'next_uri' => :'String',
+        :'last_uri' => :'String',
+        :'page_count' => :'Integer'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'pageSize']
+        self.page_size = attributes[:'pageSize']
+      end
+      
+      if attributes[:'pageNumber']
+        self.page_number = attributes[:'pageNumber']
+      end
+      
+      if attributes[:'total']
+        self.total = attributes[:'total']
+      end
+      
+      if attributes[:'entities']
+        if (value = attributes[:'entities']).is_a?(Array)
+          self.entities = value
+        end
+      end
+      
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+      if attributes[:'firstUri']
+        self.first_uri = attributes[:'firstUri']
+      end
+      
+      if attributes[:'previousUri']
+        self.previous_uri = attributes[:'previousUri']
+      end
+      
+      if attributes[:'nextUri']
+        self.next_uri = attributes[:'nextUri']
+      end
+      
+      if attributes[:'lastUri']
+        self.last_uri = attributes[:'lastUri']
+      end
+      
+      if attributes[:'pageCount']
+        self.page_count = attributes[:'pageCount']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          page_size == o.page_size &&
+          page_number == o.page_number &&
+          total == o.total &&
+          entities == o.entities &&
+          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 &&
+          page_count == o.page_count
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [page_size, page_number, total, entities, self_uri, first_uri, previous_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 =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      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/purecloud/models/{alert.rb → interaction_stats_rule.rb}

@@ -1,37 +1,45 @@
 require 'date'
 
 module PureCloud
-  class Alert
+  class InteractionStatsRule
     # The globally unique identifier for the object.
     attr_accessor :id
 
+    # Name of the rule
     attr_accessor :name
 
-    attr_accessor :title
+    # The dimension of concern.
+    attr_accessor :dimension
 
-    attr_accessor :description
-
-    attr_accessor :unread
-
-    attr_accessor :entity
+    # The value of the dimension.
+    attr_accessor :dimension_value
 
+    # The metric to be assessed.
     attr_accessor :metric
 
-    attr_accessor :metric_thresholds
+    # The media type.
+    attr_accessor :media_type
 
-    attr_accessor :metric_value
+    # The comparison descriptor used against the metric's value.
+    attr_accessor :numeric_range
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :start_time
+    # The statistic of concern for the metric.
+    attr_accessor :statistic
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :end_time
+    # The threshold value.
+    attr_accessor :value
 
-    attr_accessor :media_type
+    # Indicates if the rule is enabled.
+    attr_accessor :enabled
 
-    attr_accessor :statistic
+    # Indicates if the rule is in alarm state.
+    attr_accessor :in_alarm
 
-    attr_accessor :rule_uri
+    # The ids of users who will be notified of alarm state change.
+    attr_accessor :notification_users
+
+    # A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL']
+    attr_accessor :alert_types
 
     # The URI for this object
     attr_accessor :self_uri
@@ -44,29 +52,27 @@ module PureCloud
         
         :'name' => :'name',
         
-        :'title' => :'title',
-        
-        :'description' => :'description',
-        
-        :'unread' => :'unread',
+        :'dimension' => :'dimension',
         
-        :'entity' => :'entity',
+        :'dimension_value' => :'dimensionValue',
         
         :'metric' => :'metric',
         
-        :'metric_thresholds' => :'metricThresholds',
+        :'media_type' => :'mediaType',
         
-        :'metric_value' => :'metricValue',
+        :'numeric_range' => :'numericRange',
         
-        :'start_time' => :'startTime',
+        :'statistic' => :'statistic',
         
-        :'end_time' => :'endTime',
+        :'value' => :'value',
         
-        :'media_type' => :'mediaType',
+        :'enabled' => :'enabled',
         
-        :'statistic' => :'statistic',
+        :'in_alarm' => :'inAlarm',
+        
+        :'notification_users' => :'notificationUsers',
         
-        :'rule_uri' => :'ruleUri',
+        :'alert_types' => :'alertTypes',
         
         :'self_uri' => :'selfUri'
         
@@ -78,18 +84,17 @@ module PureCloud
       {
         :'id' => :'String',
         :'name' => :'String',
-        :'title' => :'String',
-        :'description' => :'String',
-        :'unread' => :'BOOLEAN',
-        :'entity' => :'Entity',
+        :'dimension' => :'String',
+        :'dimension_value' => :'String',
         :'metric' => :'String',
-        :'metric_thresholds' => :'Array<MetricThreshold>',
-        :'metric_value' => :'Float',
-        :'start_time' => :'DateTime',
-        :'end_time' => :'DateTime',
         :'media_type' => :'String',
+        :'numeric_range' => :'String',
         :'statistic' => :'String',
-        :'rule_uri' => :'String',
+        :'value' => :'Float',
+        :'enabled' => :'BOOLEAN',
+        :'in_alarm' => :'BOOLEAN',
+        :'notification_users' => :'Array<User>',
+        :'alert_types' => :'Array<String>',
         :'self_uri' => :'String'
         
       }
@@ -110,56 +115,56 @@ module PureCloud
         self.name = attributes[:'name']
       end
       
-      if attributes[:'title']
-        self.title = attributes[:'title']
-      end
-      
-      if attributes[:'description']
-        self.description = attributes[:'description']
+      if attributes[:'dimension']
+        self.dimension = attributes[:'dimension']
       end
       
-      if attributes[:'unread']
-        self.unread = attributes[:'unread']
-      else
-        self.unread = false
-      end
-      
-      if attributes[:'entity']
-        self.entity = attributes[:'entity']
+      if attributes[:'dimensionValue']
+        self.dimension_value = attributes[:'dimensionValue']
       end
       
       if attributes[:'metric']
         self.metric = attributes[:'metric']
       end
       
-      if attributes[:'metricThresholds']
-        if (value = attributes[:'metricThresholds']).is_a?(Array)
-          self.metric_thresholds = value
-        end
+      if attributes[:'mediaType']
+        self.media_type = attributes[:'mediaType']
+      end
+      
+      if attributes[:'numericRange']
+        self.numeric_range = attributes[:'numericRange']
       end
       
-      if attributes[:'metricValue']
-        self.metric_value = attributes[:'metricValue']
+      if attributes[:'statistic']
+        self.statistic = attributes[:'statistic']
       end
       
-      if attributes[:'startTime']
-        self.start_time = attributes[:'startTime']
+      if attributes[:'value']
+        self.value = attributes[:'value']
       end
       
-      if attributes[:'endTime']
-        self.end_time = attributes[:'endTime']
+      if attributes[:'enabled']
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = false
       end
       
-      if attributes[:'mediaType']
-        self.media_type = attributes[:'mediaType']
+      if attributes[:'inAlarm']
+        self.in_alarm = attributes[:'inAlarm']
+      else
+        self.in_alarm = false
       end
       
-      if attributes[:'statistic']
-        self.statistic = attributes[:'statistic']
+      if attributes[:'notificationUsers']
+        if (value = attributes[:'notificationUsers']).is_a?(Array)
+          self.notification_users = value
+        end
       end
       
-      if attributes[:'ruleUri']
-        self.rule_uri = attributes[:'ruleUri']
+      if attributes[:'alertTypes']
+        if (value = attributes[:'alertTypes']).is_a?(Array)
+          self.alert_types = value
+        end
       end
       
       if attributes[:'selfUri']
@@ -168,18 +173,45 @@ module PureCloud
       
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    def dimension=(dimension)
+      allowed_values = ["queueId", "userId"]
+      if dimension && !allowed_values.include?(dimension)
+        fail "invalid value for 'dimension', must be one of #{allowed_values}"
+      end
+      @dimension = dimension
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def metric=(metric)
+      allowed_values = ["tAbandon", "tAnswered", "tTalk", "nOffered", "tHandle", "nTransferred", "oServiceLevel", "tWait", "tHeld", "tAcw"]
+      if metric && !allowed_values.include?(metric)
+        fail "invalid value for 'metric', must be one of #{allowed_values}"
+      end
+      @metric = metric
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     def media_type=(media_type)
-      allowed_values = ["VOICE", "CHAT"]
+      allowed_values = ["voice", "chat", "email"]
       if media_type && !allowed_values.include?(media_type)
         fail "invalid value for 'media_type', must be one of #{allowed_values}"
       end
       @media_type = media_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    def numeric_range=(numeric_range)
+      allowed_values = ["gt", "gte", "lt", "lte", "eq", "ne"]
+      if numeric_range && !allowed_values.include?(numeric_range)
+        fail "invalid value for 'numeric_range', must be one of #{allowed_values}"
+      end
+      @numeric_range = numeric_range
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     def statistic=(statistic)
-      allowed_values = ["COUNT", "SUM", "AVG", "RATIO"]
+      allowed_values = ["count", "min", "ratio", "max"]
       if statistic && !allowed_values.include?(statistic)
         fail "invalid value for 'statistic', must be one of #{allowed_values}"
       end
@@ -192,18 +224,17 @@ module PureCloud
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
-          title == o.title &&
-          description == o.description &&
-          unread == o.unread &&
-          entity == o.entity &&
+          dimension == o.dimension &&
+          dimension_value == o.dimension_value &&
           metric == o.metric &&
-          metric_thresholds == o.metric_thresholds &&
-          metric_value == o.metric_value &&
-          start_time == o.start_time &&
-          end_time == o.end_time &&
           media_type == o.media_type &&
+          numeric_range == o.numeric_range &&
           statistic == o.statistic &&
-          rule_uri == o.rule_uri &&
+          value == o.value &&
+          enabled == o.enabled &&
+          in_alarm == o.in_alarm &&
+          notification_users == o.notification_users &&
+          alert_types == o.alert_types &&
           self_uri == o.self_uri
     end
 
@@ -214,7 +245,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, name, title, description, unread, entity, metric, metric_thresholds, metric_value, start_time, end_time, media_type, statistic, rule_uri, self_uri].hash
+      [id, name, dimension, dimension_value, metric, media_type, numeric_range, statistic, value, enabled, in_alarm, notification_users, alert_types, self_uri].hash
     end
 
     # build the object from hash