assemblyai 1.0.0.pre.beta.2 → 1.0.0.pre.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd39472d57199089cb681e33ce94ea14d140afc6018ee578281188e35de6ee58
-  data.tar.gz: 6d2e5f6222b4ec927f296434c3a263573bdcbca1d91aeebd41186b216c956d52
+  metadata.gz: 82e3b0e81020edc6f6bd8589a23b2d30c78c2138f6b5a9ea1762371c92eacf37
+  data.tar.gz: c7a833cd083ddc051a45cb3a7f27ef5e8eb3b7915808360e5cfe60aa23a5b308
 SHA512:
-  metadata.gz: b59ba30872b39a055dbc337545776e57d6fcbd89731fe7eceb63eac274030660b9fae00f118926c83ef2fb51a457f5e7d1cb52197ac1ce9d62c94cbde96b4645
-  data.tar.gz: 92413fba5d2e366018bc971fa95bea0cd1829e2f1c9b59079c103168b35569b266c60fdd95f5825ebd1d8ad81efd5120f5c5a604f2c783d00b3c615a17843c8b
+  metadata.gz: b064a231af8d12c62c817e8bc9708fc6657b725f13b4608869c4f323f5a3f88e88bfa57c32a4b1b91d3436f42c0f514d7f464cdd125718bf4c4b331033bb26dc
+  data.tar.gz: f462ce60f2ca15536c09cdab1fa4f0a81033bb80ac745e9dbf8dc1268b3129465ddebec0ebdb37b07c1b328b8051f6c7fdfb4bccfcb9097cf4e30e685b8c513e

data/lib/assemblyai/transcripts/list_by_url_client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/transcript_list"
+require "async"
+
+module AssemblyAI
+  # :nodoc:
+  class TranscriptsClient
+    # Retrieve a list of transcripts you created, this is used for pagination to easily retrieve the next page of transcripts
+    #
+    # @param url [String] The URL to retrieve the transcript list from
+    # @param request_options [RequestOptions]
+    # @return [Transcripts::TranscriptList]
+    #
+    # @example Retrieve the next page of results
+    #   client = AssemblyAI::Client.new(api_key: "YOUR_API_KEY")
+    #   transcript_list = client.transcripts.list(limit: 1)
+    #   client.transcripts.list_by_url(url: transcript_list.page_details.next_url)
+    def list_by_url(url: nil, request_options: nil)
+      url = "/v2/transcript" if url.nil?
+      response = @request_client.conn.get(url) do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+      end
+      Transcripts::TranscriptList.from_json(json_object: response.body)
+    end
+  end
+
+  # :nodoc:
+  class AsyncTranscriptsClient
+    # Retrieve a list of transcripts you created
+    #
+    # @param url [String] The URL to retrieve the transcript list from
+    # @param request_options [RequestOptions]
+    # @return [Transcripts::TranscriptList]
+    #
+    # @example Retrieve the next page of results
+    #   client = AssemblyAI::AsyncClient.new(api_key: "YOUR_API_KEY")
+    #   Sync do
+    #     transcript_list = client.transcripts.list(limit: 1).wait
+    #     client.transcripts.list_by_url(url: transcript_list.page_details.next_url)
+    #   end
+    def list_by_url(url: nil, request_options: nil)
+      Async do
+        url = "/v2/transcript" if url.nil?
+        response = @request_client.conn.get(url) do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        end
+        Transcripts::TranscriptList.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/assemblyai/transcripts/polling_client.rb

@@ -26,7 +26,8 @@ module AssemblyAI
     # Create a transcript from an audio or video file that is accessible via a URL.
     # .transcribe polls for completion of the transcription, while the .submit function does not.
     #
-    # @param language_code [TRANSCRIPT_LANGUAGE_CODE]
+    # @param speech_model [Transcripts::SpeechModel]
+    # @param language_code [Transcripts::TranscriptLanguageCode]
     # @param punctuate [Boolean] Enable Automatic Punctuation, can be true or false
     # @param format_text [Boolean] Enable Text Formatting, can be true or false
     # @param dual_channel [Boolean] Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false.
@@ -37,13 +38,13 @@ module AssemblyAI
     # @param audio_start_from [Integer] The point in time, in milliseconds, to begin transcribing in your media file
     # @param audio_end_at [Integer] The point in time, in milliseconds, to stop transcribing in your media file
     # @param word_boost [Array<String>] The list of custom vocabulary to boost transcription probability for
