twilio-ruby 7.10.7 → 7.11.2

data/lib/twilio-ruby/rest/voice/v3/transcription.rb

@@ -47,56 +47,6 @@ module Twilio
                         end
                     end
 
-                    class VoiceV3TranscriptionParticipant
-                            # @param [type]: [String] The role of this participant in the conversation.
-                            # @param [address]: [String] The phone number or identifier for this participant (E.164 format for phone numbers). Used to correlate this participant with their profile and conversation history. 
-                            # @param [name]: [String] User-defined name for this participant
-                            # @param [audio_channel_index]: [String] One-based index of the audio channel in a multi-channel recording
-                        attr_accessor :type, :address, :name, :audio_channel_index
-                        def initialize(payload)
-                                @type = payload["type"]
-                                @address = payload["address"]
-                                @name = payload["name"]
-                                @audio_channel_index = payload["audio_channel_index"]
-                        end
-                        def to_json(options = {})
-                        {
-                                "type": @type,
-                                "address": @address,
-                                "name": @name,
-                                "audioChannelIndex": @audio_channel_index,
-                        }.to_json(options)
-                        end
-                    end
-
-                    class VoiceV3TranscriptionResolvedConfiguration
-                            # @param [transcription_engine]: [String] The engine used for transcription (Deepgram, Google, or auto)
-                            # @param [speech_model]: [String] The speech model used for transcription (e.g., nova-2, nova-3, chirp_2)
-                            # @param [language]: [String] The language code for transcription
-                            # @param [transcription_status_callback]: [VoiceV3TranscriptionTranscriptionStatusCallback] 
-                            # @param [conversation_configuration_id]: [String] Maestro conversation configuration ID
-                            # @param [participant_defaults]: [Array<VoiceV3TranscriptionResolvedConfigurationParticipantDefaults>] Default participant configurations for the transcription
-                        attr_accessor :transcription_engine, :speech_model, :language, :transcription_status_callback, :conversation_configuration_id, :participant_defaults
-                        def initialize(payload)
-                                @transcription_engine = payload["transcription_engine"]
-                                @speech_model = payload["speech_model"]
-                                @language = payload["language"]
-                                @transcription_status_callback = payload["transcription_status_callback"]
-                                @conversation_configuration_id = payload["conversation_configuration_id"]
-                                @participant_defaults = payload["participant_defaults"]
-                        end
-                        def to_json(options = {})
-                        {
-                                "transcriptionEngine": @transcription_engine,
-                                "speechModel": @speech_model,
-                                "language": @language,
-                                "transcriptionStatusCallback": @transcription_status_callback,
-                                "conversationConfigurationId": @conversation_configuration_id,
-                                "participantDefaults": @participant_defaults,
-                        }.to_json(options)
-                        end
-                    end
-
                     class VoiceV3TranscriptionResolvedConfigurationParticipantDefaults
                             # @param [audio_channel_index]: [Integer] One-based index of the audio channel
                             # @param [type]: [String] The participant role type
@@ -199,6 +149,167 @@ module Twilio
                     end
 
                 
