Class: PureCloud::ChatSearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatSearchRequest

Returns a new instance of ChatSearchRequest.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/purecloud/models/chat_search_request.rb', line 67

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[:'order']
    self.order = attributes[:'order']
  end
  
  if attributes[:'targetJids']
    if (value = attributes[:'targetJids']).is_a?(Array)
      self.target_jids = value
    end
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
  if attributes[:'fromDate']
    self.from_date = attributes[:'fromDate']
  end
  
  if attributes[:'toDate']
    self.to_date = attributes[:'toDate']
  end
  
  if attributes[:'expand']
    self.expand = attributes[:'expand']
  end
  
end

Instance Attribute Details

#expand ⇒ Object

Expand the ‘to’ or ‘from’ user details.



27
28
29
 
# File 'lib/purecloud/models/chat_search_request.rb', line 27

def expand
  @expand
end

#from_date ⇒ Object

Consider hits after this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



21
22
23
 
# File 'lib/purecloud/models/chat_search_request.rb', line 21

def from_date
  @from_date
end

#order ⇒ Object

Sort order of results by score or most recent. Default is by score



9
10
11
 
# File 'lib/purecloud/models/chat_search_request.rb', line 9

def order
  @order
end

#page_number ⇒ Object

The number of hits to skip before returning results. Default: 0



18
19
20
 
# File 'lib/purecloud/models/chat_search_request.rb', line 18

def page_number
  @page_number
end

#page_size ⇒ Object

The maximum number of hits to receive in the response. Default: 10, Maximum: 50]



15
16
17
 
# File 'lib/purecloud/models/chat_search_request.rb', line 15

def page_size
  @page_size
end

#query ⇒ Object

Search terms can be AND’d together. Example: foo AND bar



6
7
8
 
# File 'lib/purecloud/models/chat_search_request.rb', line 6

def query
  @query
end

#target_jids ⇒ Object

A list of XMPP JIDs to consider. Default is all permissible JIDs. A permissible JID is defined as any JID of a person with whom you have chatted, or any group in which you are currently a member.



12
13
14
 
# File 'lib/purecloud/models/chat_search_request.rb', line 12

def target_jids
  @target_jids
end

#to_date ⇒ Object

Consider hits before this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



24
25
26
 
# File 'lib/purecloud/models/chat_search_request.rb', line 24

def to_date
  @to_date
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/purecloud/models/chat_search_request.rb', line 30

def self.attribute_map
  {
    
    :'query' => :'query',
    
    :'order' => :'order',
    
    :'target_jids' => :'targetJids',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber',
    
    :'from_date' => :'fromDate',
    
    :'to_date' => :'toDate',
    
    :'expand' => :'expand'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/purecloud/models/chat_search_request.rb', line 53

def self.swagger_types
  {
    :'query' => :'String',
    :'order' => :'String',
    :'target_jids' => :'Array<String>',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer',
    :'from_date' => :'DateTime',
    :'to_date' => :'DateTime',
    :'expand' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloud/models/chat_search_request.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query == o.query &&
      order == o.order &&
      target_jids == o.target_jids &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      from_date == o.from_date &&
      to_date == o.to_date &&
      expand == o.expand
end

#_deserialize(type, value) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloud/models/chat_search_request.rb', line 172

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



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/purecloud/models/chat_search_request.rb', line 229

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/purecloud/models/chat_search_request.rb', line 153

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


143
144
145
 
# File 'lib/purecloud/models/chat_search_request.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



148
149
150
 
# File 'lib/purecloud/models/chat_search_request.rb', line 148

def hash
  [query, order, target_jids, page_size, page_number, from_date, to_date, expand].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



212
213
214
 
# File 'lib/purecloud/models/chat_search_request.rb', line 212

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



217
218
219
220
221
222
223
224
225
 
# File 'lib/purecloud/models/chat_search_request.rb', line 217

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 



207
208
209
 
# File 'lib/purecloud/models/chat_search_request.rb', line 207

def to_s
  to_hash.to_s
end