class PureCloud::VoicemailSearchRequest
Attributes
expand[RW]
Provides more details about a specified resource
page_number[RW]
The page of resources you want to retrieve
page_size[RW]
The number of results per page
query[RW]
sort_by[RW]
The field in the resource that you want to sort the results by
sort_order[RW]
The sort order for results
Public Class Methods
attribute_map()
click to toggle source
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/voicemail_search_request.rb, line 39 def self.attribute_map { :'sort_order' => :'sortOrder', :'sort_by' => :'sortBy', :'page_size' => :'pageSize', :'page_number' => :'pageNumber', :'expand' => :'expand', :'query' => :'query' } end
new(attributes = {})
click to toggle source
# File lib/purecloud/models/voicemail_search_request.rb, line 70 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[:'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
swagger_types()
click to toggle source
Attribute
type mapping.
# File lib/purecloud/models/voicemail_search_request.rb, line 58 def self.swagger_types { :'sort_order' => :'String', :'sort_by' => :'String', :'page_size' => :'Integer', :'page_number' => :'Integer', :'expand' => :'Array<String>', :'query' => :'Array<VoicemailSearchCriteria>' } end
Public Instance Methods
==(o)
click to toggle source
Check equality by comparing each attribute.
# File lib/purecloud/models/voicemail_search_request.rb, line 117 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 && expand == o.expand && query == o.query end
_deserialize(type, value)
click to toggle source
# File lib/purecloud/models/voicemail_search_request.rb, line 158 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
_to_hash(value)
click to toggle source
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloud/models/voicemail_search_request.rb, line 218 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_from_hash(attributes)
click to toggle source
build the object from hash
# File lib/purecloud/models/voicemail_search_request.rb, line 139 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
eql?(o)
click to toggle source
@see the `==` method
# File lib/purecloud/models/voicemail_search_request.rb, line 129 def eql?(o) self == o end
hash()
click to toggle source
Calculate hash code according to all attributes.
# File lib/purecloud/models/voicemail_search_request.rb, line 134 def hash [sort_order, sort_by, page_size, page_number, expand, query].hash end
sort_order=(sort_order)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/voicemail_search_request.rb, line 108 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
to_body()
click to toggle source
to_hash()
click to toggle source
return the object in the form of hash
# File lib/purecloud/models/voicemail_search_request.rb, line 206 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
to_s()
click to toggle source
# File lib/purecloud/models/voicemail_search_request.rb, line 196 def to_s to_hash.to_s end