assemblyai 1.0.0.pre.beta.6 → 1.0.0.pre.beta.8

data/lib/assemblyai/transcripts/types/transcript_paragraph.rb

@@ -1,73 +1,101 @@
 # frozen_string_literal: true
 
 require_relative "transcript_word"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class TranscriptParagraph
-      attr_reader :text, :start, :end_, :confidence, :words, :speaker, :additional_properties
+      # @return [String]
+      attr_reader :text
+      # @return [Integer]
+      attr_reader :start
+      # @return [Integer]
+      attr_reader :end_
+      # @return [Float]
+      attr_reader :confidence
+      # @return [Array<AssemblyAI::Transcripts::TranscriptWord>]
+      attr_reader :words
+      # @return [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
+      attr_reader :speaker
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param text [String]
       # @param start [Integer]
       # @param end_ [Integer]
       # @param confidence [Float]
-      # @param words [Array<Transcripts::TranscriptWord>]
-      # @param speaker [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+      # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>]
+      # @param speaker [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptParagraph]
-      def initialize(text:, start:, end_:, confidence:, words:, speaker: nil, additional_properties: nil)
-        # @type [String]
+      # @return [AssemblyAI::Transcripts::TranscriptParagraph]
+      def initialize(text:, start:, end_:, confidence:, words:, speaker: OMIT, additional_properties: nil)
         @text = text
-        # @type [Integer]
         @start = start
-        # @type [Integer]
         @end_ = end_
-        # @type [Float]
         @confidence = confidence
-        # @type [Array<Transcripts::TranscriptWord>]
         @words = words
-        # @type [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
-        @speaker = speaker
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
+        @_field_set = {
+          "text": text,
+          "start": start,
+          "end": end_,
+          "confidence": confidence,
+          "words": words,
+          "speaker": speaker
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of TranscriptParagraph
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptParagraph]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptParagraph]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        text = struct.text
-        start = struct.start
-        end_ = struct.end
-        confidence = struct.confidence
+        text = struct["text"]
+        start = struct["start"]
+        end_ = struct["end"]
+        confidence = struct["confidence"]
         words = parsed_json["words"]&.map do |v|
           v = v.to_json
-          Transcripts::TranscriptWord.from_json(json_object: v)
+          AssemblyAI::Transcripts::TranscriptWord.from_json(json_object: v)
         end
-        speaker = struct.speaker
-        new(text: text, start: start, end_: end_, confidence: confidence, words: words, speaker: speaker,
-            additional_properties: struct)
+        speaker = struct["speaker"]
+        new(
+          text: text,
+          start: start,
+          end_: end_,
+          confidence: confidence,
+          words: words,
+          speaker: speaker,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptParagraph to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "text": @text,
-          "start": @start,
-          "end": @end_,
-          "confidence": @confidence,
-          "words": @words,
-          "speaker": @speaker
-        }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]

data/lib/assemblyai/transcripts/types/transcript_ready_notification.rb

@@ -1,53 +1,67 @@
 # frozen_string_literal: true
 
 require_relative "transcript_ready_status"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     # The notification when the transcript status is completed or error.
     class TranscriptReadyNotification
-      attr_reader :transcript_id, :status, :additional_properties
+      # @return [String] The ID of the transcript
+      attr_reader :transcript_id
+      # @return [AssemblyAI::Transcripts::TranscriptReadyStatus] The status of the transcript. Either completed or error.
+      attr_reader :status
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param transcript_id [String] The ID of the transcript
-      # @param status [Transcripts::TranscriptReadyStatus] The status of the transcript. Either completed or error.
+      # @param status [AssemblyAI::Transcripts::TranscriptReadyStatus] The status of the transcript. Either completed or error.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptReadyNotification]
+      # @return [AssemblyAI::Transcripts::TranscriptReadyNotification]
       def initialize(transcript_id:, status:, additional_properties: nil)
-        # @type [String] The ID of the transcript
         @transcript_id = transcript_id
