Class: PureCloud::ParticipantRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/participant_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ParticipantRequest

Returns a new instance of ParticipantRequest.



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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/purecloud/models/participant_request.rb', line 66

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'wrapup']
    self.wrapup = attributes[:'wrapup']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'recording']
    self.recording = attributes[:'recording']
  else
    self.recording = false
  end
  
  if attributes[:'muted']
    self.muted = attributes[:'muted']
  else
    self.muted = false
  end
  
  if attributes[:'confined']
    self.confined = attributes[:'confined']
  else
    self.confined = false
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  else
    self.held = false
  end
  
  if attributes[:'wrapupSkipped']
    self.wrapup_skipped = attributes[:'wrapupSkipped']
  else
    self.wrapup_skipped = false
  end
  
end

Instance Attribute Details

#confined ⇒ Object

True to confine this conversation participant. Should only be used for ad-hoc conferences. Participant will have an updated communication with the new value for ‘confined’.



20
21
22
 
# File 'lib/purecloud/models/participant_request.rb', line 20

def confined
  @confined
end

#held ⇒ Object

True to hold this conversation participant. Participant will have an updated communication with the new value for ‘held’.



23
24
25
 
# File 'lib/purecloud/models/participant_request.rb', line 23

def held
  @held
end

#id ⇒ Object

Returns the value of attribute id.



5
6
7
 
# File 'lib/purecloud/models/participant_request.rb', line 5

def id
  @id
end

#muted ⇒ Object

True to mute this conversation participant. Participant will have an updated communication with the new value for ‘muted’.



17
18
19
 
# File 'lib/purecloud/models/participant_request.rb', line 17

def muted
  @muted
end

#recording ⇒ Object

True to enable recording of this participant, otherwise false to disable recording. Participant will have an updated communication with the new value for ‘recording’.



14
15
16
 
# File 'lib/purecloud/models/participant_request.rb', line 14

def recording
  @recording
end

#state ⇒ Object

The state to update to set for this participant’s communications. Possible values are: ‘CONNECTED’ and ‘DISCONNECTED’. Participant will have an updated communication with the new value for ‘state’.



11
12
13
 
# File 'lib/purecloud/models/participant_request.rb', line 11

def state
  @state
end

#wrapup ⇒ Object

Wrap-up to assign to this participant.



8
9
10
 
# File 'lib/purecloud/models/participant_request.rb', line 8

def wrapup
  @wrapup
end

#wrapup_skipped ⇒ Object

True to skip wrap-up for this participant. Participant will have an updated communication with the new value for ‘wrapupSkipped’.



26
27
28
 
# File 'lib/purecloud/models/participant_request.rb', line 26

def wrapup_skipped
  @wrapup_skipped
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/purecloud/models/participant_request.rb', line 29

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'wrapup' => :'wrapup',
    
    :'state' => :'state',
    
    :'recording' => :'recording',
    
    :'muted' => :'muted',
    
    :'confined' => :'confined',
    
    :'held' => :'held',
    
    :'wrapup_skipped' => :'wrapupSkipped'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/purecloud/models/participant_request.rb', line 52

def self.swagger_types
  {
    :'id' => :'String',
    :'wrapup' => :'Wrapup',
    :'state' => :'String',
    :'recording' => :'BOOLEAN',
    :'muted' => :'BOOLEAN',
    :'confined' => :'BOOLEAN',
    :'held' => :'BOOLEAN',
    :'wrapup_skipped' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/purecloud/models/participant_request.rb', line 127

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      wrapup == o.wrapup &&
      state == o.state &&
      recording == o.recording &&
      muted == o.muted &&
      confined == o.confined &&
      held == o.held &&
      wrapup_skipped == o.wrapup_skipped
end

#_deserialize(type, value) ⇒ Object 



170
171
172
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
 
# File 'lib/purecloud/models/participant_request.rb', line 170

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/purecloud/models/participant_request.rb', line 227

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/purecloud/models/participant_request.rb', line 151

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

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/purecloud/models/participant_request.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



146
147
148
 
# File 'lib/purecloud/models/participant_request.rb', line 146

def hash
  [id, wrapup, state, recording, muted, confined, held, wrapup_skipped].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



210
211
212
 
# File 'lib/purecloud/models/participant_request.rb', line 210

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



215
216
217
218
219
220
221
222
223
 
# File 'lib/purecloud/models/participant_request.rb', line 215

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 



205
206
207
 
# File 'lib/purecloud/models/participant_request.rb', line 205

def to_s
  to_hash.to_s
end