assemblyai 1.0.0.pre.beta.7 → 1.0.0.pre.beta.9

data/lib/assemblyai/realtime/types/session_begins.rb

@@ -1,50 +1,67 @@
 # frozen_string_literal: true
 
 require "date"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Realtime
     class SessionBegins
-      attr_reader :message_type, :session_id, :expires_at, :additional_properties
+      # @return [String] Describes the type of the message
+      attr_reader :message_type
+      # @return [String] Unique identifier for the established session
+      attr_reader :session_id
+      # @return [DateTime] Timestamp when this session will expire
+      attr_reader :expires_at
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param message_type [String]
+      OMIT = Object.new
+
+      # @param message_type [String] Describes the type of the message
       # @param session_id [String] Unique identifier for the established session
       # @param expires_at [DateTime] Timestamp when this session will expire
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Realtime::SessionBegins]
+      # @return [AssemblyAI::Realtime::SessionBegins]
       def initialize(message_type:, session_id:, expires_at:, additional_properties: nil)
-        # @type [String]
         @message_type = message_type
-        # @type [String] Unique identifier for the established session
         @session_id = session_id
-        # @type [DateTime] Timestamp when this session will expire
         @expires_at = expires_at
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "message_type": message_type, "session_id": session_id, "expires_at": expires_at }
       end
 
       # Deserialize a JSON object to an instance of SessionBegins
       #
-      # @param json_object [JSON]
-      # @return [Realtime::SessionBegins]
+      # @param json_object [String]
+      # @return [AssemblyAI::Realtime::SessionBegins]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        message_type = struct.message_type
-        session_id = struct.session_id
+        message_type = struct["message_type"]
+        session_id = struct["session_id"]
         expires_at = (DateTime.parse(parsed_json["expires_at"]) unless parsed_json["expires_at"].nil?)
-        new(message_type: message_type, session_id: session_id, expires_at: expires_at, additional_properties: struct)
+        new(
+          message_type: message_type,
+          session_id: session_id,
+          expires_at: expires_at,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of SessionBegins to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "message_type": @message_type, "session_id": @session_id, "expires_at": @expires_at }.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/realtime/types/session_information.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module AssemblyAI
+  class Realtime
+    # Information about the session that is concluding.
+    #  This message is sent at the end of the session, before the SessionTerminated
+    #  message.
+    class SessionInformation
+      # @return [String] Describes the type of the message
+      attr_reader :message_type
+      # @return [Float] The total duration of the audio in seconds
+      attr_reader :audio_duration_seconds
+      # @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 message_type [String] Describes the type of the message
+      # @param audio_duration_seconds [Float] The total duration of the audio in seconds
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [AssemblyAI::Realtime::SessionInformation]
+      def initialize(message_type:, audio_duration_seconds:, additional_properties: nil)
+        @message_type = message_type
+        @audio_duration_seconds = audio_duration_seconds
+        @additional_properties = additional_properties
+        @_field_set = { "message_type": message_type, "audio_duration_seconds": audio_duration_seconds }
+      end
+
+      # Deserialize a JSON object to an instance of SessionInformation
+      #
+      # @param json_object [String]
+      # @return [AssemblyAI::Realtime::SessionInformation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        message_type = struct["message_type"]
+        audio_duration_seconds = struct["audio_duration_seconds"]
+        new(
+          message_type: message_type,
+          audio_duration_seconds: audio_duration_seconds,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SessionInformation to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_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.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.message_type.is_a?(String) != false || raise("Passed value for field obj.message_type is not the expected type, validation failed.")
+        obj.audio_duration_seconds.is_a?(Float) != false || raise("Passed value for field obj.audio_duration_seconds is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/assemblyai/realtime/types/session_terminated.rb

@@ -1,41 +1,50 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Realtime
     class SessionTerminated
-      attr_reader :message_type, :additional_properties
+      # @return [String] Describes the type of the message
+      attr_reader :message_type
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param message_type [String]
+      OMIT = Object.new
+
+      # @param message_type [String] Describes the type of the message
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Realtime::SessionTerminated]
+      # @return [AssemblyAI::Realtime::SessionTerminated]
       def initialize(message_type:, additional_properties: nil)
-        # @type [String]
         @message_type = message_type
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "message_type": message_type }
       end
 
       # Deserialize a JSON object to an instance of SessionTerminated
       #