-        # @type [Transcripts::TranscriptReadyStatus] The status of the transcript. Either completed or error.
         @status = status
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "transcript_id": transcript_id, "status": status }
       end
 
       # Deserialize a JSON object to an instance of TranscriptReadyNotification
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptReadyNotification]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptReadyNotification]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        transcript_id = struct.transcript_id
-        status = struct.status
-        new(transcript_id: transcript_id, status: status, additional_properties: struct)
+        transcript_id = struct["transcript_id"]
+        status = struct["status"]
+        new(
+          transcript_id: transcript_id,
+          status: status,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptReadyNotification to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "transcript_id": @transcript_id, "status": @status }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]
       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?(Transcripts::TranscriptReadyStatus) != false || raise("Passed value for field obj.status 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
     end
   end

data/lib/assemblyai/transcripts/types/transcript_sentence.rb

@@ -1,73 +1,101 @@
 # frozen_string_literal: true
 
 require_relative "transcript_word"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class TranscriptSentence
-      attr_reader :text, :start, :end_, :confidence, :words, :speaker, :additional_properties
+      # @return [String]
+      attr_reader :text
+      # @return [Integer]
+      attr_reader :start
+      # @return [Integer]
+      attr_reader :end_
+      # @return [Float]
+      attr_reader :confidence
+      # @return [Array<AssemblyAI::Transcripts::TranscriptWord>]
+      attr_reader :words
+      # @return [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
+      attr_reader :speaker
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param text [String]
       # @param start [Integer]
       # @param end_ [Integer]
       # @param confidence [Float]
-      # @param words [Array<Transcripts::TranscriptWord>]
-      # @param speaker [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+      # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>]
+      # @param speaker [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptSentence]
-      def initialize(text:, start:, end_:, confidence:, words:, speaker: nil, additional_properties: nil)
-        # @type [String]
+      # @return [AssemblyAI::Transcripts::TranscriptSentence]
+      def initialize(text:, start:, end_:, confidence:, words:, speaker: OMIT, additional_properties: nil)
         @text = text
-        # @type [Integer]
         @start = start
-        # @type [Integer]
         @end_ = end_
-        # @type [Float]
         @confidence = confidence
-        # @type [Array<Transcripts::TranscriptWord>]
         @words = words
-        # @type [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
-        @speaker = speaker
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
+        @_field_set = {
+          "text": text,
+          "start": start,
+          "end": end_,
+          "confidence": confidence,
+          "words": words,
+          "speaker": speaker
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of TranscriptSentence
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptSentence]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptSentence]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        text = struct.text
-        start = struct.start
-        end_ = struct.end
-        confidence = struct.confidence
+        text = struct["text"]
+        start = struct["start"]
+        end_ = struct["end"]
+        confidence = struct["confidence"]
         words = parsed_json["words"]&.map do |v|
           v = v.to_json
-          Transcripts::TranscriptWord.from_json(json_object: v)
+          AssemblyAI::Transcripts::TranscriptWord.from_json(json_object: v)
         end
-        speaker = struct.speaker
-        new(text: text, start: start, end_: end_, confidence: confidence, words: words, speaker: speaker,
-            additional_properties: struct)
+        speaker = struct["speaker"]
+        new(
+          text: text,
+          start: start,
+          end_: end_,
+          confidence: confidence,
+          words: words,
+          speaker: speaker,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptSentence to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "text": @text,
-          "start": @start,
-          "end": @end_,
-          "confidence": @confidence,
-          "words": @words,
-          "speaker": @speaker
-        }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]

data/lib/assemblyai/transcripts/types/transcript_status.rb

@@ -2,7 +2,8 @@
 
 module AssemblyAI
   class Transcripts
-    # The status of your transcript. Possible values are queued, processing, completed, or error.
+    # The status of your transcript. Possible values are queued, processing,
+    #  completed, or error.
     class TranscriptStatus
       QUEUED = "queued"
       PROCESSING = "processing"

data/lib/assemblyai/transcripts/types/transcript_utterance.rb

@@ -1,73 +1,97 @@
 # frozen_string_literal: true
 
 require_relative "transcript_word"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class TranscriptUtterance
-      attr_reader :confidence, :start, :end_, :text, :words, :speaker, :additional_properties
+      # @return [Float] The confidence score for the transcript of this utterance
+      attr_reader :confidence
+      # @return [Integer] The starting time, in milliseconds, of the utterance in the audio file
+      attr_reader :start
+      # @return [Integer] The ending time, in milliseconds, of the utterance in the audio file
+      attr_reader :end_
+      # @return [String] The text for this utterance
+      attr_reader :text
+      # @return [Array<AssemblyAI::Transcripts::TranscriptWord>] The words in the utterance.
+      attr_reader :words
+      # @return [String] The speaker of this utterance, where each speaker is assigned a sequential
+      #  capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.
+      attr_reader :speaker
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param confidence [Float] The confidence score for the transcript of this utterance
       # @param start [Integer] The starting time, in milliseconds, of the utterance in the audio file
       # @param end_ [Integer] The ending time, in milliseconds, of the utterance in the audio file
       # @param text [String] The text for this utterance
