Class: PureCloud::OrphanRecording

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrphanRecording

Returns a new instance of OrphanRecording.



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/purecloud/models/orphan_recording.rb', line 100

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[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'createdTime']
    self.created_time = attributes[:'createdTime']
  end
  
  if attributes[:'recoveredTime']
    self.recovered_time = attributes[:'recoveredTime']
  end
  
  if attributes[:'providerType']
    self.provider_type = attributes[:'providerType']
  end
  
  if attributes[:'mediaSizeBytes']
    self.media_size_bytes = attributes[:'mediaSizeBytes']
  end
  
  if attributes[:'mediaType']
    self.media_type = attributes[:'mediaType']
  end
  
  if attributes[:'fileState']
    self.file_state = attributes[:'fileState']
  end
  
  if attributes[:'providerEndpoint']
    self.provider_endpoint = attributes[:'providerEndpoint']
  end
  
  if attributes[:'recording']
    self.recording = attributes[:'recording']
  end
  
  if attributes[:'orphanStatus']
    self.orphan_status = attributes[:'orphanStatus']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#created_timeObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



27
28
29
# File 'lib/purecloud/models/orphan_recording.rb', line 27

def created_time
  @created_time
end

#file_stateObject

Returns the value of attribute file_state.



38
39
40
# File 'lib/purecloud/models/orphan_recording.rb', line 38

def file_state
  @file_state
end

#idObject

The globally unique identifier for the object.



22
23
24
# File 'lib/purecloud/models/orphan_recording.rb', line 22

def id
  @id
end

#media_size_bytesObject

Returns the value of attribute media_size_bytes.



34
35
36
# File 'lib/purecloud/models/orphan_recording.rb', line 34

def media_size_bytes
  @media_size_bytes
end

#media_typeObject

Returns the value of attribute media_type.



36
37
38
# File 'lib/purecloud/models/orphan_recording.rb', line 36

def media_type
  @media_type
end

#nameObject

Returns the value of attribute name.



24
25
26
# File 'lib/purecloud/models/orphan_recording.rb', line 24

def name
  @name
end

#orphan_statusObject

The status of the orphaned recording’s conversation.



45
46
47
# File 'lib/purecloud/models/orphan_recording.rb', line 45

def orphan_status
  @orphan_status
end

#provider_endpointObject

Returns the value of attribute provider_endpoint.



40
41
42
# File 'lib/purecloud/models/orphan_recording.rb', line 40

def provider_endpoint
  @provider_endpoint
end

#provider_typeObject

Returns the value of attribute provider_type.



32
33
34
# File 'lib/purecloud/models/orphan_recording.rb', line 32

def provider_type
  @provider_type
end

#recordingObject

Returns the value of attribute recording.



42
43
44
# File 'lib/purecloud/models/orphan_recording.rb', line 42

def recording
  @recording
end

#recovered_timeObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



30
31
32
# File 'lib/purecloud/models/orphan_recording.rb', line 30

def recovered_time
  @recovered_time
end

#self_uriObject

The URI for this object



48
49
50
# File 'lib/purecloud/models/orphan_recording.rb', line 48

def self_uri
  @self_uri
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/purecloud/models/orphan_recording.rb', line 51

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'created_time' => :'createdTime',
    
    :'recovered_time' => :'recoveredTime',
    
    :'provider_type' => :'providerType',
    
    :'media_size_bytes' => :'mediaSizeBytes',
    
    :'media_type' => :'mediaType',
    
    :'file_state' => :'fileState',
    
    :'provider_endpoint' => :'providerEndpoint',
    
    :'recording' => :'recording',
    
    :'orphan_status' => :'orphanStatus',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/purecloud/models/orphan_recording.rb', line 82

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'created_time' => :'DateTime',
    :'recovered_time' => :'DateTime',
    :'provider_type' => :'String',
    :'media_size_bytes' => :'Integer',
    :'media_type' => :'String',
    :'file_state' => :'String',
    :'provider_endpoint' => :'Endpoint',
    :'recording' => :'Recording',
    :'orphan_status' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/purecloud/models/orphan_recording.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      created_time == o.created_time &&
      recovered_time == o.recovered_time &&
      provider_type == o.provider_type &&
      media_size_bytes == o.media_size_bytes &&
      media_type == o.media_type &&
      file_state == o.file_state &&
      provider_endpoint == o.provider_endpoint &&
      recording == o.recording &&
      orphan_status == o.orphan_status &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



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
268
269
270
271
272
273
274
275
276
277
# File 'lib/purecloud/models/orphan_recording.rb', line 241

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



301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/purecloud/models/orphan_recording.rb', line 301

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/purecloud/models/orphan_recording.rb', line 222

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


212
213
214
# File 'lib/purecloud/models/orphan_recording.rb', line 212

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



217
218
219
# File 'lib/purecloud/models/orphan_recording.rb', line 217

def hash
  [id, name, created_time, recovered_time, provider_type, media_size_bytes, media_type, file_state, provider_endpoint, recording, orphan_status, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



284
285
286
# File 'lib/purecloud/models/orphan_recording.rb', line 284

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



289
290
291
292
293
294
295
296
297
# File 'lib/purecloud/models/orphan_recording.rb', line 289

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



279
280
281
# File 'lib/purecloud/models/orphan_recording.rb', line 279

def to_s
  to_hash.to_s
end