-    # @param boost_param [TRANSCRIPT_BOOST_PARAM] The word boost parameter value
+    # @param boost_param [Transcripts::TranscriptBoostParam] The word boost parameter value
     # @param filter_profanity [Boolean] Filter profanity from the transcribed text, can be true or false
     # @param redact_pii [Boolean] Redact PII from the transcribed text using the Redact PII model, can be true or false
     # @param redact_pii_audio [Boolean] Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_audio_quality [REDACT_PII_AUDIO_QUALITY] Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_policies [Array<Transcripts::PII_POLICY>] The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_sub [SUBSTITUTION_POLICY]
+    # @param redact_pii_audio_quality [Transcripts::RedactPiiAudioQuality] Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+    # @param redact_pii_policies [Array<Transcripts::PiiPolicy>] The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+    # @param redact_pii_sub [Transcripts::SubstitutionPolicy]
     # @param speaker_labels [Boolean] Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false
     # @param speakers_expected [Integer] Tells the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
     # @param content_safety [Boolean] Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false
@@ -60,8 +61,8 @@ module AssemblyAI
     # @param speech_threshold [Float] Reject audio files that contain less than this fraction of speech.
     #   Valid values are in the range [0, 1] inclusive.
     # @param summarization [Boolean] Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false
-    # @param summary_model [SUMMARY_MODEL] The model to summarize the transcript
-    # @param summary_type [SUMMARY_TYPE] The type of summary
+    # @param summary_model [Transcripts::SummaryModel] The model to summarize the transcript
+    # @param summary_type [Transcripts::SummaryType] The type of summary
     # @param custom_topics [Boolean] Whether custom topics is enabled, either true or false
     # @param topics [Array<String>] The list of custom topics provided, if custom topics is enabled
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -69,10 +70,10 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @param polling_options [Transcripts::PollingOptions] Configuration options for polling requests.
     # @return [Transcripts::Transcript]