-      # @param json_object [JSON]
-      # @return [Realtime::SessionTerminated]
+      # @param json_object [String]
+      # @return [AssemblyAI::Realtime::SessionTerminated]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        message_type = struct.message_type
+        message_type = struct["message_type"]
         new(message_type: message_type, additional_properties: struct)
       end
 
       # Serialize an instance of SessionTerminated to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "message_type": @message_type }.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/realtime/types/terminate_session.rb

@@ -1,41 +1,50 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Realtime
     class TerminateSession
-      attr_reader :terminate_session, :additional_properties
+      # @return [Boolean] Set to true to end your streaming session forever
+      attr_reader :terminate_session
+      # @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 terminate_session [Boolean] Set to true to end your streaming session forever
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Realtime::TerminateSession]
+      # @return [AssemblyAI::Realtime::TerminateSession]
       def initialize(terminate_session:, additional_properties: nil)
-        # @type [Boolean] Set to true to end your streaming session forever
         @terminate_session = terminate_session
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "terminate_session": terminate_session }
       end
 
       # Deserialize a JSON object to an instance of TerminateSession
       #
-      # @param json_object [JSON]
-      # @return [Realtime::TerminateSession]
+      # @param json_object [String]
+      # @return [AssemblyAI::Realtime::TerminateSession]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        terminate_session = struct.terminate_session
+        terminate_session = struct["terminate_session"]
         new(terminate_session: terminate_session, additional_properties: struct)
       end
 
       # Serialize an instance of TerminateSession to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "terminate_session": @terminate_session }.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/realtime/types/word.rb

@@ -1,53 +1,71 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Realtime
     class Word
-      attr_reader :start, :end_, :confidence, :text, :additional_properties
+      # @return [Integer] Start time of the word in milliseconds
+      attr_reader :start
+      # @return [Integer] End time of the word in milliseconds
+      attr_reader :end_
+      # @return [Float] Confidence score of the word
+      attr_reader :confidence
+      # @return [String] The word itself
+      attr_reader :text
+      # @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 start [Integer] Start time of the word in milliseconds
       # @param end_ [Integer] End time of the word in milliseconds
       # @param confidence [Float] Confidence score of the word
       # @param text [String] The word itself
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Realtime::Word]
+      # @return [AssemblyAI::Realtime::Word]
       def initialize(start:, end_:, confidence:, text:, additional_properties: nil)
-        # @type [Integer] Start time of the word in milliseconds
         @start = start
-        # @type [Integer] End time of the word in milliseconds
         @end_ = end_
-        # @type [Float] Confidence score of the word
         @confidence = confidence
-        # @type [String] The word itself
         @text = text
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "start": start, "end": end_, "confidence": confidence, "text": text }
       end
 
       # Deserialize a JSON object to an instance of Word
       #
