Class: AssemblyAI::Transcripts::TranscriptReadyNotification

Inherits:
Object
  • Object
show all
Defined in:
lib/assemblyai/transcripts/types/transcript_ready_notification.rb

Overview

The notification when the transcript status is completed or error.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transcript_id:, status:, additional_properties: nil) ⇒ AssemblyAI::Transcripts::TranscriptReadyNotification

Parameters:

  • transcript_id (String) —

    The ID of the transcript

  • status (AssemblyAI::Transcripts::TranscriptReadyStatus) —

    The status of the transcript. Either completed or error.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
 
# File 'lib/assemblyai/transcripts/types/transcript_ready_notification.rb', line 27

def initialize(transcript_id:, status:, additional_properties: nil)
  @transcript_id = transcript_id
  @status = status
  @additional_properties = additional_properties
  @_field_set = { "transcript_id": transcript_id, "status": status }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



16
17
18
 
# File 'lib/assemblyai/transcripts/types/transcript_ready_notification.rb', line 16

def additional_properties
  @additional_properties
end

#status ⇒ AssemblyAI::Transcripts::TranscriptReadyStatus (readonly)

Returns The status of the transcript. Either completed or error.

Returns:



14
15
16
 
# File 'lib/assemblyai/transcripts/types/transcript_ready_notification.rb', line 14

def status
  @status
end

#transcript_id ⇒ String (readonly)

Returns The ID of the transcript.

Returns:

  • (String) —

    The ID of the transcript



12
13
14
 
# File 'lib/assemblyai/transcripts/types/transcript_ready_notification.rb', line 12

def transcript_id
  @transcript_id
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Transcripts::TranscriptReadyNotification

Deserialize a JSON object to an instance of TranscriptReadyNotification

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/assemblyai/transcripts/types/transcript_ready_notification.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  transcript_id = struct["transcript_id"]
  status = struct["status"]
  new(
    transcript_id: transcript_id,
    status: status,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


62
63
64
65
 
# File 'lib/assemblyai/transcripts/types/transcript_ready_notification.rb', line 62

def self.validate_raw(obj:)
  obj.transcript_id.is_a?(String) != false || raise("Passed value for field obj.transcript_id is not the expected type, validation failed.")
  obj.status.is_a?(AssemblyAI::Transcripts::TranscriptReadyStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TranscriptReadyNotification to a JSON object

Returns:

  • (String) 


52
53
54
 
# File 'lib/assemblyai/transcripts/types/transcript_ready_notification.rb', line 52

def to_json(*_args)
  @_field_set&.to_json
end