-      # @param words [Array<Transcripts::TranscriptWord>] The words in the utterance.
-      # @param speaker [String] The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.
+      # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>] The words in the utterance.
+      # @param speaker [String] The speaker of this utterance, where each speaker is assigned a sequential
+      #  capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptUtterance]
+      # @return [AssemblyAI::Transcripts::TranscriptUtterance]
       def initialize(confidence:, start:, end_:, text:, words:, speaker:, additional_properties: nil)
-        # @type [Float] The confidence score for the transcript of this utterance
         @confidence = confidence
-        # @type [Integer] The starting time, in milliseconds, of the utterance in the audio file
         @start = start
-        # @type [Integer] The ending time, in milliseconds, of the utterance in the audio file
         @end_ = end_
-        # @type [String] The text for this utterance
         @text = text
-        # @type [Array<Transcripts::TranscriptWord>] The words in the utterance.
         @words = words
-        # @type [String] The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.
         @speaker = speaker
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = {
+          "confidence": confidence,
+          "start": start,
+          "end": end_,
+          "text": text,
+          "words": words,
+          "speaker": speaker
+        }
       end
 
       # Deserialize a JSON object to an instance of TranscriptUtterance
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptUtterance]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptUtterance]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        confidence = struct.confidence
-        start = struct.start
-        end_ = struct.end
-        text = struct.text
+        confidence = struct["confidence"]
+        start = struct["start"]
+        end_ = struct["end"]
+        text = struct["text"]
         words = parsed_json["words"]&.map do |v|
           v = v.to_json
-          Transcripts::TranscriptWord.from_json(json_object: v)
+          AssemblyAI::Transcripts::TranscriptWord.from_json(json_object: v)
         end
-        speaker = struct.speaker
-        new(confidence: confidence, start: start, end_: end_, text: text, words: words, speaker: speaker,
-            additional_properties: struct)
+        speaker = struct["speaker"]
+        new(
+          confidence: confidence,
+          start: start,
+          end_: end_,
+          text: text,
+          words: words,
+          speaker: speaker,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptUtterance to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "confidence": @confidence,
-          "start": @start,
-          "end": @end_,
-          "text": @text,
-          "words": @words,
-          "speaker": @speaker
-        }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]

data/lib/assemblyai/transcripts/types/transcript_word.rb

@@ -1,58 +1,89 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class TranscriptWord
-      attr_reader :confidence, :start, :end_, :text, :speaker, :additional_properties
+      # @return [Float]
+      attr_reader :confidence
+      # @return [Integer]
+      attr_reader :start
+      # @return [Integer]
+      attr_reader :end_
+      # @return [String]
+      attr_reader :text
+      # @return [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
+      attr_reader :speaker
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param confidence [Float]
       # @param start [Integer]
       # @param end_ [Integer]
       # @param text [String]
-      # @param speaker [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+      # @param speaker [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptWord]
-      def initialize(confidence:, start:, end_:, text:, speaker: nil, additional_properties: nil)
-        # @type [Float]
+      # @return [AssemblyAI::Transcripts::TranscriptWord]
+      def initialize(confidence:, start:, end_:, text:, speaker: OMIT, additional_properties: nil)
         @confidence = confidence
-        # @type [Integer]
         @start = start
-        # @type [Integer]
         @end_ = end_
-        # @type [String]
         @text = text
-        # @type [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
-        @speaker = speaker
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
+        @_field_set = {
+          "confidence": confidence,
+          "start": start,
+          "end": end_,
+          "text": text,
+          "speaker": speaker
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of TranscriptWord
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptWord]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptWord]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        confidence = struct.confidence
-        start = struct.start
-        end_ = struct.end
-        text = struct.text
-        speaker = struct.speaker
-        new(confidence: confidence, start: start, end_: end_, text: text, speaker: speaker,
-            additional_properties: struct)
+        confidence = struct["confidence"]
+        start = struct["start"]
+        end_ = struct["end"]
+        text = struct["text"]
+        speaker = struct["speaker"]
+        new(
+          confidence: confidence,
+          start: start,
+          end_: end_,
+          text: text,
+          speaker: speaker,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptWord to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "confidence": @confidence, "start": @start, "end": @end_, "text": @text, "speaker": @speaker }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]