+                    ##
+                    # Lists TranscriptionInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [Time] created_after Only include transcriptions created at or after this time (inclusive)
+                    # @param [Time] created_before Only include transcriptions created strictly before this time (exclusive)
+                    # @param [String] language_code Only include transcriptions whose resolved language matches this value exactly. The comparison is case sensitive, so use the stored form, for example en-US.
+                    # @param [String] source_id Only include transcriptions for this source audio. Must be a Recording SID in lowercase hex; anything else is rejected with a 400.
+                    # @param [String] status Only include transcriptions in this status
+                    # @param [String] page_token Opaque cursor for retrieving the next or previous page of results
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(created_after: :unset, created_before: :unset, language_code: :unset, source_id: :unset, status: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            created_after: created_after,
+                            created_before: created_before,
+                            language_code: language_code,
+                            source_id: source_id,
+                            status: status,
+                            page_token: page_token,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [Time] created_after Only include transcriptions created at or after this time (inclusive)
+                    # @param [Time] created_before Only include transcriptions created strictly before this time (exclusive)
+                    # @param [String] language_code Only include transcriptions whose resolved language matches this value exactly. The comparison is case sensitive, so use the stored form, for example en-US.
+                    # @param [String] source_id Only include transcriptions for this source audio. Must be a Recording SID in lowercase hex; anything else is rejected with a 400.
+                    # @param [String] status Only include transcriptions in this status
+                    # @param [String] page_token Opaque cursor for retrieving the next or previous page of results
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(created_after: :unset, created_before: :unset, language_code: :unset, source_id: :unset, status: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            created_after: created_after,
+                            created_before: created_before,
+                            language_code: language_code,
+                            source_id: source_id,
+                            status: status,
+                            page_token: page_token,
+                            page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists TranscriptionPageMetadata records from the API as a list.
+                      # @param [Time] created_after Only include transcriptions created at or after this time (inclusive)
+                      # @param [Time] created_before Only include transcriptions created strictly before this time (exclusive)
+                      # @param [String] language_code Only include transcriptions whose resolved language matches this value exactly. The comparison is case sensitive, so use the stored form, for example en-US.
+                      # @param [String] source_id Only include transcriptions for this source audio. Must be a Recording SID in lowercase hex; anything else is rejected with a 400.
+                      # @param [String] status Only include transcriptions in this status
+                      # @param [String] page_token Opaque cursor for retrieving the next or previous page of results
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(created_after: :unset, created_before: :unset, language_code: :unset, source_id: :unset, status: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'createdAfter' =>  Twilio.serialize_iso8601_datetime(created_after),
+                            'createdBefore' =>  Twilio.serialize_iso8601_datetime(created_before),
+                            'languageCode' => language_code,
+                            'sourceId' => source_id,
+                            'status' => status,
+                            'pageToken' => page_token,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        TranscriptionPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields TranscriptionInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of TranscriptionInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [Time] created_after Only include transcriptions created at or after this time (inclusive)
+                    # @param [Time] created_before Only include transcriptions created strictly before this time (exclusive)
+                    # @param [String] language_code Only include transcriptions whose resolved language matches this value exactly. The comparison is case sensitive, so use the stored form, for example en-US.
+                    # @param [String] source_id Only include transcriptions for this source audio. Must be a Recording SID in lowercase hex; anything else is rejected with a 400.
+                    # @param [String] status Only include transcriptions in this status
+                    # @param [String] page_token Opaque cursor for retrieving the next or previous page of results
+                    
+                    # @return [Page] Page of TranscriptionInstance
+                    def page(created_after: :unset, created_before: :unset, language_code: :unset, source_id: :unset, status: :unset, page_token: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'createdAfter' =>  Twilio.serialize_iso8601_datetime(created_after),
+                            'createdBefore' =>  Twilio.serialize_iso8601_datetime(created_before),
+                            'languageCode' => language_code,
+                            'sourceId' => source_id,
+                            'status' => status,
+                            'pageToken' => page_token,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        TranscriptionPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of TranscriptionInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of TranscriptionInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    TranscriptionPage.new(@version, response, @solution)
+                    end
+                    
 
 
                     # Provide a user friendly representation
@@ -443,6 +554,20 @@ module Twilio
                             'status_url' => payload['status_url'],
                             'transcription' => payload['transcription'],
                             'operation_id' => payload['operation_id'],
+                            'id' => payload['id'],
+                            'account_id' => payload['account_id'],
+                            'transcription_configuration_id' => payload['transcription_configuration_id'],
+                            'media_url' => payload['media_url'],
+                            'source_id' => payload['source_id'],
+                            'audio_started_at' => Twilio.deserialize_iso8601_datetime(payload['audio_started_at']),
+                            'conversation_id' => payload['conversation_id'],
+                            'participants' => payload['participants'],
+                            'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
+                            'resolved_configuration' => payload['resolved_configuration'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'url' => payload['url'],
+                            'links' => payload['links'],
                         }
 
                         # Context
@@ -485,6 +610,90 @@ module Twilio
                         @properties['operation_id']
                     end
                     
+                    ##
+                    # @return [String] Unique identifier for a Transcription. This is also the transcriptionId returned in the LRO 202 response.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] Twilio Account SID
+                    def account_id
+                        @properties['account_id']
+                    end
+                    
+                    ##
+                    # @return [String] Unique identifier for a Transcription configuration.
+                    def transcription_configuration_id
+                        @properties['transcription_configuration_id']
+                    end
+                    
+                    ##
+                    # @return [String] The third party media URL
+                    def media_url
+                        @properties['media_url']
+                    end
+                    
+                    ##
+                    # @return [String] The source ID (recording ID) - used for tracking only
+                    def source_id
+                        @properties['source_id']
+                    end
+                    
+                    ##
+                    # @return [Time] The call/recording start time. When the transcription was created using a sourceId, this value is inferred from the recording resource's start time. When created using a mediaUrl, this reflects the value supplied by the caller. 
+                    def audio_started_at
+                        @properties['audio_started_at']
+                    end
+                    
+                    ##
+                    # @return [String] Maestro conversation ID, populated once the transcription has been stored in Maestro.
+                    def conversation_id
+                        @properties['conversation_id']
+                    end
+                    
+                    ##
+                    # @return [Array<VoiceV3TranscriptionParticipant>] Array of participants in the conversation
+                    def participants
+                        @properties['participants']
+                    end
+                    
+                    ##
+                    # @return [String] Audio duration in seconds
+                    def duration
+                        @properties['duration']
+                    end
+                    
+                    ##
+                    # @return [VoiceV3TranscriptionResolvedConfiguration] 
+                    def resolved_configuration
+                        @properties['resolved_configuration']
+                    end
+                    
+                    ##
+                    # @return [Time] When this transcript was created
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] When this transcript was last updated
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] Absolute URLs of resources related to this Transcription. Includes `conversation`, the Conversations API resource for this Transcription's `conversationId`, once the transcript has been stored. Omitted entirely when there is no related resource to link to. 
+                    def links
+                        @properties['links']
+                    end
+                    
                     ##
                     # Fetch the TranscriptionInstance
                     # @return [TranscriptionInstance] Fetched TranscriptionInstance

data/lib/twilio-ruby/rest/voice_base.rb

@@ -22,6 +22,7 @@ module Twilio
         @host = "voice.twilio.com"
         @port = 443
         @v1 = nil
+        @v2 = nil
         @v3 = nil
       end
 
@@ -29,6 +30,10 @@ module Twilio
         @v1 ||= Voice::V1.new self
       end
 
+      def v2
+        @v2 ||= Voice::V2.new self
+      end
+
       def v3
         @v3 ||= Voice::V3.new self
       end

data/lib/twilio-ruby/twiml/voice_response.rb

@@ -52,9 +52,10 @@ module Twilio
       # refer_url:: Webhook that will receive future SIP REFER requests
       # refer_method:: The HTTP method to use for the refer Webhook
       # events:: Subscription to events
+      # passports:: Base64-encoded comma-separated identity passports (e.g. shaken, div)
       # keyword_args:: additional attributes
-      def dial(number: nil, action: nil, method: nil, timeout: nil, hangup_on_star: nil, time_limit: nil, caller_id: nil, record: nil, trim: nil, recording_status_callback: nil, recording_configuration_id: nil, recording_status_callback_method: nil, recording_status_callback_event: nil, answer_on_bridge: nil, ring_tone: nil, recording_track: nil, sequential: nil, refer_url: nil, refer_method: nil, events: nil, **keyword_args)
-        dial = Dial.new(number: number, action: action, method: method, timeout: timeout, hangup_on_star: hangup_on_star, time_limit: time_limit, caller_id: caller_id, record: record, trim: trim, recording_status_callback: recording_status_callback, recording_configuration_id: recording_configuration_id, recording_status_callback_method: recording_status_callback_method, recording_status_callback_event: recording_status_callback_event, answer_on_bridge: answer_on_bridge, ring_tone: ring_tone, recording_track: recording_track, sequential: sequential, refer_url: refer_url, refer_method: refer_method, events: events, **keyword_args)
+      def dial(number: nil, action: nil, method: nil, timeout: nil, hangup_on_star: nil, time_limit: nil, caller_id: nil, record: nil, trim: nil, recording_status_callback: nil, recording_configuration_id: nil, recording_status_callback_method: nil, recording_status_callback_event: nil, answer_on_bridge: nil, ring_tone: nil, recording_track: nil, sequential: nil, refer_url: nil, refer_method: nil, events: nil, passports: nil, **keyword_args)
+        dial = Dial.new(number: number, action: action, method: method, timeout: timeout, hangup_on_star: hangup_on_star, time_limit: time_limit, caller_id: caller_id, record: record, trim: trim, recording_status_callback: recording_status_callback, recording_configuration_id: recording_configuration_id, recording_status_callback_method: recording_status_callback_method, recording_status_callback_event: recording_status_callback_event, answer_on_bridge: answer_on_bridge, ring_tone: ring_tone, recording_track: recording_track, sequential: sequential, refer_url: refer_url, refer_method: refer_method, events: events, passports: passports, **keyword_args)
 
         yield(dial) if block_given?
         append(dial)
@@ -2119,37 +2120,6 @@ module Twilio
         append(conversation_relay)
       end
 
-      ##
-      # Create a new <Assistant> element
-      # id:: The assistant ID of the AI Assistant
-      # language:: Language to be used for both text-to-speech and transcription
-      # tts_language:: Language to be used for text-to-speech
-      # transcription_language:: Language to be used for transcription
-      # tts_provider:: Provider to be used for text-to-speech
-      # voice:: Voice to be used for text-to-speech
-      # transcription_provider:: Provider to be used for transcription
-      # speech_model:: Speech model to be used for transcription
-      # profanity_filter:: Whether profanities should be filtered out of the speech transcription
-      # dtmf_detection:: Whether DTMF tones should be detected and reported in speech transcription
-      # welcome_greeting:: The sentence to be played automatically when the session is connected
-      # partial_prompts:: Whether partial prompts should be reported to WebSocket server before the caller finishes speaking
-      # welcome_greeting_interruptible:: "Whether and how the input from a caller, such as speaking or DTMF can interrupt the welcome greeting
-      # interruptible:: Whether and how the input from a caller, such as speaking or DTMF can interrupt the play of text-to-speech
-      # preemptible:: Whether subsequent text-to-speech or play media can interrupt the on-going play of text-to-speech or media
-      # hints:: Phrases to help better accuracy in speech recognition of these pharases
-      # intelligence_service:: The Conversational Intelligence Service id or unique name to be used for the session
-      # report_input_during_agent_speech:: Whether prompts should be reported to WebSocket server when text-to-speech playing and interrupt is disabled
-      # elevenlabs_text_normalization:: When using ElevenLabs as TTS provider, this parameter allows you to enable or disable its text normalization feature
-      # interrupt_sensitivity:: Set the sensitivity of the interrupt feature for speech. The value can be low, medium, or high
-      # debug:: Multiple debug options to be used for troubleshooting
-      # keyword_args:: additional attributes
-      def assistant(id: nil, language: nil, tts_language: nil, transcription_language: nil, tts_provider: nil, voice: nil, transcription_provider: nil, speech_model: nil, profanity_filter: nil, dtmf_detection: nil, welcome_greeting: nil, partial_prompts: nil, welcome_greeting_interruptible: nil, interruptible: nil, preemptible: nil, hints: nil, intelligence_service: nil, report_input_during_agent_speech: nil, elevenlabs_text_normalization: nil, interrupt_sensitivity: nil, debug: nil, **keyword_args)
-        assistant = Assistant.new(id: id, language: language, tts_language: tts_language, transcription_language: transcription_language, tts_provider: tts_provider, voice: voice, transcription_provider: transcription_provider, speech_model: speech_model, profanity_filter: profanity_filter, dtmf_detection: dtmf_detection, welcome_greeting: welcome_greeting, partial_prompts: partial_prompts, welcome_greeting_interruptible: welcome_greeting_interruptible, interruptible: interruptible, preemptible: preemptible, hints: hints, intelligence_service: intelligence_service, report_input_during_agent_speech: report_input_during_agent_speech, elevenlabs_text_normalization: elevenlabs_text_normalization, interrupt_sensitivity: interrupt_sensitivity, debug: debug, **keyword_args)
-
-        yield(assistant) if block_given?
-        append(assistant)
-      end
-
       ##
       # Create a new <AiSession> element
       # ai_connector:: The unique name or installed add-on sid that identifies the installed addon resource for the AI Connector
@@ -2192,11 +2162,11 @@ module Twilio
     end
 
     ##
-    # <Assistant> TwiML Noun
-    class Assistant < TwiML
+    # <ConversationRelay> TwiML Noun
+    class ConversationRelay < TwiML
       def initialize(**keyword_args)
         super(**keyword_args)
-        @name = 'Assistant'
+        @name = 'ConversationRelay'
 
         yield(self) if block_given?
       end
@@ -2234,38 +2204,6 @@ module Twilio
       end
     end
 
-    ##
-    # <ConversationRelay> TwiML Noun
-    class ConversationRelay < TwiML
-      def initialize(**keyword_args)
-        super(**keyword_args)
-        @name = 'ConversationRelay'
-
-        yield(self) if block_given?
-      end
-
-      ##
-      # Create a new <Language> element
-      # code:: Language code of this language setting is for
-      # tts_provider:: Provider to be used for text-to-speech of this language
-      # voice:: Voice to be used for text-to-speech of this language
-      # transcription_provider:: Provider to be used for transcription of this language
-      # speech_model:: Speech model to be used for transcription of this language
-      # keyword_args:: additional attributes
-      def language(code: nil, tts_provider: nil, voice: nil, transcription_provider: nil, speech_model: nil, **keyword_args)
-        append(Language.new(code: code, tts_provider: tts_provider, voice: voice, transcription_provider: transcription_provider, speech_model: speech_model, **keyword_args))
-      end
-
-      ##
-      # Create a new <Parameter> element
-      # name:: The name of the custom parameter
-      # value:: The value of the custom parameter
-      # keyword_args:: additional attributes
-      def parameter(name: nil, value: nil, **keyword_args)
-        append(Parameter.new(name: name, value: value, **keyword_args))
-      end
-    end
-
     ##
     # <Conversation> TwiML Noun
     class Conversation < TwiML

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-    VERSION = '7.10.7'
+    VERSION = '7.11.2'
 end

data/twilio-ruby.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   # Workaround for RBX <= 2.2.1, should be fixed in next version
   spec.add_dependency('rubysl') if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
 
-  spec.add_development_dependency 'bundler', '>= 1.5', '< 3.0'
+  spec.add_development_dependency 'bundler', '>= 1.5', '< 5.0'
   spec.add_development_dependency 'equivalent-xml', '~> 0.6'
   spec.add_development_dependency 'fakeweb', '~> 1.3'
   spec.add_development_dependency 'rack', '~> 2.0'