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.



59
60
61
62
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
100
101
102
103
104
105
106
107
108
# File 'lib/purecloud/models/participant_request.rb', line 59

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

#confinedObject

Returns the value of attribute confined.



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

def confined
  @confined
end

#heldObject

Returns the value of attribute held.



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

def held
  @held
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#mutedObject

Returns the value of attribute muted.



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

def muted
  @muted
end

#recordingObject

Returns the value of attribute recording.



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

def recording
  @recording
end

#stateObject

Returns the value of attribute state.



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

def state
  @state
end

#wrapupObject

Returns the value of attribute wrapup.



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

def wrapup
  @wrapup
end

#wrapup_skippedObject

Returns the value of attribute wrapup_skipped.



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

def wrapup_skipped
  @wrapup_skipped
end

Class Method Details

.attribute_mapObject

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



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/purecloud/models/participant_request.rb', line 22

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

.swagger_typesObject

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/purecloud/models/participant_request.rb', line 45

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.



120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/purecloud/models/participant_request.rb', line 120

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



163
164
165
166
167
168
169
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
# File 'lib/purecloud/models/participant_request.rb', line 163

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



220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/purecloud/models/participant_request.rb', line 220

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/purecloud/models/participant_request.rb', line 144

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


134
135
136
# File 'lib/purecloud/models/participant_request.rb', line 134

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



139
140
141
# File 'lib/purecloud/models/participant_request.rb', line 139

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

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



203
204
205
# File 'lib/purecloud/models/participant_request.rb', line 203

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



208
209
210
211
212
213
214
215
216
# File 'lib/purecloud/models/participant_request.rb', line 208

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_sObject



198
199
200
# File 'lib/purecloud/models/participant_request.rb', line 198

def to_s
  to_hash.to_s
end