Class: PureCloud::Gistener

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Gistener

Returns a new instance of Gistener.



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
175
# File 'lib/purecloud/models/gistener.rb', line 112

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'enabled']
    self.enabled = attributes[:'enabled']
  else
    self.enabled = false
  end
  
  if attributes[:'anyWords']
    self.any_words = attributes[:'anyWords']
  end
  
  if attributes[:'allWords']
    self.all_words = attributes[:'allWords']
  end
  
  if attributes[:'excludeWords']
    self.exclude_words = attributes[:'excludeWords']
  end
  
  if attributes[:'exactPhrase']
    self.exact_phrase = attributes[:'exactPhrase']
  end
  
  if attributes[:'groupTags']
    if (value = attributes[:'groupTags']).is_a?(Array)
      self.group_tags = value
    end
  end
  
  if attributes[:'socialAccount']
    self. = attributes[:'socialAccount']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#all_wordsObject

A tweet must contain every one of these words in any order



39
40
41
# File 'lib/purecloud/models/gistener.rb', line 39

def all_words
  @all_words
end

#any_wordsObject

A tweet must contain any one of these words



36
37
38
# File 'lib/purecloud/models/gistener.rb', line 36

def any_words
  @any_words
end

#date_createdObject

Creation date for the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_created
  @date_created
end

#date_modifiedObject

Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



30
31
32
# File 'lib/purecloud/models/gistener.rb', line 30

def date_modified
  @date_modified
end

#enabledObject

Indicates if this Gistener may be utilized on another entity



33
34
35
# File 'lib/purecloud/models/gistener.rb', line 33

def enabled
  @enabled
end

#exact_phraseObject

A tweet must contain this exact quoted phrase



45
46
47
# File 'lib/purecloud/models/gistener.rb', line 45

def exact_phrase
  @exact_phrase
end

#exclude_wordsObject

If a tweet contains any one of these words, it is thrown out



42
43
44
# File 'lib/purecloud/models/gistener.rb', line 42

def exclude_words
  @exclude_words
end

#group_tagsObject

The group tags associated with this Gistener



48
49
50
# File 'lib/purecloud/models/gistener.rb', line 48

def group_tags
  @group_tags
end

#idObject

The globally unique identifier for the object.



22
23
24
# File 'lib/purecloud/models/gistener.rb', line 22

def id
  @id
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#queueObject

The operator queue the gistener will route to.



54
55
56
# File 'lib/purecloud/models/gistener.rb', line 54

def queue
  @queue
end

#self_uriObject

The URI for this object



57
58
59
# File 'lib/purecloud/models/gistener.rb', line 57

def self_uri
  @self_uri
end

#social_accountObject

The social account associated with this Gistener



51
52
53
# File 'lib/purecloud/models/gistener.rb', line 51

def 
  
end

Class Method Details

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/purecloud/models/gistener.rb', line 60

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'enabled' => :'enabled',
    
    :'any_words' => :'anyWords',
    
    :'all_words' => :'allWords',
    
    :'exclude_words' => :'excludeWords',
    
    :'exact_phrase' => :'exactPhrase',
    
    :'group_tags' => :'groupTags',
    
    :'social_account' => :'socialAccount',
    
    :'queue' => :'queue',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/purecloud/models/gistener.rb', line 93

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'enabled' => :'BOOLEAN',
    :'any_words' => :'String',
    :'all_words' => :'String',
    :'exclude_words' => :'String',
    :'exact_phrase' => :'String',
    :'group_tags' => :'Array<GroupTag>',
    :'social_account' => :'SocialAccount',
    :'queue' => :'Queue',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/purecloud/models/gistener.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      enabled == o.enabled &&
      any_words == o.any_words &&
      all_words == o.all_words &&
      exclude_words == o.exclude_words &&
      exact_phrase == o.exact_phrase &&
      group_tags == o.group_tags &&
       == o. &&
      queue == o.queue &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/purecloud/models/gistener.rb', line 226

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



286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/purecloud/models/gistener.rb', line 286

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/purecloud/models/gistener.rb', line 207

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


197
198
199
# File 'lib/purecloud/models/gistener.rb', line 197

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



202
203
204
# File 'lib/purecloud/models/gistener.rb', line 202

def hash
  [id, name, date_created, date_modified, enabled, any_words, all_words, exclude_words, exact_phrase, group_tags, , queue, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



269
270
271
# File 'lib/purecloud/models/gistener.rb', line 269

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



274
275
276
277
278
279
280
281
282
# File 'lib/purecloud/models/gistener.rb', line 274

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_sObject



264
265
266
# File 'lib/purecloud/models/gistener.rb', line 264

def to_s
  to_hash.to_s
end