Class: PureCloud::AttributeQueryRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/attribute_query_request.rb

Overview

Used to query for attributes

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AttributeQueryRequest

Returns a new instance of AttributeQueryRequest.


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 38

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[:'query']
    self.query = attributes[:'query']
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
end

Instance Attribute Details

#page_number ⇒ Object

The page number to start at. The first page is number 1.


13
14
15
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 13

def page_number
  @page_number
end

#page_size ⇒ Object

The maximum number of hits to return. Default: 25, Maximum: 500.


10
11
12
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 10

def page_size
  @page_size
end

#query ⇒ Object

Query phrase to search attribute by name. If not set will match all.


7
8
9
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 7

def query
  @query
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.


16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 16

def self.attribute_map
  {
    
    :'query' => :'query',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.


29
30
31
32
33
34
35
36
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 29

def self.swagger_types
  {
    :'query' => :'String',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.


60
61
62
63
64
65
66
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 60

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query == o.query &&
      page_size == o.page_size &&
      page_number == o.page_number
end

#_deserialize(type, value) ⇒ Object 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 98

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value


155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 155

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) ⇒ Object

build the object from hash


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 79

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) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method

69
70
71
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 69

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.


74
75
76
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 74

def hash
  [query, page_size, page_number].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))


138
139
140
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 138

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash


143
144
145
146
147
148
149
150
151
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 143

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 ⇒ Object 


133
134
135
 
# File 'lib/purecloud/models/attribute_query_request.rb', line 133

def to_s
  to_hash.to_s
end