-    def transcribe(audio_url:, language_code: nil, punctuate: nil, format_text: nil, dual_channel: nil, webhook_url: nil,
-                   webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, language_detection: nil, custom_spelling: nil, disfluencies: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, additional_properties: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
-      transcript = submit(audio_url: audio_url, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel, webhook_url: webhook_url,
-                          webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options)
+    def transcribe(audio_url:, speech_model: nil, language_code: nil, punctuate: nil, format_text: nil, dual_channel: nil,
+                   webhook_url: nil, webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, language_detection: nil, custom_spelling: nil, disfluencies: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, additional_properties: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
+      transcript = submit(audio_url: audio_url, speech_model: speech_model, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel,
+                          webhook_url: webhook_url, webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options)
       poll_transcript(transcript_id: transcript.id, polling_options: polling_options)
     end
 
@@ -81,7 +82,7 @@ module AssemblyAI
       timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
       loop do
         transcript = get(transcript_id: transcript_id)
-        if transcript.status == :completed || transcript.status == :error
+        if transcript.status == Transcripts::TranscriptStatus::COMPLETED || transcript.status == Transcripts::TranscriptStatus::ERROR
           return transcript
         elsif polling_options.timeout.positive? && Time.now - start_time > timeout_in_seconds
           raise StandardError, "Polling timeout"
@@ -99,7 +100,8 @@ module AssemblyAI
     # Create a transcript from an audio or video file that is accessible via a URL.
     # .transcribe polls for completion of the transcription, while the .submit function does not.
     #
-    # @param language_code [TRANSCRIPT_LANGUAGE_CODE]
+    # @param speech_model [Transcripts::SpeechModel]
+    # @param language_code [Transcripts::TranscriptLanguageCode]
     # @param punctuate [Boolean] Enable Automatic Punctuation, can be true or false
     # @param format_text [Boolean] Enable Text Formatting, can be true or false
     # @param dual_channel [Boolean] Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false.
@@ -110,13 +112,13 @@ module AssemblyAI
     # @param audio_start_from [Integer] The point in time, in milliseconds, to begin transcribing in your media file
     # @param audio_end_at [Integer] The point in time, in milliseconds, to stop transcribing in your media file
     # @param word_boost [Array<String>] The list of custom vocabulary to boost transcription probability for
-    # @param boost_param [TRANSCRIPT_BOOST_PARAM] The word boost parameter value
+    # @param boost_param [Transcripts::TranscriptBoostParam] The word boost parameter value
     # @param filter_profanity [Boolean] Filter profanity from the transcribed text, can be true or false
     # @param redact_pii [Boolean] Redact PII from the transcribed text using the Redact PII model, can be true or false
     # @param redact_pii_audio [Boolean] Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_audio_quality [REDACT_PII_AUDIO_QUALITY] Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_policies [Array<Transcripts::PII_POLICY>] The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_sub [SUBSTITUTION_POLICY]
+    # @param redact_pii_audio_quality [Transcripts::RedactPiiAudioQuality] Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+    # @param redact_pii_policies [Array<Transcripts::PiiPolicy>] The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+    # @param redact_pii_sub [Transcripts::SubstitutionPolicy]
     # @param speaker_labels [Boolean] Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false
     # @param speakers_expected [Integer] Tells the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
     # @param content_safety [Boolean] Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false
@@ -133,20 +135,20 @@ module AssemblyAI
     # @param speech_threshold [Float] Reject audio files that contain less than this fraction of speech.
     #   Valid values are in the range [0, 1] inclusive.
     # @param summarization [Boolean] Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false
-    # @param summary_model [SUMMARY_MODEL] The model to summarize the transcript
-    # @param summary_type [SUMMARY_TYPE] The type of summary
+    # @param summary_model [Transcripts::SummaryModel] The model to summarize the transcript
+    # @param summary_type [Transcripts::SummaryType] The type of summary
     # @param custom_topics [Boolean] Whether custom topics is enabled, either true or false
     # @param topics [Array<String>] The list of custom topics provided, if custom topics is enabled
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @param audio_url [String] The URL of the audio or video file to transcribe.
     # @param request_options [RequestOptions]
-    # @param polling_options [PollingOptions] Configuration options for polling requests.
+    # @param polling_options [Transcripts::PollingOptions] Configuration options for polling requests.
     # @return [Transcripts::Transcript]
-    def transcribe(audio_url:, language_code: nil, punctuate: nil, format_text: nil, dual_channel: nil, webhook_url: nil,
-                   webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, language_detection: nil, custom_spelling: nil, disfluencies: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, additional_properties: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
+    def transcribe(audio_url:, speech_model: nil, language_code: nil, punctuate: nil, format_text: nil, dual_channel: nil,
+                   webhook_url: nil, webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, language_detection: nil, custom_spelling: nil, disfluencies: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, additional_properties: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
       Async do
-        transcript = submit(audio_url: audio_url, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel, webhook_url: webhook_url,
-                            webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options).wait
+        transcript = submit(audio_url: audio_url, speech_model: speech_model, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel,
+                            webhook_url: webhook_url, webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options).wait
         poll_transcript(transcript_id: transcript.id, polling_options: polling_options).wait
       end
     end
@@ -157,7 +159,7 @@ module AssemblyAI
         timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
         loop do
           transcript = get(transcript_id: transcript_id).wait
-          if transcript.status == :completed || transcript.status == :error
+          if transcript.status == Transcripts::TranscriptStatus::COMPLETED || transcript.status == Transcripts::TranscriptStatus::ERROR
             break transcript
           elsif polling_options.timeout.positive? && Time.now - start_time > timeout_in_seconds
             raise StandardError, "Polling timeout"

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

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
 module AssemblyAI
-    class Transcripts
-      # Configuration options for polling requests.
-      class PollingOptions
-        attr_reader :interval, :timeout
-  
-        # @param interval [Integer] The amount of time to wait between polling requests, in milliseconds. Defaults to 3000.
-        # @param timeout [Integer] The maximum amount of time to wait for the transcript to be ready, in milliseconds. Defaults to -1, which means poll forever.
-        # @return [Transcripts::PollingOptions]
-        def initialize(interval: 3000, timeout: -1)
-          # @type [Integer] The amount of time to wait between polling requests, in milliseconds.
-          @interval = interval
-          # @type [Integer] The maximum amount of time to wait for the transcript to be ready, in milliseconds.
-          @timeout = timeout
-        end
+  class Transcripts
+    # Configuration options for polling requests.
+    class PollingOptions
+      attr_reader :interval, :timeout
+
+      # @param interval [Integer] The amount of time to wait between polling requests, in milliseconds. Defaults to 3000.
+      # @param timeout [Integer] The maximum amount of time to wait for the transcript to be ready, in milliseconds. Defaults to -1, which means poll forever.
+      # @return [Transcripts::PollingOptions]
+      def initialize(interval: 3000, timeout: -1)
+        # @type [Integer] The amount of time to wait between polling requests, in milliseconds.
+        @interval = interval
+        # @type [Integer] The maximum amount of time to wait for the transcript to be ready, in milliseconds.
+        @timeout = timeout
       end
     end
   end
-  
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "transcript_ready_status"
+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
+
+      # @param transcript_id [String] The ID of the transcript
+      # @param status [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]
+      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
+      end
+
+      # Deserialize a JSON object to an instance of TranscriptReadyNotification
+      #
+      # @param json_object [JSON]
+      # @return [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)
+      end
+
+      # Serialize an instance of TranscriptReadyNotification to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "transcript_id": @transcript_id, "status": @status }.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.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.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module AssemblyAI
+  class Transcripts
+    # The status of the transcript. Either completed or error.
+    class TranscriptReadyStatus
+      COMPLETED = "completed"
+      ERROR = "error"
+    end
+  end
+end

data/lib/assemblyai.rb

@@ -6,6 +6,7 @@ require_relative "requests"
 require_relative "assemblyai/files/client"
 require_relative "assemblyai/transcripts/client"
 require_relative "assemblyai/transcripts/polling_client"
+require_relative "assemblyai/transcripts/list_by_url_client"
 require_relative "assemblyai/realtime/client"
 require_relative "assemblyai/lemur/client"
 

data/lib/requests.rb

@@ -20,7 +20,7 @@ module AssemblyAI
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "AssemblyAI",
-        "X-Fern-SDK-Version": "1.0.0-beta.2",
+        "X-Fern-SDK-Version": "1.0.0-beta.3",
         "Authorization": api_key.to_s
       }
       @conn = Faraday.new(@base_url, headers: @headers) do |faraday|
@@ -46,7 +46,7 @@ module AssemblyAI
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "AssemblyAI",
-        "X-Fern-SDK-Version": "1.0.0-beta.2",
+        "X-Fern-SDK-Version": "1.0.0-beta.3",
         "Authorization": api_key.to_s
       }
       @conn = Faraday.new(@base_url, headers: @headers) do |faraday|

data/lib/types_export.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "assemblyai/files/types/uploaded_file"
+require_relative "assemblyai/transcripts/types/transcript_ready_notification"
 require_relative "assemblyai/transcripts/types/redacted_audio_response"
 require_relative "assemblyai/transcripts/types/redacted_audio_status"
 require_relative "assemblyai/transcripts/types/subtitle_format"
@@ -20,6 +21,7 @@ require_relative "assemblyai/transcripts/types/pii_policy"
 require_relative "assemblyai/transcripts/types/speech_model"
 require_relative "assemblyai/transcripts/types/transcript_language_code"
 require_relative "assemblyai/transcripts/types/transcript_status"
+require_relative "assemblyai/transcripts/types/transcript_ready_status"
 require_relative "assemblyai/transcripts/types/transcript"
 require_relative "assemblyai/transcripts/types/topic_detection_model_result"
 require_relative "assemblyai/transcripts/types/content_safety_labels_result"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assemblyai
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.2
+  version: 1.0.0.pre.beta.3
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -132,6 +132,7 @@ files:
 - lib/assemblyai/realtime/types/terminate_session.rb
 - lib/assemblyai/realtime/types/word.rb
 - lib/assemblyai/transcripts/client.rb
+- lib/assemblyai/transcripts/list_by_url_client.rb
 - lib/assemblyai/transcripts/polling_client.rb
 - lib/assemblyai/transcripts/types/audio_intelligence_model_status.rb
 - lib/assemblyai/transcripts/types/auto_highlight_result.rb
@@ -170,6 +171,8 @@ files:
 - lib/assemblyai/transcripts/types/transcript_list_item.rb
 - lib/assemblyai/transcripts/types/transcript_optional_params.rb
 - lib/assemblyai/transcripts/types/transcript_paragraph.rb
+- lib/assemblyai/transcripts/types/transcript_ready_notification.rb
+- lib/assemblyai/transcripts/types/transcript_ready_status.rb
 - lib/assemblyai/transcripts/types/transcript_sentence.rb
 - lib/assemblyai/transcripts/types/transcript_status.rb
 - lib/assemblyai/transcripts/types/transcript_utterance.rb