twilio-ruby 7.10.4 → 7.10.6

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

@@ -0,0 +1,514 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio API definition for public-api voice
+#    Powers Twilio public-api voice
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Voice < VoiceBase
+            class V3 < Version
+                class TranscriptionList < ListResource
+                
+                    class CreateV3TranscriptionsRequest
+                            # @param [transcription_configuration_id]: [String] The ID of the transcription configuration to use
+                            # @param [input_source]: [String] Discriminator indicating the input source type
+                            # @param [source_id]: [String] The SID or TTID of the source audio to transcribe (e.g. a Twilio Recording SID). When provided, audioStartedAt is inferred from the recording's start time and does not need to be supplied by the caller. 
+                            # @param [participants]: [Array<TranscriptionList.VoiceV3TranscriptionParticipant>] Participants in the conversation. If omitted or partially specified, defaults from the transcription configuration will be applied. 
+                            # @param [media_url]: [String] URL to the media file to transcribe
+                            # @param [audio_started_at]: [Time] The start time of the audio recording
+                        attr_accessor :transcription_configuration_id, :input_source, :source_id, :participants, :media_url, :audio_started_at
+                        def initialize(payload)
+                                @transcription_configuration_id = payload["transcription_configuration_id"]
+                                @input_source = payload["input_source"]
+                                @source_id = payload["source_id"]
+                                @participants = payload["participants"]
+                                @media_url = payload["media_url"]
+                                @audio_started_at = payload["audio_started_at"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "transcriptionConfigurationId": @transcription_configuration_id,
+                                "inputSource": @input_source,
+                                "sourceId": @source_id,
+                                "participants": @participants,
+                                "mediaUrl": @media_url,
+                                "audioStartedAt": @audio_started_at,
+                        }.to_json(options)
+                        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
+                        attr_accessor :audio_channel_index, :type
+                        def initialize(payload)
+                                @audio_channel_index = payload["audio_channel_index"]
+                                @type = payload["type"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "audioChannelIndex": @audio_channel_index,
+                                "type": @type,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class VoiceV3TranscriptionTranscriptionStatusCallback
+                            # @param [url]: [String] The URL to call when transcription status changes
+                            # @param [method]: [String] The HTTP method to use for the callback, currently only POST is supported
+                            # @param [events]: [Array<String>] The transcription events that will trigger the callback
+                        attr_accessor :url, :method, :events
+                        def initialize(payload)
+                                @url = payload["url"]
+                                @method = payload["method"]
+                                @events = payload["events"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "url": @url,
+                                "method": @method,
+                                "events": @events,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the TranscriptionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [TranscriptionList] TranscriptionList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Transcriptions"
+                        
+                    end
+                    ##
+                    # Create the TranscriptionInstance
+                    # @param [String] idempotency_key A unique key to ensure idempotency. We recommend using UUID v7. Requests with the same key within the idempotency window return the original response.
+                    # @param [CreateV3TranscriptionsRequest] create_v3_transcriptions_request 
+                    # @return [TranscriptionInstance] Created TranscriptionInstance
+                    def create(
+                      idempotency_key: :unset,
+                      create_v3_transcriptions_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: create_v3_transcriptions_request.to_json)
+                        TranscriptionInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the TranscriptionInstanceMetadata
+                    # @param [String] idempotency_key A unique key to ensure idempotency. We recommend using UUID v7. Requests with the same key within the idempotency window return the original response.
+                    # @param [CreateV3TranscriptionsRequest] create_v3_transcriptions_request 
+                    # @return [TranscriptionInstance] Created TranscriptionInstance
+                    def create_with_metadata(
+                      idempotency_key: :unset,
+                    create_v3_transcriptions_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: create_v3_transcriptions_request.to_json)
+                        transcription_instance = TranscriptionInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        TranscriptionInstanceMetadata.new(
+                            @version,
+                            transcription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Voice.V3.TranscriptionList>'
+                    end
+                end
+
+
+                class TranscriptionContext < InstanceContext
+                    ##
+                    # Initialize the TranscriptionContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] transcription_id The unique identifier of the transcription to fetch
+                    # @return [TranscriptionContext] TranscriptionContext
+                    def initialize(version, transcription_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { transcription_id: transcription_id,  }
+                        @uri = "/Transcriptions/#{@solution[:transcription_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the TranscriptionInstance
+                    # @return [TranscriptionInstance] Fetched TranscriptionInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        TranscriptionInstance.new(
+                            @version,
+                            payload,
+                            transcription_id: @solution[:transcription_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the TranscriptionInstanceMetadata
+                    # @return [TranscriptionInstance] Fetched TranscriptionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        transcription_instance = TranscriptionInstance.new(
+                            @version,
+                            response.body,
+                            transcription_id: @solution[:transcription_id],
+                        )
+                        TranscriptionInstanceMetadata.new(
+                            @version,
+                            transcription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Voice.V3.TranscriptionContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Voice.V3.TranscriptionContext #{context}>"
+                    end
+                end
+
+                class TranscriptionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TranscriptionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TranscriptionInstance] transcription_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [TranscriptionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, transcription_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @transcription_instance = transcription_instance
+                    end
+
+                    def transcription
+                        @transcription_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TranscriptionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TranscriptionListResponse < InstanceListResource
+                    # @param [Array<TranscriptionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @transcription_instance = payload.body[key].map do |data|
+                        TranscriptionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def transcription_instance
+                          @instance
+                      end
+                  end
+
+                class TranscriptionPage < TokenPage
+                    ##
+                    # Initialize the TranscriptionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [TranscriptionPage] TranscriptionPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of TranscriptionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [TranscriptionInstance] TranscriptionInstance
+                    def get_instance(payload)
+                        TranscriptionInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Voice.V3.TranscriptionPage>'
+                    end
+                end
+
+                class TranscriptionPageMetadata < PageMetadata
+                    attr_reader :transcription_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @transcription_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @transcription_page << TranscriptionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @transcription_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Voice::V3PageMetadata>';
+                    end
+                end
+                class TranscriptionListResponse < InstanceListResource
+
+                    # @param [Array<TranscriptionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @transcription = data_list.map do |data|
+                        TranscriptionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def transcription
+                        @transcription
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class TranscriptionInstance < InstanceResource
+                    ##
+                    # Initialize the TranscriptionInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Transcription
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [TranscriptionInstance] TranscriptionInstance
+                    def initialize(version, payload , transcription_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'status' => payload['status'],
+                            'status_url' => payload['status_url'],
+                            'transcription' => payload['transcription'],
+                            'operation_id' => payload['operation_id'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'transcription_id' => transcription_id  || @properties['transcription_id']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [TranscriptionContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = TranscriptionContext.new(@version , @params['transcription_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Current status of the long-running operation. PENDING: accepted but not yet started. RUNNING: currently in progress. COMPLETED: successfully completed. FAILED: failed and cannot be completed. 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] URI to poll for operation status. Mirrors the Location response header. Provided as a body field for programmatic access by JSON-parsing clients (RFC 9110 Section 15.3.3). 
+                    def status_url
+                        @properties['status_url']
+                    end
+                    
+                    ##
+                    # @return [VoiceV3TranscriptionTranscription] 
+                    def transcription
+                        @properties['transcription']
+                    end
+                    
+                    ##
+                    # @return [String] Unique identifier for the transcription operation.
+                    def operation_id
+                        @properties['operation_id']
+                    end
+                    
+                    ##
+                    # Fetch the TranscriptionInstance
+                    # @return [TranscriptionInstance] Fetched TranscriptionInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Voice.V3.TranscriptionInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Voice.V3.TranscriptionInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,50 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio API definition for public-api voice
+#    Powers Twilio public-api voice
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+module Twilio
+    module REST
+        class Voice
+            class V3 < Version
+                ##
+                # Initialize the V3 version of Voice
+                def initialize(domain)
+                    super
+                    @version = 'v3'
+                    @transcriptions = nil
+                end
+
+                ##
+                # @param [String] transcription_id The unique identifier of the transcription to fetch
+                # @return [Twilio::REST::Voice::V3::TranscriptionContext] if transcriptionId was passed.
+                # @return [Twilio::REST::Voice::V3::TranscriptionList]
+                def transcriptions(transcription_id=:unset)
+                    if transcription_id.nil?
+                        raise ArgumentError, 'transcription_id cannot be nil'
+                    end
+
+                    if transcription_id == :unset
+                        @transcriptions ||= TranscriptionList.new self
+                    else
+                        TranscriptionContext.new(self, transcription_id)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Voice::V3>';
+                end
+            end
+        end
+    end
+end

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

@@ -22,16 +22,21 @@ module Twilio
         @host = "voice.twilio.com"
         @port = 443
         @v1 = nil
+        @v3 = nil
       end
 
       def v1
         @v1 ||= Voice::V1.new self
       end
 
+      def v3
+        @v3 ||= Voice::V3.new self
+      end
+
       ##
       # Provide a user friendly representation
       def to_s
-        '<Twilio::REST::Voice::V1>';
+        '<Twilio::REST::Voice>';
       end
     end
   end

data/lib/twilio-ruby/rest/wireless/v1/command.rb

@@ -42,13 +42,13 @@ module Twilio
                     # @param [Boolean] delivery_receipt_requested Whether to request delivery receipt from the recipient. For Commands that request delivery receipt, the Command state transitions to 'delivered' once the server has received a delivery receipt from the device. The default value is `true`.
                     # @return [CommandInstance] Created CommandInstance
                     def create(
-                        command: nil, 
-                        sim: :unset, 
-                        callback_method: :unset, 
-                        callback_url: :unset, 
-                        command_mode: :unset, 
-                        include_sid: :unset, 
-                        delivery_receipt_requested: :unset
+                      command: nil, 
+                      sim: :unset, 
+                      callback_method: :unset, 
+                      callback_url: :unset, 
+                      command_mode: :unset, 
+                      include_sid: :unset, 
+                      delivery_receipt_requested: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -175,7 +175,11 @@ module Twilio
                             transport: transport,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
                     end
 
                     ##
@@ -217,9 +221,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -472,7 +480,7 @@ module Twilio
                             @command_page << CommandListResponse.new(version, @payload, key, limit - records)
                             @payload = self.next_page
                             break unless @payload
-                            records += @payload.body[key].size
+                            records += (@payload.body[key] || []).size
                         end
                         # Path Solution
                         @solution = solution
@@ -494,7 +502,7 @@ module Twilio
                     # @param [Hash{String => Object}] headers
                     # @param [Integer] status_code
                     def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]
+                      data_list = payload.body[key]  || []
                       if limit != :unset
                         data_list = data_list[0, limit]
                       end