Class: Bandwidth::ConferenceRecordingMetadata

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/conference_recording_metadata.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ConferenceRecordingMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
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
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The user account associated with the call.



19
20
21
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 19

def 
  @account_id
end

#channels ⇒ Object

Always ‘1` for conference recordings; multi-channel recordings are not supported on conferences.



34
35
36
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 34

def channels
  @channels
end

#conference_id ⇒ Object

The unique, Bandwidth-generated ID of the conference that was recorded



22
23
24
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 22

def conference_id
  @conference_id
end

#duration ⇒ Object

The duration of the recording in ISO-8601 format



31
32
33
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 31

def duration
  @duration
end

#end_time ⇒ Object

The time that the recording ended in ISO-8601 format



40
41
42
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 40

def end_time
  @end_time
end

#file_format ⇒ Object

Returns the value of attribute file_format.



42
43
44
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 42

def file_format
  @file_format
end

#media_url ⇒ Object

The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.



48
49
50
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 48

def media_url
  @media_url
end

#name ⇒ Object

The user-specified name of the conference that was recorded



25
26
27
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 25

def name
  @name
end

#recording_id ⇒ Object

The unique ID of this recording



28
29
30
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 28

def recording_id
  @recording_id
end

#recording_name ⇒ Object

A name to identify this recording.



51
52
53
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 51

def recording_name
  @recording_name
end

#start_time ⇒ Object

Time the call was started, in ISO 8601 format.



37
38
39
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 37

def start_time
  @start_time
end

#status ⇒ Object

The current status of the process. For recording, current possible values are ‘processing’, ‘partial’, ‘complete’, ‘deleted’, and ‘error’. For transcriptions, current possible values are ‘none’, ‘processing’, ‘available’, ‘error’, ‘timeout’, ‘file-size-too-big’, and ‘file-size-too-small’. Additional states may be added in the future, so your application must be tolerant of unknown values.



45
46
47
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 45

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



94
95
96
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 94

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 99

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 76

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'conference_id' => :'conferenceId',
    :'name' => :'name',
    :'recording_id' => :'recordingId',
    :'duration' => :'duration',
    :'channels' => :'channels',
    :'start_time' => :'startTime',
    :'end_time' => :'endTime',
    :'file_format' => :'fileFormat',
    :'status' => :'status',
    :'media_url' => :'mediaUrl',
    :'recording_name' => :'recordingName'
  }
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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 242

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



122
123
124
125
126
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 122

def self.openapi_nullable
  Set.new([
    :'media_url',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 104

def self.openapi_types
  {
    :'account_id' => :'String',
    :'conference_id' => :'String',
    :'name' => :'String',
    :'recording_id' => :'String',
    :'duration' => :'String',
    :'channels' => :'Integer',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'file_format' => :'FileFormatEnum',
    :'status' => :'String',
    :'media_url' => :'String',
    :'recording_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      conference_id == o.conference_id &&
      name == o.name &&
      recording_id == o.recording_id &&
      duration == o.duration &&
      channels == o.channels &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      file_format == o.file_format &&
      status == o.status &&
      media_url == o.media_url &&
      recording_name == o.recording_name
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


229
230
231
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 235

def hash
  [, conference_id, name, recording_id, duration, channels, start_time, end_time, file_format, status, media_url, recording_name].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



195
196
197
198
199
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 195

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 264

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



203
204
205
206
 
# File 'lib/bandwidth-sdk/models/conference_recording_metadata.rb', line 203

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end