purecloud 0.40.1 → 0.41.1

data/lib/purecloud/models/group_search_criteria.rb

@@ -0,0 +1,260 @@
+=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 GroupSearchCriteria
+    attr_accessor :end_value
+
+    attr_accessor :values
+
+    attr_accessor :start_value
+
+    attr_accessor :fields
+
+    attr_accessor :value
+
+    attr_accessor :operator
+
+    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<GroupSearchCriteria>',
+        :'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", "STARTS_WITH", "CONTAINS", "REGEX", "TERM", "TERMS", "REQUIRED_FIELDS"]
+      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

data/lib/purecloud/models/group_search_request.rb

@@ -0,0 +1,240 @@
+=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 GroupSearchRequest
+    attr_accessor :sort_order
+
+    attr_accessor :sort_by
+
+    attr_accessor :page_size
+
+    attr_accessor :page_number
+
+    attr_accessor :return_fields
+
+    attr_accessor :expand
+
+    attr_accessor :query
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'sort_order' => :'sortOrder',
+        
+        :'sort_by' => :'sortBy',
+        
+        :'page_size' => :'pageSize',
+        
+        :'page_number' => :'pageNumber',
+        
+        :'return_fields' => :'returnFields',
+        
+        :'expand' => :'expand',
+        
+        :'query' => :'query'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'sort_order' => :'String',
+        :'sort_by' => :'String',
+        :'page_size' => :'Integer',
+        :'page_number' => :'Integer',
+        :'return_fields' => :'Array<String>',
+        :'expand' => :'Array<String>',
+        :'query' => :'Array<GroupSearchCriteria>'
+        
+      }
+    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[:'sortOrder']
+        self.sort_order = attributes[:'sortOrder']
+      end
+      
+      if attributes[:'sortBy']
+        self.sort_by = attributes[:'sortBy']
+      end
+      
+      if attributes[:'pageSize']
+        self.page_size = attributes[:'pageSize']
+      end
+      
+      if attributes[:'pageNumber']
+        self.page_number = attributes[:'pageNumber']
+      end
+      
+      if attributes[:'returnFields']
+        if (value = attributes[:'returnFields']).is_a?(Array)
+          self.return_fields = value
+        end
+      end
+      
+      if attributes[:'expand']
+        if (value = attributes[:'expand']).is_a?(Array)
+          self.expand = value
+        end
+      end
+      
+      if attributes[:'query']
+        if (value = attributes[:'query']).is_a?(Array)
+          self.query = value
+        end
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def sort_order=(sort_order)
+      allowed_values = ["ASC", "DESC", "SCORE"]
+      if sort_order && !allowed_values.include?(sort_order)
+        fail "invalid value for 'sort_order', must be one of #{allowed_values}"
+      end
+      @sort_order = sort_order
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          sort_order == o.sort_order &&
+          sort_by == o.sort_by &&
+          page_size == o.page_size &&
+          page_number == o.page_number &&
+          return_fields == o.return_fields &&
+          expand == o.expand &&
+          query == o.query
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [sort_order, sort_by, page_size, page_number, return_fields, expand, query].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/groups_search_response.rb

@@ -36,6 +36,8 @@ module PureCloud
 
     attr_accessor :results
 
+    attr_accessor :aggregations
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -56,7 +58,9 @@ module PureCloud
         
         :'types' => :'types',
         
-        :'results' => :'results'
+        :'results' => :'results',
+        
+        :'aggregations' => :'aggregations'
         
       }
     end
@@ -72,7 +76,8 @@ module PureCloud
         :'current_page' => :'String',
         :'next_page' => :'String',
         :'types' => :'Array<String>',
-        :'results' => :'Array<Group>'
+        :'results' => :'Array<Group>',
+        :'aggregations' => :'Array<Group>'
         
       }
     end
@@ -124,6 +129,12 @@ module PureCloud
         end
       end
       
+      if attributes[:'aggregations']
+        if (value = attributes[:'aggregations']).is_a?(Array)
+          self.aggregations = value
+        end
+      end
+      
     end
 
     # Check equality by comparing each attribute.
@@ -138,7 +149,8 @@ module PureCloud
           current_page == o.current_page &&
           next_page == o.next_page &&
           types == o.types &&
-          results == o.results
+          results == o.results &&
+          aggregations == o.aggregations
     end
 
     # @see the `==` method
@@ -148,7 +160,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [total, page_count, page_size, page_number, previous_page, current_page, next_page, types, results].hash
+      [total, page_count, page_size, page_number, previous_page, current_page, next_page, types, results, aggregations].hash
     end
 
     # build the object from hash