purecloud 0.54.1 → 0.55.1

data/lib/purecloud/models/forecast_entry.rb

@@ -0,0 +1,199 @@
+=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 ForecastEntry
+    # The metric of the entry
+    attr_accessor :metric
+
+    # The dimensions of the entry
+    attr_accessor :dimensions
+
+    # The forecasted values
+    attr_accessor :values
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'metric' => :'metric',
+        
+        :'dimensions' => :'dimensions',
+        
+        :'values' => :'values'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'metric' => :'String',
+        :'dimensions' => :'ForecastDimensions',
+        :'values' => :'Array<Float>'
+        
+      }
+    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[:'metric']
+        self.metric = attributes[:'metric']
+      end
+      
+      if attributes[:'dimensions']
+        self.dimensions = attributes[:'dimensions']
+      end
+      
+      if attributes[:'values']
+        if (value = attributes[:'values']).is_a?(Array)
+          self.values = value
+        end
+      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
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          metric == o.metric &&
+          dimensions == o.dimensions &&
+          values == o.values
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [metric, dimensions, values].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_filter_attributes.rb

@@ -0,0 +1,191 @@
+=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 ForecastFilterAttributes
+    attr_accessor :languages
+
+    attr_accessor :queue_ids
+
+    attr_accessor :media_types
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'languages' => :'languages',
+        
+        :'queue_ids' => :'queueIds',
+        
+        :'media_types' => :'mediaTypes'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'languages' => :'Array<String>',
+        :'queue_ids' => :'Array<String>',
+        :'media_types' => :'Array<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[:'languages']
+        if (value = attributes[:'languages']).is_a?(Array)
+          self.languages = value
+        end
+      end
+      
+      if attributes[:'queueIds']
+        if (value = attributes[:'queueIds']).is_a?(Array)
+          self.queue_ids = value
+        end
+      end
+      
+      if attributes[:'mediaTypes']
+        if (value = attributes[:'mediaTypes']).is_a?(Array)
+          self.media_types = value
+        end
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          languages == o.languages &&
+          queue_ids == o.queue_ids &&
+          media_types == o.media_types
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [languages, queue_ids, media_types].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_metadata.rb

@@ -0,0 +1,284 @@
+=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 ForecastMetadata
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # The number of periods to be forecasted for
+    attr_accessor :number_of_periods
+
+    # The frequency of the period
+    attr_accessor :period_frequency
+
+    # The description of the forecast to be created
+    attr_accessor :description
+
+    # The metrics the forecast is for
+    attr_accessor :metrics
+
+    # The last modified date time of this object. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :last_modified_date
+
+    # The person who last modified this object
+    attr_accessor :last_modified_by
+
+    # The status of the creation of the forecast
+    attr_accessor :status
+
+    # 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',
+        
+        :'number_of_periods' => :'numberOfPeriods',
+        
+        :'period_frequency' => :'periodFrequency',
+        
+        :'description' => :'description',
+        
+        :'metrics' => :'metrics',
+        
+        :'last_modified_date' => :'lastModifiedDate',
+        
+        :'last_modified_by' => :'lastModifiedBy',
+        
+        :'status' => :'status',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'number_of_periods' => :'Integer',
+        :'period_frequency' => :'String',
+        :'description' => :'String',
+        :'metrics' => :'Array<String>',
+        :'last_modified_date' => :'DateTime',
+        :'last_modified_by' => :'User',
+        :'status' => :'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[:'numberOfPeriods']
+        self.number_of_periods = attributes[:'numberOfPeriods']
+      end
+      
+      if attributes[:'periodFrequency']
+        self.period_frequency = attributes[:'periodFrequency']
+      end
+      
+      if attributes[:'description']
+        self.description = attributes[:'description']
+      end
+      
+      if attributes[:'metrics']
+        if (value = attributes[:'metrics']).is_a?(Array)
+          self.metrics = value
+        end
+      end
+      
+      if attributes[:'lastModifiedDate']
+        self.last_modified_date = attributes[:'lastModifiedDate']
+      end
+      
+      if attributes[:'lastModifiedBy']
+        self.last_modified_by = attributes[:'lastModifiedBy']
+      end
+      
+      if attributes[:'status']
+        self.status = attributes[:'status']
+      end
+      
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def period_frequency=(period_frequency)
+      allowed_values = ["WEEK"]
+      if period_frequency && !allowed_values.include?(period_frequency)
+        fail "invalid value for 'period_frequency', must be one of #{allowed_values}"
+      end
+      @period_frequency = period_frequency
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def status=(status)
+      allowed_values = ["SUCCESS", "FAILED"]
+      if status && !allowed_values.include?(status)
+        fail "invalid value for 'status', must be one of #{allowed_values}"
+      end
+      @status = status
+    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 &&
+          number_of_periods == o.number_of_periods &&
+          period_frequency == o.period_frequency &&
+          description == o.description &&
+          metrics == o.metrics &&
+          last_modified_date == o.last_modified_date &&
+          last_modified_by == o.last_modified_by &&
+          status == o.status &&
+          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, number_of_periods, period_frequency, description, metrics, last_modified_date, last_modified_by, status, 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