purecloudplatformclientv2 13.1.0 → 14.0.0

data/lib/purecloudplatformclientv2/models/search_request.rb

@@ -30,6 +30,9 @@ module PureCloud
     # The page of resources you want to retrieve
     attr_accessor :page_number
 
+    # Multi-value sort order, list of multiple sort values
+    attr_accessor :sort
+
     # A List of strings.  Possible values are any field in the resource you are searching on.  The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.
     attr_accessor :return_fields
 
@@ -57,6 +60,8 @@ module PureCloud
         
         :'page_number' => :'pageNumber',
         
+        :'sort' => :'sort',
+        
         :'return_fields' => :'returnFields',
         
         :'expand' => :'expand',
@@ -82,6 +87,8 @@ module PureCloud
         
         :'page_number' => :'Integer',
         
+        :'sort' => :'Array<SearchSort>',
+        
         :'return_fields' => :'Array<String>',
         
         :'expand' => :'Array<String>',
@@ -140,6 +147,17 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'sort')
+        
+        if (value = attributes[:'sort']).is_a?(Array)
+          self.sort = value
+        end
+        
+        
+      
+      end
+
+      
       if attributes.has_key?(:'returnFields')
         
         if (value = attributes[:'returnFields']).is_a?(Array)
@@ -235,6 +253,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -307,6 +329,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -322,6 +349,7 @@ module PureCloud
           sort_by == o.sort_by &&
           page_size == o.page_size &&
           page_number == o.page_number &&
+          sort == o.sort &&
           return_fields == o.return_fields &&
           expand == o.expand &&
           types == o.types &&
@@ -338,7 +366,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [sort_order, sort_by, page_size, page_number, return_fields, expand, types, query, aggregations].hash
+      [sort_order, sort_by, page_size, page_number, sort, return_fields, expand, types, query, aggregations].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/search_sort.rb

@@ -0,0 +1,242 @@
+=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@genesys.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 SearchSort
+    # The sort order for results
+    attr_accessor :sort_order
+
+    # The field in the resource that you want to sort the results by
+    attr_accessor :sort_by
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'sort_order' => :'sortOrder',
+        
+        :'sort_by' => :'sortBy'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'sort_order' => :'String',
+        
+        :'sort_by' => :'String'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'sortOrder')
+        
+        
+        self.sort_order = attributes[:'sortOrder']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'sortBy')
+        
+        
+        self.sort_by = attributes[:'sortBy']
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      allowed_values = ["ASC", "DESC", "SCORE"]
+      if @sort_order && !allowed_values.include?(@sort_order)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sort_order Object to be assigned
+    def sort_order=(sort_order)
+      allowed_values = ["ASC", "DESC", "SCORE"]
+      if sort_order && !allowed_values.include?(sort_order)
+        fail ArgumentError, "invalid value for 'sort_order', must be one of #{allowed_values}."
+      end
+      @sort_order = sort_order
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          sort_order == o.sort_order &&
+          sort_by == o.sort_by
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [sort_order, sort_by].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/purecloudplatformclientv2/models/security_profile_entity_listing.rb

@@ -26,16 +26,16 @@ module PureCloud
 
     attr_accessor :total
 
+    attr_accessor :self_uri
+
+    attr_accessor :first_uri
+
     attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :self_uri
-
-    attr_accessor :first_uri
-
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,16 +50,16 @@ module PureCloud
         
         :'total' => :'total',
         
+        :'self_uri' => :'selfUri',
+        
+        :'first_uri' => :'firstUri',
+        
         :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
         :'last_uri' => :'lastUri',
         
-        :'self_uri' => :'selfUri',
-        
-        :'first_uri' => :'firstUri',
-        
         :'page_count' => :'pageCount'
         
       }
@@ -77,16 +77,16 @@ module PureCloud
         
         :'total' => :'Integer',
         
+        :'self_uri' => :'String',
+        
+        :'first_uri' => :'String',
+        
         :'previous_uri' => :'String',
         
         :'next_uri' => :'String',
         
         :'last_uri' => :'String',
         
-        :'self_uri' => :'String',
-        
-        :'first_uri' => :'String',
-        
         :'page_count' => :'Integer'
         
       }
@@ -139,46 +139,46 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'firstUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.first_uri = attributes[:'firstUri']
         
       
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'firstUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.first_uri = attributes[:'firstUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -310,11 +310,11 @@ module PureCloud
           page_size == o.page_size &&
           page_number == o.page_number &&
           total == o.total &&
+          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 &&
-          self_uri == o.self_uri &&
-          first_uri == o.first_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, previous_uri, next_uri, last_uri, self_uri, first_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash