Class: PureCloud::TransferRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/transfer_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
122
123
124
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 72

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?(:'userId')
    
    
    self.user_id = attributes[:'userId']
    
  
  end

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

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

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

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

  
end

Instance Attribute Details

#address ⇒ Object

The phone number or address of the transfer target.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 25

def address
  @address
end

#queue_id ⇒ Object

The queue ID of the transfer target.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 31

def queue_id
  @queue_id
end

#user_id ⇒ Object

The user ID of the transfer target.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 22

def user_id
  @user_id
end

#user_name ⇒ Object

The user name of the transfer target.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 28

def user_name
  @user_name
end

#voicemail ⇒ Object

If true, transfer to the voicemail inbox of the participant that is being replaced.



34
35
36
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 34

def voicemail
  @voicemail
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 37

def self.attribute_map
  {
    
    :'user_id' => :'userId',
    
    :'address' => :'address',
    
    :'user_name' => :'userName',
    
    :'queue_id' => :'queueId',
    
    :'voicemail' => :'voicemail'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 54

def self.swagger_types
  {
    
    :'user_id' => :'String',
    
    :'address' => :'String',
    
    :'user_name' => :'String',
    
    :'queue_id' => :'String',
    
    :'voicemail' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      address == o.address &&
      user_name == o.user_name &&
      queue_id == o.queue_id &&
      voicemail == o.voicemail
end

#_deserialize(type, value) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 231

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 291

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 212

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


201
202
203
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 207

def hash
  [user_id, address, user_name, queue_id, voicemail].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



128
129
130
131
132
133
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 128

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))



274
275
276
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 274

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



279
280
281
282
283
284
285
286
287
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 279

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 



269
270
271
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 269

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/purecloudclient_v2a/models/transfer_request.rb', line 137

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end