Class: GongAPI::AnsweredScorecard

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnsweredScorecard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#answered_scorecard_id ⇒ Object

The identifier of the answer of the scorecard.



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

def answered_scorecard_id
  @answered_scorecard_id
end

#answers ⇒ Object

The answers in the answered scorecard.



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

def answers
  @answers
end

#call_id ⇒ Object

Gong’s unique numeric identifier for the call (up to 20 digits).



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

def call_id
  @call_id
end

#call_start_time ⇒ Object

The date and time when the call was recorded 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).



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

def call_start_time
  @call_start_time
end

#review_time ⇒ Object

The date and time when the review was completed and published 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).



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

def review_time
  @review_time
end

#reviewed_user_id ⇒ Object

The user Id of the team member being reviewed, who hosted the call.



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

def reviewed_user_id
  @reviewed_user_id
end

#reviewer_user_id ⇒ Object

The user Id of the team member who answered the scorecard for the call.



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

def reviewer_user_id
  @reviewer_user_id
end

#scorecard_id ⇒ Object

The identifier of the scorecard.



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

def scorecard_id
  @scorecard_id
end

#scorecard_name ⇒ Object

Scorecard name.



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

def scorecard_name
  @scorecard_name
end

#visibility_type ⇒ Object

Returns the value of attribute visibility_type.



43
44
45
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 43

def visibility_type
  @visibility_type
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 68

def self.attribute_map
  {
    :'answered_scorecard_id' => :'answeredScorecardId',
    :'answers' => :'answers',
    :'call_id' => :'callId',
    :'call_start_time' => :'callStartTime',
    :'review_time' => :'reviewTime',
    :'reviewed_user_id' => :'reviewedUserId',
    :'reviewer_user_id' => :'reviewerUserId',
    :'scorecard_id' => :'scorecardId',
    :'scorecard_name' => :'scorecardName',
    :'visibility_type' => :'visibilityType'
  }
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



220
221
222
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 220

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 84

def self.openapi_types
  {
    :'answered_scorecard_id' => :'Object',
    :'answers' => :'Object',
    :'call_id' => :'Object',
    :'call_start_time' => :'Object',
    :'review_time' => :'Object',
    :'reviewed_user_id' => :'Object',
    :'reviewer_user_id' => :'Object',
    :'scorecard_id' => :'Object',
    :'scorecard_name' => :'Object',
    :'visibility_type' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      answered_scorecard_id == o.answered_scorecard_id &&
      answers == o.answers &&
      call_id == o.call_id &&
      call_start_time == o.call_start_time &&
      review_time == o.review_time &&
      reviewed_user_id == o.reviewed_user_id &&
      reviewer_user_id == o.reviewer_user_id &&
      scorecard_id == o.scorecard_id &&
      scorecard_name == o.scorecard_name &&
      visibility_type == o.visibility_type
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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 250

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 319

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 227

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


207
208
209
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 213

def hash
  [answered_scorecard_id, answers, call_id, call_start_time, review_time, reviewed_user_id, reviewer_user_id, scorecard_id, scorecard_name, visibility_type].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



165
166
167
168
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 165

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



295
296
297
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 295

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 301

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



289
290
291
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 289

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



172
173
174
175
176
 
# File 'lib/gong_api/models/answered_scorecard.rb', line 172

def valid?
  visibility_type_validator = EnumAttributeValidator.new('Object', ['OPT_IN_USERS', 'PRIVATE', 'PUBLIC'])
  return false unless visibility_type_validator.valid?(@visibility_type)
  true
end