Class: GongAPI::CustomerEngagement

Inherits:
Object
  • Object
show all
Defined in:
lib/gong_api/models/customer_engagement.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerEngagement

Initializes the object



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
 
# File 'lib/gong_api/models/customer_engagement.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `GongAPI::CustomerEngagement` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `GongAPI::CustomerEngagement`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'content_id')
    self.content_id = attributes[:'content_id']
  end

  if attributes.key?(:'content_url')
    self.content_url = attributes[:'content_url']
  end

  if attributes.key?(:'event_name')
    self.event_name = attributes[:'event_name']
  end

  if attributes.key?(:'event_type')
    self.event_type = attributes[:'event_type']
  end

  if attributes.key?(:'reporting_system')
    self.reporting_system = attributes[:'reporting_system']
  end

  if attributes.key?(:'source_event_id')
    self.source_event_id = attributes[:'source_event_id']
  end

  if attributes.key?(:'timestamp')
    self.timestamp = attributes[:'timestamp']
  end
end

Instance Attribute Details

#content_id ⇒ Object

Event content id



17
18
19
 
# File 'lib/gong_api/models/customer_engagement.rb', line 17

def content_id
  @content_id
end

#content_url ⇒ Object

Event content url



20
21
22
 
# File 'lib/gong_api/models/customer_engagement.rb', line 20

def content_url
  @content_url
end

#event_name ⇒ Object

Event name



23
24
25
 
# File 'lib/gong_api/models/customer_engagement.rb', line 23

def event_name
  @event_name
end

#event_type ⇒ Object

Event type



26
27
28
 
# File 'lib/gong_api/models/customer_engagement.rb', line 26

def event_type
  @event_type
end

#reporting_system ⇒ Object

Event reporting system



29
30
31
 
# File 'lib/gong_api/models/customer_engagement.rb', line 29

def reporting_system
  @reporting_system
end

#source_event_id ⇒ Object

Source event Id



32
33
34
 
# File 'lib/gong_api/models/customer_engagement.rb', line 32

def source_event_id
  @source_event_id
end

#timestamp ⇒ Object

The date and time the event occurred in the ISO-8601 format (e.g., ‘2018-02-18T02:30:00-07:00’ or ‘2018-02-18T08:00:00Z’, where Z stands for UTC).



35
36
37
 
# File 'lib/gong_api/models/customer_engagement.rb', line 35

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/gong_api/models/customer_engagement.rb', line 60

def self.attribute_map
  {
    :'content_id' => :'contentId',
    :'content_url' => :'contentUrl',
    :'event_name' => :'eventName',
    :'event_type' => :'eventType',
    :'reporting_system' => :'reportingSystem',
    :'source_event_id' => :'sourceEventId',
    :'timestamp' => :'timestamp'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



189
190
191
 
# File 'lib/gong_api/models/customer_engagement.rb', line 189

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/gong_api/models/customer_engagement.rb', line 86

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/gong_api/models/customer_engagement.rb', line 73

def self.openapi_types
  {
    :'content_id' => :'Object',
    :'content_url' => :'Object',
    :'event_name' => :'Object',
    :'event_type' => :'Object',
    :'reporting_system' => :'Object',
    :'source_event_id' => :'Object',
    :'timestamp' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/gong_api/models/customer_engagement.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content_id == o.content_id &&
      content_url == o.content_url &&
      event_name == o.event_name &&
      event_type == o.event_type &&
      reporting_system == o.reporting_system &&
      source_event_id == o.source_event_id &&
      timestamp == o.timestamp
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



219
220
221
222
223
224
225
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
 
# File 'lib/gong_api/models/customer_engagement.rb', line 219

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 =~ /\A(true|t|yes|y|1)\z/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
    GongAPI.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/gong_api/models/customer_engagement.rb', line 288

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

Builds the object from hash



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/gong_api/models/customer_engagement.rb', line 196

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


176
177
178
 
# File 'lib/gong_api/models/customer_engagement.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



182
183
184
 
# File 'lib/gong_api/models/customer_engagement.rb', line 182

def hash
  [content_id, content_url, event_name, event_type, reporting_system, source_event_id, timestamp].hash
end

#list_invalid_properties ⇒ Object

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



137
138
139
140
 
# File 'lib/gong_api/models/customer_engagement.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



264
265
266
 
# File 'lib/gong_api/models/customer_engagement.rb', line 264

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/gong_api/models/customer_engagement.rb', line 270

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



258
259
260
 
# File 'lib/gong_api/models/customer_engagement.rb', line 258

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



144
145
146
147
148
 
# File 'lib/gong_api/models/customer_engagement.rb', line 144

def valid?
  event_type_validator = EnumAttributeValidator.new('Object', ['contentShared', 'contentViewed', 'customEvent'])
  return false unless event_type_validator.valid?(@event_type)
  true
end