Class: Daily::RecordingReadyToDownloadPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/daily-ruby/models/recording_ready_to_download_payload.rb

Overview

The payload of the object, describing the given event.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecordingReadyToDownloadPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
161
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 111

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::RecordingReadyToDownloadPayload` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Daily::RecordingReadyToDownloadPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'recording_id')
    self.recording_id = attributes[:'recording_id']
  end

  if attributes.key?(:'room_name')
    self.room_name = attributes[:'room_name']
  end

  if attributes.key?(:'start_ts')
    self.start_ts = attributes[:'start_ts']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'max_participants')
    self.max_participants = attributes[:'max_participants']
  end

  if attributes.key?(:'duration')
    self.duration = attributes[:'duration']
  end

  if attributes.key?(:'s3_key')
    self.s3_key = attributes[:'s3_key']
  end

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

Instance Attribute Details

#duration ⇒ Object

The duration in seconds of the call.



38
39
40
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 38

def duration
  @duration
end

#max_participants ⇒ Object

The number of participants on the call that were recorded.



35
36
37
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 35

def max_participants
  @max_participants
end

#recording_id ⇒ Object

An ID identifying the recording that was generated.



23
24
25
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 23

def recording_id
  @recording_id
end

#room_name ⇒ Object

The name of the room where the recording was made.



26
27
28
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 26

def room_name
  @room_name
end

#s3_key ⇒ Object

The location of the recording in the provided S3 bucket.



41
42
43
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 41

def s3_key
  @s3_key
end

#start_ts ⇒ Object

The Unix epoch time in seconds representing when the recording started.



29
30
31
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 29

def start_ts
  @start_ts
end

#status ⇒ Object

The status of the given recording.



32
33
34
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 32

def status
  @status
end

#tracks ⇒ Object

If the recording is a raw-tracks recording, a tracks field will be provided. If role permissions have been removed, the tracks field may be null.



44
45
46
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 44

def tracks
  @tracks
end

#type ⇒ Object

The type of recording that was generated.



20
21
22
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 20

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 257

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = Daily.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 69

def self.attribute_map
  {
    :'type' => :'type',
    :'recording_id' => :'recording_id',
    :'room_name' => :'room_name',
    :'start_ts' => :'start_ts',
    :'status' => :'status',
    :'max_participants' => :'max_participants',
    :'duration' => :'duration',
    :'s3_key' => :'s3_key',
    :'tracks' => :'tracks'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 233

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 104

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 89

def self.openapi_types
  {
    :'type' => :'String',
    :'recording_id' => :'String',
    :'room_name' => :'String',
    :'start_ts' => :'Integer',
    :'status' => :'String',
    :'max_participants' => :'Integer',
    :'duration' => :'Integer',
    :'s3_key' => :'String',
    :'tracks' => :'Array<GetRecordingInfo200ResponseTracksInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      recording_id == o.recording_id &&
      room_name == o.room_name &&
      start_ts == o.start_ts &&
      status == o.status &&
      max_participants == o.max_participants &&
      duration == o.duration &&
      s3_key == o.s3_key &&
      tracks == o.tracks
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 328

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 226

def hash
  [type, recording_id, room_name, start_ts, status, max_participants, duration, s3_key, tracks].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



165
166
167
168
169
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 165

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 304

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 310

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



298
299
300
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 298

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



173
174
175
176
177
178
179
180
 
# File 'lib/daily-ruby/models/recording_ready_to_download_payload.rb', line 173

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["cloud", "raw-tracks"])
  return false unless type_validator.valid?(@type)
  status_validator = EnumAttributeValidator.new('String', ["finished"])
  return false unless status_validator.valid?(@status)
  true
end