-      # @param json_object [JSON]
-      # @return [Realtime::Word]
+      # @param json_object [String]
+      # @return [AssemblyAI::Realtime::Word]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        start = struct.start
-        end_ = struct.end
-        confidence = struct.confidence
-        text = struct.text
-        new(start: start, end_: end_, confidence: confidence, text: text, additional_properties: struct)
+        start = struct["start"]
+        end_ = struct["end"]
+        confidence = struct["confidence"]
+        text = struct["text"]
+        new(
+          start: start,
+          end_: end_,
+          confidence: confidence,
+          text: text,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of Word to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "start": @start, "end": @end_, "confidence": @confidence, "text": @text }.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/streaming/types/receive_message.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../realtime/types/session_begins"
+require_relative "../../realtime/types/partial_transcript"
+require_relative "../../realtime/types/final_transcript"
+require_relative "../../realtime/types/session_information"
+require_relative "../../realtime/types/session_terminated"
+require_relative "../../realtime/types/realtime_error"
+
+module AssemblyAI
+  class Streaming
+    # Receive messages from the WebSocket
+    class ReceiveMessage
+      # Deserialize a JSON object to an instance of ReceiveMessage
+      #
+      # @param json_object [String]
+      # @return [AssemblyAI::Streaming::ReceiveMessage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          AssemblyAI::Realtime::SessionBegins.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::SessionBegins.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Realtime::PartialTranscript.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::PartialTranscript.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Realtime::FinalTranscript.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::FinalTranscript.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Realtime::SessionInformation.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::SessionInformation.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Realtime::SessionTerminated.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::SessionTerminated.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Realtime::RealtimeError.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::RealtimeError.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      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.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return AssemblyAI::Realtime::SessionBegins.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Realtime::PartialTranscript.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Realtime::FinalTranscript.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Realtime::SessionInformation.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Realtime::SessionTerminated.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Realtime::RealtimeError.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/assemblyai/{realtime → streaming}/types/send_message.rb

@@ -6,43 +6,55 @@ require_relative "../../realtime/types/force_end_utterance"
 require_relative "../../realtime/types/configure_end_utterance_silence_threshold"
 
 module AssemblyAI
-  class Realtime
+  class Streaming
     # Send messages to the WebSocket
     class SendMessage
       # Deserialize a JSON object to an instance of SendMessage
       #
-      # @param json_object [JSON]
-      # @return [Realtime::SendMessage]
+      # @param json_object [String]
+      # @return [AssemblyAI::Streaming::SendMessage]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         begin
           struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
-          return json_object
+          return json_object unless json_object.nil?
+
+          return nil
         rescue StandardError
           # noop
         end
         begin
-          Realtime::TerminateSession.validate_raw(obj: struct)
-          return Realtime::TerminateSession.from_json(json_object: json_object)
+          AssemblyAI::Realtime::TerminateSession.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::TerminateSession.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
         rescue StandardError
           # noop
         end
         begin
-          Realtime::ForceEndUtterance.validate_raw(obj: struct)
-          return Realtime::ForceEndUtterance.from_json(json_object: json_object)
+          AssemblyAI::Realtime::ForceEndUtterance.validate_raw(obj: struct)
+          return AssemblyAI::Realtime::ForceEndUtterance.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
         rescue StandardError
           # noop
         end
         begin
-          Realtime::ConfigureEndUtteranceSilenceThreshold.validate_raw(obj: struct)
-          return Realtime::ConfigureEndUtteranceSilenceThreshold.from_json(json_object: json_object)
+          AssemblyAI::Realtime::ConfigureEndUtteranceSilenceThreshold.validate_raw(obj: struct)
+          unless json_object.nil?
+            return AssemblyAI::Realtime::ConfigureEndUtteranceSilenceThreshold.from_json(json_object: json_object)
+          end
+
+          return nil
         rescue StandardError
           # noop
         end
         struct
       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]
@@ -53,17 +65,17 @@ module AssemblyAI
           # noop
         end
         begin
-          return Realtime::TerminateSession.validate_raw(obj: obj)
+          return AssemblyAI::Realtime::TerminateSession.validate_raw(obj: obj)
         rescue StandardError
           # noop
         end
         begin
-          return Realtime::ForceEndUtterance.validate_raw(obj: obj)
+          return AssemblyAI::Realtime::ForceEndUtterance.validate_raw(obj: obj)
         rescue StandardError
           # noop
         end
         begin
-          return Realtime::ConfigureEndUtteranceSilenceThreshold.validate_raw(obj: obj)
+          return AssemblyAI::Realtime::ConfigureEndUtteranceSilenceThreshold.validate_raw(obj: obj)
         rescue StandardError
           # noop
         end

data/lib/assemblyai/streaming/types/streaming.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module AssemblyAI
+  class Streaming
+    # The encoding of the audio data
+    class Streaming
+      PCM_S16LE = "pcm_s16le"
+      PCM_MULAW = "pcm_mulaw"
+    end
+  end
+end