Class: PureCloud::AnalyticsParticipant

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/analytics_participant.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsParticipant

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
91
92
93
94
95
96
97
98
99
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 63

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'participantId')
    self.participant_id = attributes[:'participantId']
  end

  if attributes.has_key?(:'participantName')
    self.participant_name = attributes[:'participantName']
  end

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

  if attributes.has_key?(:'purpose')
    self.purpose = attributes[:'purpose']
  end

  if attributes.has_key?(:'externalContactId')
    self.external_contact_id = attributes[:'externalContactId']
  end

  if attributes.has_key?(:'externalOrganizationId')
    self.external_organization_id = attributes[:'externalOrganizationId']
  end

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

end

Instance Attribute Details

#external_contact_id ⇒ Object

Returns the value of attribute external_contact_id.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 29

def external_contact_id
  @external_contact_id
end

#external_organization_id ⇒ Object

Returns the value of attribute external_organization_id.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 31

def external_organization_id
  @external_organization_id
end

#participant_id ⇒ Object

Returns the value of attribute participant_id.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 21

def participant_id
  @participant_id
end

#participant_name ⇒ Object

Returns the value of attribute participant_name.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 23

def participant_name
  @participant_name
end

#purpose ⇒ Object

Returns the value of attribute purpose.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 27

def purpose
  @purpose
end

#sessions ⇒ Object

Returns the value of attribute sessions.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 33

def sessions
  @sessions
end

#user_id ⇒ Object

Returns the value of attribute user_id.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 25

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 36

def self.attribute_map
  {
    :'participant_id' => :'participantId',
    :'participant_name' => :'participantName',
    :'user_id' => :'userId',
    :'purpose' => :'purpose',
    :'external_contact_id' => :'externalContactId',
    :'external_organization_id' => :'externalOrganizationId',
    :'sessions' => :'sessions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 49

def self.swagger_types
  {
    :'participant_id' => :'String',
    :'participant_name' => :'String',
    :'user_id' => :'String',
    :'purpose' => :'String',
    :'external_contact_id' => :'String',
    :'external_organization_id' => :'String',
    :'sessions' => :'Array<AnalyticsSession>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      participant_id == o.participant_id &&
      participant_name == o.participant_name &&
      user_id == o.user_id &&
      purpose == o.purpose &&
      external_contact_id == o.external_contact_id &&
      external_organization_id == o.external_organization_id &&
      sessions == o.sessions
end

#_deserialize(type, value) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 173

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 233

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 154

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 149

def hash
  [participant_id, participant_name, user_id, purpose, external_contact_id, external_organization_id, sessions].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



103
104
105
106
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 103

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



216
217
218
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 216

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



221
222
223
224
225
226
227
228
229
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 221

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_s ⇒ Object 



211
212
213
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 211

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



110
111
112
113
114
115
 
# File 'lib/purecloudplatformclientv2/models/analytics_participant.rb', line 110

def valid?
  allowed_values = ["manual", "dialer", "inbound", "acd", "ivr", "voicemail", "outbound", "agent", "user", "station", "group", "customer", "external"]
  if @purpose && !allowed_values.include?(@purpose)
    return false
  end
end