purecloud 0.40.1 → 0.41.1

data/lib/purecloud/models/user_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 UserSearchRequest
+    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<UserSearchCriteria>'
+        
+      }
+    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/users_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<User>'
+        :'results' => :'Array<User>',
+        :'aggregations' => :'Array<User>'
         
       }
     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

data/lib/purecloud/models/voicemail_message_entity_listing.rb

@@ -18,49 +18,21 @@ require 'date'
 
 module PureCloud
   class VoicemailMessageEntityListing
-    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'
+        :'self_uri' => :'selfUri'
         
       }
     end
@@ -68,16 +40,9 @@ module PureCloud
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'page_size' => :'Integer',
-        :'page_number' => :'Integer',
         :'total' => :'Integer',
         :'entities' => :'Array<VoicemailMessage>',
-        :'self_uri' => :'String',
-        :'first_uri' => :'String',
-        :'previous_uri' => :'String',
-        :'next_uri' => :'String',
-        :'last_uri' => :'String',
-        :'page_count' => :'Integer'
+        :'self_uri' => :'String'
         
       }
     end
@@ -89,14 +54,6 @@ module PureCloud
       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
@@ -111,42 +68,15 @@ module PureCloud
         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
+          self_uri == o.self_uri
     end
 
     # @see the `==` method
@@ -156,7 +86,7 @@ module PureCloud
 
     # 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
+      [total, entities, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/workspace.rb

@@ -41,6 +41,8 @@ module PureCloud
 
     attr_accessor :acl
 
+    attr_accessor :description
+
     # The URI for this object
     attr_accessor :self_uri
 
@@ -68,6 +70,8 @@ module PureCloud
         
         :'acl' => :'acl',
         
+        :'description' => :'description',
+        
         :'self_uri' => :'selfUri'
         
       }
@@ -86,6 +90,7 @@ module PureCloud
         :'date_modified' => :'DateTime',
         :'summary' => :'WorkspaceSummary',
         :'acl' => :'Array<String>',
+        :'description' => :'String',
         :'self_uri' => :'String'
         
       }
@@ -142,6 +147,10 @@ module PureCloud
         end
       end
       
+      if attributes[:'description']
+        self.description = attributes[:'description']
+      end
+      
       if attributes[:'selfUri']
         self.self_uri = attributes[:'selfUri']
       end
@@ -171,6 +180,7 @@ module PureCloud
           date_modified == o.date_modified &&
           summary == o.summary &&
           acl == o.acl &&
+          description == o.description &&
           self_uri == o.self_uri
     end
 
@@ -181,7 +191,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, name, type, is_current_user_workspace, user, bucket, date_created, date_modified, summary, acl, self_uri].hash
+      [id, name, type, is_current_user_workspace, user, bucket, date_created, date_modified, summary, acl, description, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/workspace_create.rb

@@ -22,13 +22,17 @@ module PureCloud
 
     attr_accessor :bucket
 
+    attr_accessor :description
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
         :'name' => :'name',
         
-        :'bucket' => :'bucket'
+        :'bucket' => :'bucket',
+        
+        :'description' => :'description'
         
       }
     end
@@ -37,7 +41,8 @@ module PureCloud
     def self.swagger_types
       {
         :'name' => :'String',
-        :'bucket' => :'String'
+        :'bucket' => :'String',
+        :'description' => :'String'
         
       }
     end
@@ -57,6 +62,10 @@ module PureCloud
         self.bucket = attributes[:'bucket']
       end
       
+      if attributes[:'description']
+        self.description = attributes[:'description']
+      end
+      
     end
 
     # Check equality by comparing each attribute.
@@ -64,7 +73,8 @@ module PureCloud
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          bucket == o.bucket
+          bucket == o.bucket &&
+          description == o.description
     end
 
     # @see the `==` method
@@ -74,7 +84,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [name, bucket].hash
+      [name, bucket, description].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/workspace_summary.rb

@@ -20,11 +20,15 @@ module PureCloud
   class WorkspaceSummary
     attr_accessor :total_document_count
 
+    attr_accessor :total_document_byte_count
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'total_document_count' => :'totalDocumentCount'
+        :'total_document_count' => :'totalDocumentCount',
+        
+        :'total_document_byte_count' => :'totalDocumentByteCount'
         
       }
     end
@@ -32,7 +36,8 @@ module PureCloud
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'total_document_count' => :'Integer'
+        :'total_document_count' => :'Integer',
+        :'total_document_byte_count' => :'Integer'
         
       }
     end
@@ -48,13 +53,18 @@ module PureCloud
         self.total_document_count = attributes[:'totalDocumentCount']
       end
       
+      if attributes[:'totalDocumentByteCount']
+        self.total_document_byte_count = attributes[:'totalDocumentByteCount']
+      end
+      
     end
 
     # Check equality by comparing each attribute.
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          total_document_count == o.total_document_count
+          total_document_count == o.total_document_count &&
+          total_document_byte_count == o.total_document_byte_count
     end
 
     # @see the `==` method
@@ -64,7 +74,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [total_document_count].hash
+      [total_document_count, total_document_byte_count].hash
     end
 
     # build the object from hash

data/lib/purecloud/version.rb

@@ -15,5 +15,5 @@ Terms of Service: https://developer.mypurecloud.com/tos
 =end
 
 module PureCloud
-  VERSION = "0.40.1"
+  VERSION = "0.41.1"
 end