purecloud 0.54.1 → 0.55.1

data/lib/purecloud/models/forecast_modification_creation.rb

@@ -0,0 +1,317 @@
+=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@inin.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 ForecastModificationCreation
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # The id of the associated forecast
+    attr_accessor :forecast_id
+
+    # The priority in which the modification is applied
+    attr_accessor :priority
+
+    # The metric the modification is appied to
+    attr_accessor :metric
+
+    # The type of modification
+    attr_accessor :modification_type
+
+    # The value of the modification
+    attr_accessor :modification_value
+
+    # The start of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :start_date
+
+    # The end of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :end_date
+
+    # The filters for the modification
+    attr_accessor :attributes
+
+    # Determined if the modification is currently applied
+    attr_accessor :enabled
+
+    # Any notes associated with the modification
+    attr_accessor :notes
+
+    # The URI for this object
+    attr_accessor :self_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'name' => :'name',
+        
+        :'forecast_id' => :'forecastId',
+        
+        :'priority' => :'priority',
+        
+        :'metric' => :'metric',
+        
+        :'modification_type' => :'modificationType',
+        
+        :'modification_value' => :'modificationValue',
+        
+        :'start_date' => :'startDate',
+        
+        :'end_date' => :'endDate',
+        
+        :'attributes' => :'attributes',
+        
+        :'enabled' => :'enabled',
+        
+        :'notes' => :'notes',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'forecast_id' => :'String',
+        :'priority' => :'Integer',
+        :'metric' => :'String',
+        :'modification_type' => :'String',
+        :'modification_value' => :'Float',
+        :'start_date' => :'DateTime',
+        :'end_date' => :'DateTime',
+        :'attributes' => :'ForecastFilterAttributes',
+        :'enabled' => :'BOOLEAN',
+        :'notes' => :'String',
+        :'self_uri' => :'String'
+        
+      }
+    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[:'id']
+        self.id = attributes[:'id']
+      end
+      
+      if attributes[:'name']
+        self.name = attributes[:'name']
+      end
+      
+      if attributes[:'forecastId']
+        self.forecast_id = attributes[:'forecastId']
+      end
+      
+      if attributes[:'priority']
+        self.priority = attributes[:'priority']
+      end
+      
+      if attributes[:'metric']
+        self.metric = attributes[:'metric']
+      end
+      
+      if attributes[:'modificationType']
+        self.modification_type = attributes[:'modificationType']
+      end
+      
+      if attributes[:'modificationValue']
+        self.modification_value = attributes[:'modificationValue']
+      end
+      
+      if attributes[:'startDate']
+        self.start_date = attributes[:'startDate']
+      end
+      
+      if attributes[:'endDate']
+        self.end_date = attributes[:'endDate']
+      end
+      
+      if attributes[:'attributes']
+        self.attributes = attributes[:'attributes']
+      end
+      
+      if attributes[:'enabled']
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = false
+      end
+      
+      if attributes[:'notes']
+        self.notes = attributes[:'notes']
+      end
+      
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def metric=(metric)
+      allowed_values = ["CALL_VOLUME", "ATT", "ACW", "CHAT_VOLUME"]
+      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 modification_type=(modification_type)
+      allowed_values = ["MINIMUM_PER_INTERVAL", "MAXIMUM_PER_INTERVAL", "SET_VALUE_PER_INTERVAL", "CHANGE_VALUE_PER_INTERVAL", "CHANGE_PERCENT_PER_INTERVAL", "SET_VALUE_OVER_RANGE", "CHANGE_VALUE_OVER_RANGE"]
+      if modification_type && !allowed_values.include?(modification_type)
+        fail "invalid value for 'modification_type', must be one of #{allowed_values}"
+      end
+      @modification_type = modification_type
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
+          forecast_id == o.forecast_id &&
+          priority == o.priority &&
+          metric == o.metric &&
+          modification_type == o.modification_type &&
+          modification_value == o.modification_value &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          attributes == o.attributes &&
+          enabled == o.enabled &&
+          notes == o.notes &&
+          self_uri == o.self_uri
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [id, name, forecast_id, priority, metric, modification_type, modification_value, start_date, end_date, attributes, enabled, notes, self_uri].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/purecloud/models/forecast_search_criteria.rb

@@ -0,0 +1,267 @@
+=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@inin.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 ForecastSearchCriteria
+    # The end value of the range. This field is used for range search types.
+    attr_accessor :end_value
+
+    # A list of values for the search to match against
+    attr_accessor :values
+
+    # The start value of the range. This field is used for range search types.
+    attr_accessor :start_value
+
+    # Field names to search against
+    attr_accessor :fields
+
+    # A value for the search to match against
+    attr_accessor :value
+
+    # How to apply this search criteria against other criteria
+    attr_accessor :operator
+
+    # Groups multiple conditions
+    attr_accessor :group
+
+    # Search Type
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'end_value' => :'endValue',
+        
+        :'values' => :'values',
+        
+        :'start_value' => :'startValue',
+        
+        :'fields' => :'fields',
+        
+        :'value' => :'value',
+        
+        :'operator' => :'operator',
+        
+        :'group' => :'group',
+        
+        :'type' => :'type'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'end_value' => :'String',
+        :'values' => :'Array<String>',
+        :'start_value' => :'String',
+        :'fields' => :'Array<String>',
+        :'value' => :'String',
+        :'operator' => :'String',
+        :'group' => :'Array<ForecastSearchCriteria>',
+        :'type' => :'String'
+        
+      }
+    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[:'endValue']
+        self.end_value = attributes[:'endValue']
+      end
+      
+      if attributes[:'values']
+        if (value = attributes[:'values']).is_a?(Array)
+          self.values = value
+        end
+      end
+      
+      if attributes[:'startValue']
+        self.start_value = attributes[:'startValue']
+      end
+      
+      if attributes[:'fields']
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
+        end
+      end
+      
+      if attributes[:'value']
+        self.value = attributes[:'value']
+      end
+      
+      if attributes[:'operator']
+        self.operator = attributes[:'operator']
+      end
+      
+      if attributes[:'group']
+        if (value = attributes[:'group']).is_a?(Array)
+          self.group = value
+        end
+      end
+      
+      if attributes[:'type']
+        self.type = attributes[:'type']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def operator=(operator)
+      allowed_values = ["AND", "OR", "NOT"]
+      if operator && !allowed_values.include?(operator)
+        fail "invalid value for 'operator', must be one of #{allowed_values}"
+      end
+      @operator = operator
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def type=(type)
+      allowed_values = ["EXACT", "CONTAINS", "STARTS_WITH", "REQUIRED_FIELDS", "RANGE", "DATE_RANGE", "LESS_THAN", "LESS_THAN_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "TERM", "TERMS"]
+      if type && !allowed_values.include?(type)
+        fail "invalid value for 'type', must be one of #{allowed_values}"
+      end
+      @type = type
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          end_value == o.end_value &&
+          values == o.values &&
+          start_value == o.start_value &&
+          fields == o.fields &&
+          value == o.value &&
+          operator == o.operator &&
+          group == o.group &&
+          type == o.type
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [end_value, values, start_value, fields, value, operator, group, type].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