purecloud 0.0.0

data/lib/purecloud/models/facet_result.rb

@@ -0,0 +1,211 @@
+require 'date'
+
+module PureCloud
+  # Used as part of the searchResult to return facet results to the caller
+  class FacetResult
+    # This was the name passed in as part of the facetRequest
+    attr_accessor :request_name
+
+    # The field name that the facet was requested for.
+    attr_accessor :request_field_name
+
+    # data type of the field being returned (if this is a mixed field this will be unknown)
+    attr_accessor :field_type
+
+    # the facet request type that was made.
+    attr_accessor :request_type
+
+    attr_accessor :results
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'request_name' => :'requestName',
+        
+        :'request_field_name' => :'requestFieldName',
+        
+        :'field_type' => :'fieldType',
+        
+        :'request_type' => :'requestType',
+        
+        :'results' => :'results'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'request_name' => :'String',
+        :'request_field_name' => :'String',
+        :'field_type' => :'String',
+        :'request_type' => :'String',
+        :'results' => :'Array<FacetResultItem>'
+        
+      }
+    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[:'requestName']
+        self.request_name = attributes[:'requestName']
+      end
+      
+      if attributes[:'requestFieldName']
+        self.request_field_name = attributes[:'requestFieldName']
+      end
+      
+      if attributes[:'fieldType']
+        self.field_type = attributes[:'fieldType']
+      end
+      
+      if attributes[:'requestType']
+        self.request_type = attributes[:'requestType']
+      end
+      
+      if attributes[:'results']
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
+        end
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def field_type=(field_type)
+      allowed_values = ["NUMBER", "STRING", "DATE", "BOOLEAN", "LIST", "GROUP"]
+      if field_type && !allowed_values.include?(field_type)
+        fail "invalid value for 'field_type', must be one of #{allowed_values}"
+      end
+      @field_type = field_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def request_type=(request_type)
+      allowed_values = ["TERM", "RANGE"]
+      if request_type && !allowed_values.include?(request_type)
+        fail "invalid value for 'request_type', must be one of #{allowed_values}"
+      end
+      @request_type = request_type
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          request_name == o.request_name &&
+          request_field_name == o.request_field_name &&
+          field_type == o.field_type &&
+          request_type == o.request_type &&
+          results == o.results
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [request_name, request_field_name, field_type, request_type, results].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/facet_result_item.rb

@@ -0,0 +1,208 @@
+require 'date'
+
+module PureCloud
+  class FacetResultItem
+    # For TERM facets this will contain the value of the term that was found userid, docid, etc.
+    attr_accessor :name
+
+    # The number of items that matched the facetRequest.
+    attr_accessor :count
+
+    attr_accessor :document
+
+    attr_accessor :user
+
+    attr_accessor :queue
+
+    attr_accessor :flow_config_id
+
+    attr_accessor :workspace
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'name' => :'name',
+        
+        :'count' => :'count',
+        
+        :'document' => :'document',
+        
+        :'user' => :'user',
+        
+        :'queue' => :'queue',
+        
+        :'flow_config_id' => :'flowConfigId',
+        
+        :'workspace' => :'workspace'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'count' => :'Integer',
+        :'document' => :'Document',
+        :'user' => :'User',
+        :'queue' => :'Queue',
+        :'flow_config_id' => :'FlowConfigId',
+        :'workspace' => :'Workspace'
+        
+      }
+    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[:'name']
+        self.name = attributes[:'name']
+      end
+      
+      if attributes[:'count']
+        self.count = attributes[:'count']
+      end
+      
+      if attributes[:'document']
+        self.document = attributes[:'document']
+      end
+      
+      if attributes[:'user']
+        self.user = attributes[:'user']
+      end
+      
+      if attributes[:'queue']
+        self.queue = attributes[:'queue']
+      end
+      
+      if attributes[:'flowConfigId']
+        self.flow_config_id = attributes[:'flowConfigId']
+      end
+      
+      if attributes[:'workspace']
+        self.workspace = attributes[:'workspace']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          count == o.count &&
+          document == o.document &&
+          user == o.user &&
+          queue == o.queue &&
+          flow_config_id == o.flow_config_id &&
+          workspace == o.workspace
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [name, count, document, user, queue, flow_config_id, workspace].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/facet_statistics.rb

@@ -0,0 +1,208 @@
+require 'date'
+
+module PureCloud
+  class FacetStatistics
+    attr_accessor :count
+
+    attr_accessor :min
+
+    attr_accessor :max
+
+    attr_accessor :mean
+
+    attr_accessor :std_deviation
+
+    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_min
+
+    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_max
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'count' => :'count',
+        
+        :'min' => :'min',
+        
+        :'max' => :'max',
+        
+        :'mean' => :'mean',
+        
+        :'std_deviation' => :'stdDeviation',
+        
+        :'date_min' => :'dateMin',
+        
+        :'date_max' => :'dateMax'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'count' => :'Integer',
+        :'min' => :'Float',
+        :'max' => :'Float',
+        :'mean' => :'Float',
+        :'std_deviation' => :'Float',
+        :'date_min' => :'DateTime',
+        :'date_max' => :'DateTime'
+        
+      }
+    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[:'count']
+        self.count = attributes[:'count']
+      end
+      
+      if attributes[:'min']
+        self.min = attributes[:'min']
+      end
+      
+      if attributes[:'max']
+        self.max = attributes[:'max']
+      end
+      
+      if attributes[:'mean']
+        self.mean = attributes[:'mean']
+      end
+      
+      if attributes[:'stdDeviation']
+        self.std_deviation = attributes[:'stdDeviation']
+      end
+      
+      if attributes[:'dateMin']
+        self.date_min = attributes[:'dateMin']
+      end
+      
+      if attributes[:'dateMax']
+        self.date_max = attributes[:'dateMax']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          count == o.count &&
+          min == o.min &&
+          max == o.max &&
+          mean == o.mean &&
+          std_deviation == o.std_deviation &&
+          date_min == o.date_min &&
+          date_max == o.date_max
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [count, min, max, mean, std_deviation, date_min, date_max].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