Class: GongAPI::LogEntry

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/gong_api/models/log_entry.rb', line 81

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `GongAPI::LogEntry` 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::LogEntry`. 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?(:'event_time')
    self.event_time = attributes[:'event_time']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#event_time ⇒ Object

The time 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); when log was created.



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

def event_time
  @event_time
end

#impersonator_company_id ⇒ Object

Gong’s unique numeric identifier for the impersonating user’s company id (up to 20 digits), if available.



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

def impersonator_company_id
  @impersonator_company_id
end

#impersonator_email_address ⇒ Object

The email address of the impersonating user, if available.



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

def impersonator_email_address
  @impersonator_email_address
end

#impersonator_full_name ⇒ Object

The full name of the impersonating user, if available.



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

def impersonator_full_name
  @impersonator_full_name
end

#impersonator_user_id ⇒ Object

Gong’s unique numeric identifier for the impersonating user (up to 20 digits), if available.



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

def impersonator_user_id
  @impersonator_user_id
end

#log_record ⇒ Object

The list of log fields and associated values. This element will be populated dynamically by the log record, depending on the type of log.



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

def log_record
  @log_record
end

#user_email_address ⇒ Object

The email address of the user, if available.



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

def user_email_address
  @user_email_address
end

#user_full_name ⇒ Object

The full name of the user, if available.



38
39
40
 
# File 'lib/gong_api/models/log_entry.rb', line 38

def user_full_name
  @user_full_name
end

#user_id ⇒ Object

Gong’s unique numeric identifier for the user (up to 20 digits), if available.



41
42
43
 
# File 'lib/gong_api/models/log_entry.rb', line 41

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/gong_api/models/log_entry.rb', line 44

def self.attribute_map
  {
    :'event_time' => :'eventTime',
    :'impersonator_company_id' => :'impersonatorCompanyId',
    :'impersonator_email_address' => :'impersonatorEmailAddress',
    :'impersonator_full_name' => :'impersonatorFullName',
    :'impersonator_user_id' => :'impersonatorUserId',
    :'log_record' => :'logRecord',
    :'user_email_address' => :'userEmailAddress',
    :'user_full_name' => :'userFullName',
    :'user_id' => :'userId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



175
176
177
 
# File 'lib/gong_api/models/log_entry.rb', line 175

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
 
# File 'lib/gong_api/models/log_entry.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'event_time' => :'Object',
    :'impersonator_company_id' => :'Object',
    :'impersonator_email_address' => :'Object',
    :'impersonator_full_name' => :'Object',
    :'impersonator_user_id' => :'Object',
    :'log_record' => :'Object',
    :'user_email_address' => :'Object',
    :'user_full_name' => :'Object',
    :'user_id' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/gong_api/models/log_entry.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_time == o.event_time &&
      impersonator_company_id == o.impersonator_company_id &&
      impersonator_email_address == o.impersonator_email_address &&
      impersonator_full_name == o.impersonator_full_name &&
      impersonator_user_id == o.impersonator_user_id &&
      log_record == o.log_record &&
      user_email_address == o.user_email_address &&
      user_full_name == o.user_full_name &&
      user_id == o.user_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/gong_api/models/log_entry.rb', line 205

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/gong_api/models/log_entry.rb', line 274

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/gong_api/models/log_entry.rb', line 182

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
 
# File 'lib/gong_api/models/log_entry.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/gong_api/models/log_entry.rb', line 168

def hash
  [event_time, impersonator_company_id, impersonator_email_address, impersonator_full_name, impersonator_user_id, log_record, user_email_address, user_full_name, user_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



133
134
135
136
 
# File 'lib/gong_api/models/log_entry.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
 
# File 'lib/gong_api/models/log_entry.rb', line 250

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/gong_api/models/log_entry.rb', line 256

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

Returns:

  • (String) —

    String presentation of the object



244
245
246
 
# File 'lib/gong_api/models/log_entry.rb', line 244

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



140
141
142
 
# File 'lib/gong_api/models/log_entry.rb', line 140

def valid?
  true
end