Class: GongAPI::CallParticipant

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallParticipant

Initializes the object



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
109
110
111
112
113
 
# File 'lib/gong_api/models/call_participant.rb', line 71

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

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

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

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

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

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

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

Instance Attribute Details

#context ⇒ Object

A list of links to external systems such as CRM, Telephony System, Case Management, etc.



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

def context
  @context
end

#email_address ⇒ Object

The email address of the party, if available.



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

def email_address
  @email_address
end

#media_channel_id ⇒ Object

The audio channel corresponding to the company team member (rep) used when the uploaded media file is multi-channel (stereo). The channel id is either 0 or 1 (representing left or right respectively)



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

def media_channel_id
  @media_channel_id
end

#name ⇒ Object

The name of the party, if available.



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

def name
  @name
end

#party_id ⇒ Object

An identifier that is only required when speakersTimeline is provided. The partyId is used to recognize the speakers within the provided speakersTimeline.



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

def party_id
  @party_id
end

#phone_number ⇒ Object

The phone number of the party, if available.



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

def phone_number
  @phone_number
end

#user_id ⇒ Object

The user ID of the participant within the Gong system, if the participant is a user.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/gong_api/models/call_participant.rb', line 38

def self.attribute_map
  {
    :'context' => :'context',
    :'email_address' => :'emailAddress',
    :'media_channel_id' => :'mediaChannelId',
    :'name' => :'name',
    :'party_id' => :'partyId',
    :'phone_number' => :'phoneNumber',
    :'user_id' => :'userId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



157
158
159
 
# File 'lib/gong_api/models/call_participant.rb', line 157

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
 
# File 'lib/gong_api/models/call_participant.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/gong_api/models/call_participant.rb', line 51

def self.openapi_types
  {
    :'context' => :'Object',
    :'email_address' => :'Object',
    :'media_channel_id' => :'Object',
    :'name' => :'Object',
    :'party_id' => :'Object',
    :'phone_number' => :'Object',
    :'user_id' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      context == o.context &&
      email_address == o.email_address &&
      media_channel_id == o.media_channel_id &&
      name == o.name &&
      party_id == o.party_id &&
      phone_number == o.phone_number &&
      user_id == o.user_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/gong_api/models/call_participant.rb', line 187

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



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

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/gong_api/models/call_participant.rb', line 164

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


144
145
146
 
# File 'lib/gong_api/models/call_participant.rb', line 144

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



150
151
152
 
# File 'lib/gong_api/models/call_participant.rb', line 150

def hash
  [context, email_address, media_channel_id, name, party_id, phone_number, user_id].hash
end

#list_invalid_properties ⇒ Object

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



117
118
119
120
 
# File 'lib/gong_api/models/call_participant.rb', line 117

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



232
233
234
 
# File 'lib/gong_api/models/call_participant.rb', line 232

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/gong_api/models/call_participant.rb', line 238

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



226
227
228
 
# File 'lib/gong_api/models/call_participant.rb', line 226

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



124
125
126
 
# File 'lib/gong_api/models/call_participant.rb', line 124

def valid?
  true
end