class PureCloud::Recording
Attributes
Annotations that belong to the recording.
The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The type of archive medium used. Example: CloudArchive
The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Represents an email transcript
The end time of the recording. Null when there is no playable media.
The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Represents the current file state for a recording. Examples: Uploading, Archived, etc
The globally unique identifier for the object.
How many archive restorations the organization is allowed to have.
The type of media that the recording is. At the moment that could be audio, chat, or email.
The different mediaUris for the recording. Null when there is no playable media.
Represents a messaging transcript
Duration of transcoded media in milliseconds
Size of transcoded media in bytes. 0 if there is no transcoded media.
Role of the file recording. It can be either customer_experience or adhoc.
The remaining archive restorations the organization has.
The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The URI for this object
The session id represents an external resource id, such as email, call, chat, etc
The start time of the recording. Null when there is no playable media.
Represents a chat transcript
The users participating in the conversation
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/recording.rb, line 104 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'conversation_id' => :'conversationId', :'path' => :'path', :'start_time' => :'startTime', :'end_time' => :'endTime', :'media' => :'media', :'annotations' => :'annotations', :'transcript' => :'transcript', :'email_transcript' => :'emailTranscript', :'messaging_transcript' => :'messagingTranscript', :'file_state' => :'fileState', :'restore_expiration_time' => :'restoreExpirationTime', :'media_uris' => :'mediaUris', :'estimated_transcode_time_ms' => :'estimatedTranscodeTimeMs', :'actual_transcode_time_ms' => :'actualTranscodeTimeMs', :'archive_date' => :'archiveDate', :'archive_medium' => :'archiveMedium', :'delete_date' => :'deleteDate', :'export_date' => :'exportDate', :'exported_date' => :'exportedDate', :'output_duration_ms' => :'outputDurationMs', :'output_size_in_bytes' => :'outputSizeInBytes', :'max_allowed_restorations_for_org' => :'maxAllowedRestorationsForOrg', :'remaining_restorations_allowed_for_org' => :'remainingRestorationsAllowedForOrg', :'session_id' => :'sessionId', :'users' => :'users', :'recording_file_role' => :'recordingFileRole', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/recording.rb, line 235 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'conversationId') self.conversation_id = attributes[:'conversationId'] end if attributes.has_key?(:'path') self.path = attributes[:'path'] end if attributes.has_key?(:'startTime') self.start_time = attributes[:'startTime'] end if attributes.has_key?(:'endTime') self.end_time = attributes[:'endTime'] end if attributes.has_key?(:'media') self.media = attributes[:'media'] end if attributes.has_key?(:'annotations') if (value = attributes[:'annotations']).is_a?(Array) self.annotations = value end end if attributes.has_key?(:'transcript') if (value = attributes[:'transcript']).is_a?(Array) self.transcript = value end end if attributes.has_key?(:'emailTranscript') if (value = attributes[:'emailTranscript']).is_a?(Array) self.email_transcript = value end end if attributes.has_key?(:'messagingTranscript') if (value = attributes[:'messagingTranscript']).is_a?(Array) self.messaging_transcript = value end end if attributes.has_key?(:'fileState') self.file_state = attributes[:'fileState'] end if attributes.has_key?(:'restoreExpirationTime') self.restore_expiration_time = attributes[:'restoreExpirationTime'] end if attributes.has_key?(:'mediaUris') if (value = attributes[:'mediaUris']).is_a?(Array) self.media_uris = value end end if attributes.has_key?(:'estimatedTranscodeTimeMs') self.estimated_transcode_time_ms = attributes[:'estimatedTranscodeTimeMs'] end if attributes.has_key?(:'actualTranscodeTimeMs') self.actual_transcode_time_ms = attributes[:'actualTranscodeTimeMs'] end if attributes.has_key?(:'archiveDate') self.archive_date = attributes[:'archiveDate'] end if attributes.has_key?(:'archiveMedium') self.archive_medium = attributes[:'archiveMedium'] end if attributes.has_key?(:'deleteDate') self.delete_date = attributes[:'deleteDate'] end if attributes.has_key?(:'exportDate') self.export_date = attributes[:'exportDate'] end if attributes.has_key?(:'exportedDate') self.exported_date = attributes[:'exportedDate'] end if attributes.has_key?(:'outputDurationMs') self.output_duration_ms = attributes[:'outputDurationMs'] end if attributes.has_key?(:'outputSizeInBytes') self.output_size_in_bytes = attributes[:'outputSizeInBytes'] end if attributes.has_key?(:'maxAllowedRestorationsForOrg') self.max_allowed_restorations_for_org = attributes[:'maxAllowedRestorationsForOrg'] end if attributes.has_key?(:'remainingRestorationsAllowedForOrg') self.remaining_restorations_allowed_for_org = attributes[:'remainingRestorationsAllowedForOrg'] end if attributes.has_key?(:'sessionId') self.session_id = attributes[:'sessionId'] end if attributes.has_key?(:'users') if (value = attributes[:'users']).is_a?(Array) self.users = value end end if attributes.has_key?(:'recordingFileRole') self.recording_file_role = attributes[:'recordingFileRole'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/recording.rb, line 169 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'conversation_id' => :'String', :'path' => :'String', :'start_time' => :'String', :'end_time' => :'String', :'media' => :'String', :'annotations' => :'Array<Annotation>', :'transcript' => :'Array<ChatMessage>', :'email_transcript' => :'Array<RecordingEmailMessage>', :'messaging_transcript' => :'Array<RecordingMessagingMessage>', :'file_state' => :'String', :'restore_expiration_time' => :'DateTime', :'media_uris' => :'Hash<String, MediaResult>', :'estimated_transcode_time_ms' => :'Integer', :'actual_transcode_time_ms' => :'Integer', :'archive_date' => :'DateTime', :'archive_medium' => :'String', :'delete_date' => :'DateTime', :'export_date' => :'DateTime', :'exported_date' => :'DateTime', :'output_duration_ms' => :'Integer', :'output_size_in_bytes' => :'Integer', :'max_allowed_restorations_for_org' => :'Integer', :'remaining_restorations_allowed_for_org' => :'Integer', :'session_id' => :'String', :'users' => :'Array<User>', :'recording_file_role' => :'String', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/recording.rb, line 838 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && conversation_id == o.conversation_id && path == o.path && start_time == o.start_time && end_time == o.end_time && media == o.media && annotations == o.annotations && transcript == o.transcript && email_transcript == o.email_transcript && messaging_transcript == o.messaging_transcript && file_state == o.file_state && restore_expiration_time == o.restore_expiration_time && media_uris == o.media_uris && estimated_transcode_time_ms == o.estimated_transcode_time_ms && actual_transcode_time_ms == o.actual_transcode_time_ms && archive_date == o.archive_date && archive_medium == o.archive_medium && delete_date == o.delete_date && export_date == o.export_date && exported_date == o.exported_date && output_duration_ms == o.output_duration_ms && output_size_in_bytes == o.output_size_in_bytes && max_allowed_restorations_for_org == o.max_allowed_restorations_for_org && remaining_restorations_allowed_for_org == o.remaining_restorations_allowed_for_org && session_id == o.session_id && users == o.users && recording_file_role == o.recording_file_role && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/recording.rb, line 904 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
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/recording.rb, line 964 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
Custom attribute writer method checking allowed values (enum). @param [Object] archive_medium
Object to be assigned
# File lib/purecloudplatformclientv2/models/recording.rb, line 761 def archive_medium=(archive_medium) allowed_values = ["CLOUDARCHIVE"] if archive_medium && !allowed_values.include?(archive_medium) fail ArgumentError, "invalid value for 'archive_medium', must be one of #{allowed_values}." end @archive_medium = archive_medium end
build the object from hash
# File lib/purecloudplatformclientv2/models/recording.rb, line 885 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/recording.rb, line 874 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] file_state
Object to be assigned
# File lib/purecloudplatformclientv2/models/recording.rb, line 722 def file_state=(file_state) allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING", "ERROR"] if file_state && !allowed_values.include?(file_state) fail ArgumentError, "invalid value for 'file_state', must be one of #{allowed_values}." end @file_state = file_state end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/recording.rb, line 880 def hash [id, name, conversation_id, path, start_time, end_time, media, annotations, transcript, email_transcript, messaging_transcript, file_state, restore_expiration_time, media_uris, estimated_transcode_time_ms, actual_transcode_time_ms, archive_date, archive_medium, delete_date, export_date, exported_date, output_duration_ms, output_size_in_bytes, max_allowed_restorations_for_org, remaining_restorations_allowed_for_org, session_id, users, recording_file_role, self_uri].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/recording.rb, line 519 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] recording_file_role
Object to be assigned
# File lib/purecloudplatformclientv2/models/recording.rb, line 820 def recording_file_role=(recording_file_role) allowed_values = ["CUSTOMER_EXPERIENCE", "ADHOC"] if recording_file_role && !allowed_values.include?(recording_file_role) fail ArgumentError, "invalid value for 'recording_file_role', must be one of #{allowed_values}." end @recording_file_role = recording_file_role end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/recording.rb, line 952 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
# File lib/purecloudplatformclientv2/models/recording.rb, line 942 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/recording.rb, line 528 def valid? allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING", "ERROR"] if @file_state && !allowed_values.include?(@file_state) return false end allowed_values = ["CLOUDARCHIVE"] if @archive_medium && !allowed_values.include?(@archive_medium) return false end allowed_values = ["CUSTOMER_EXPERIENCE", "ADHOC"] if @recording_file_role && !allowed_values.include?(@recording_file_role) return false end end