class PureCloud::UserSearchRequest
Attributes
Enforce view permission on request
Provides more details about a specified resource
Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 10.
The page of resources you want to retrieve
The number of results per page
Multi-value sort order, list of multiple sort values
The field in the resource that you want to sort the results by
The sort order for results
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 48 def self.attribute_map { :'sort_order' => :'sortOrder', :'sort_by' => :'sortBy', :'page_size' => :'pageSize', :'page_number' => :'pageNumber', :'sort' => :'sort', :'expand' => :'expand', :'query' => :'query', :'integration_presence_source' => :'integrationPresenceSource', :'enforce_permissions' => :'enforcePermissions' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 99 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 if attributes.has_key?(:'pageSize') self.page_size = attributes[:'pageSize'] end if attributes.has_key?(:'pageNumber') self.page_number = attributes[:'pageNumber'] end if attributes.has_key?(:'sort') if (value = attributes[:'sort']).is_a?(Array) self.sort = value end end if attributes.has_key?(:'expand') if (value = attributes[:'expand']).is_a?(Array) self.expand = value end end if attributes.has_key?(:'query') if (value = attributes[:'query']).is_a?(Array) self.query = value end end if attributes.has_key?(:'integrationPresenceSource') self.integration_presence_source = attributes[:'integrationPresenceSource'] end if attributes.has_key?(:'enforcePermissions') self.enforce_permissions = attributes[:'enforcePermissions'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 73 def self.swagger_types { :'sort_order' => :'String', :'sort_by' => :'String', :'page_size' => :'Integer', :'page_number' => :'Integer', :'sort' => :'Array<SearchSort>', :'expand' => :'Array<String>', :'query' => :'Array<UserSearchCriteria>', :'integration_presence_source' => :'String', :'enforce_permissions' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 322 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 && sort == o.sort && expand == o.expand && query == o.query && integration_presence_source == o.integration_presence_source && enforce_permissions == o.enforce_permissions end
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 368 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
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 428 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
build the object from hash
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 349 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 338 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 344 def hash [sort_order, sort_by, page_size, page_number, sort, expand, query, integration_presence_source, enforce_permissions].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] integration_presence_source
Object to be assigned
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 304 def integration_presence_source=(integration_presence_source) allowed_values = ["MicrosoftTeams", "ZoomPhone"] if integration_presence_source && !allowed_values.include?(integration_presence_source) fail ArgumentError, "invalid value for 'integration_presence_source', must be one of #{allowed_values}." end @integration_presence_source = integration_presence_source end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 197 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] sort_order
Object to be assigned
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 260 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
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 416 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
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 406 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/user_search_request.rb, line 206 def valid? allowed_values = ["ASC", "DESC", "SCORE"] if @sort_order && !allowed_values.include?(@sort_order) return false end allowed_values = ["MicrosoftTeams", "ZoomPhone"] if @integration_presence_source && !allowed_values.include?(@integration_presence_source) return false end end