Class: PureCloud::SipSearchResult

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/sip_search_result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SipSearchResult

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



93
94
95
96
97
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 93

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?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'status')
    
    
    self.status = attributes[:'status']
    
  
  end

  
  if attributes.has_key?(:'sid')
    
    
    self.sid = attributes[:'sid']
    
  
  end

  
  if attributes.has_key?(:'auth')
    
    
    self.auth = attributes[:'auth']
    
  
  end

  
  if attributes.has_key?(:'message')
    
    
    self.message = attributes[:'message']
    
  
  end

  
  if attributes.has_key?(:'data')
    
    if (value = attributes[:'data']).is_a?(Array)
      self.data = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'count')
    
    
    self.count = attributes[:'count']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end

Instance Attribute Details

#auth ⇒ Object

Auth token used for this search request



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 31

def auth
  @auth
end

#count ⇒ Object

Number of records returned



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 40

def count
  @count
end

#data ⇒ Object

Homer search data that is returned



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 37

def data
  @data
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 22

def id
  @id
end

#message ⇒ Object

Any messages returned from homer as part of the response



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 34

def message
  @message
end

#self_uri ⇒ Object

The URI for this object



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 43

def self_uri
  @self_uri
end

#sid ⇒ Object

Session id associated to the search request



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 28

def sid
  @sid
end

#status ⇒ Object

Status of the search request



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 25

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 46

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'status' => :'status',
    
    :'sid' => :'sid',
    
    :'auth' => :'auth',
    
    :'message' => :'message',
    
    :'data' => :'data',
    
    :'count' => :'count',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 69

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'status' => :'Integer',
    
    :'sid' => :'String',
    
    :'auth' => :'String',
    
    :'message' => :'String',
    
    :'data' => :'Array<HomerRecord>',
    
    :'count' => :'Integer',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      status == o.status &&
      sid == o.sid &&
      auth == o.auth &&
      message == o.message &&
      data == o.data &&
      count == o.count &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 311

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

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 371

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 292

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


281
282
283
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



287
288
289
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 287

def hash
  [id, status, sid, auth, message, data, count, self_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



178
179
180
181
182
183
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 178

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



354
355
356
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 354

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



359
360
361
362
363
364
365
366
367
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 359

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 



349
350
351
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 349

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/purecloudplatformclientv2/models/sip_search_result.rb', line 187

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end