twilio-ruby 7.10.7 → 7.11.1

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

@@ -0,0 +1,591 @@
+##
+#    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 V2 < Version
+                class TranscriptionList < ListResource
+                
+                    class VoiceV2ConfigurationTranscriptionParticipantDefault
+                            # @param [audio_channel_index]: [String] One-based index of the audio channel in a multi-channel recording associated with this role.
+                            # @param [type]: [String] The participant role to apply when inferring participants.
+                        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 VoiceV2ConfigurationTranscriptionRequest
+                            # @param [unique_name]: [String] The unique name.
+                            # @param [description]: [String] The description.
+                            # @param [configuration]: [TranscriptionList.VoiceV2ConfigurationTranscriptionConfiguration] 
+                        attr_accessor :unique_name, :description, :configuration
+                        def initialize(payload)
+                                @unique_name = payload["unique_name"]
+                                @description = payload["description"]
+                                @configuration = payload["configuration"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "unique_name": @unique_name,
+                                "description": @description,
+                                "configuration": @configuration,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class VoiceV2ConfigurationTranscriptionStatusCallback
+                            # @param [url]: [String] The webhook callback URL.
+                            # @param [method]: [String] The HTTP method to use for the webhook callback.
+                        attr_accessor :url, :method
+                        def initialize(payload)
+                                @url = payload["url"]
+                                @method = payload["method"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "url": @url,
+                                "method": @method,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the TranscriptionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [TranscriptionList] TranscriptionList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Configurations/Transcription"
+                        
+                    end
+                    ##
+                    # Create the TranscriptionInstance
+                    # @param [VoiceV2ConfigurationTranscriptionRequest] voice_v2_configuration_transcription_request 
+                    # @return [TranscriptionInstance] Created TranscriptionInstance
+                    def create(voice_v2_configuration_transcription_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: voice_v2_configuration_transcription_request.to_json)
+                        TranscriptionInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the TranscriptionInstanceMetadata
+                    # @param [VoiceV2ConfigurationTranscriptionRequest] voice_v2_configuration_transcription_request 
+                    # @return [TranscriptionInstance] Created TranscriptionInstance
+                    def create_with_metadata(voice_v2_configuration_transcription_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: voice_v2_configuration_transcription_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.V2.TranscriptionList>'
+                    end
+                end
+
+
+                class TranscriptionContext < InstanceContext
+                    ##
+                    # Initialize the TranscriptionContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] id_or_unique_name 
+                    # @return [TranscriptionContext] TranscriptionContext
+                    def initialize(version, id_or_unique_name)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { id_or_unique_name: id_or_unique_name,  }
+                        @uri = "/Configurations/Transcription/#{@solution[:id_or_unique_name]}"
+
+                        
+                    end
+                    ##
+                    # Delete the TranscriptionInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the TranscriptionInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          transcription_instance = TranscriptionInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          TranscriptionInstanceMetadata.new(@version, transcription_instance, response.headers, response.status_code)
+                    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,
+                            id_or_unique_name: @solution[:id_or_unique_name],
+                        )
+                    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,
+                            id_or_unique_name: @solution[:id_or_unique_name],
+                        )
+                        TranscriptionInstanceMetadata.new(
+                            @version,
+                            transcription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the TranscriptionInstance
+                    # @param [VoiceV2ConfigurationTranscriptionRequest] voice_v2_configuration_transcription_request 
+                    # @return [TranscriptionInstance] Updated TranscriptionInstance
+                    def update(voice_v2_configuration_transcription_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.update('PUT', @uri, headers: headers, data: voice_v2_configuration_transcription_request.to_json)
+                        TranscriptionInstance.new(
+                            @version,
+                            payload,
+                            id_or_unique_name: @solution[:id_or_unique_name],
+                        )
+                    end
+
+                    ##
+                    # Update the TranscriptionInstanceMetadata
+                    # @param [VoiceV2ConfigurationTranscriptionRequest] voice_v2_configuration_transcription_request 
+                    # @return [TranscriptionInstance] Updated TranscriptionInstance
+                    def update_with_metadata(voice_v2_configuration_transcription_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PUT', @uri, headers: headers, data: voice_v2_configuration_transcription_request.to_json)
+                        transcription_instance = TranscriptionInstance.new(
+                            @version,
+                            response.body,
+                            id_or_unique_name: @solution[:id_or_unique_name],
+                        )
+                        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.V2.TranscriptionContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Voice.V2.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 < Page
+                    ##
+                    # 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)
+                        super(version, 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.V2.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::V2PageMetadata>';
+                    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 , id_or_unique_name: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'account_sid' => payload['account_sid'],
+                            'unique_name' => payload['unique_name'],
+                            'description' => payload['description'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'configuration' => payload['configuration'],
+                            'message' => payload['message'],
+                            'code' => payload['code'],
+                            'status' => payload['status'],
+                            'more_info' => payload['more_info'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'id_or_unique_name' => id_or_unique_name  || @properties['id_or_unique_name']  , }
+                    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['id_or_unique_name'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Configuration Identifier.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] Account sid.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique name.
+                    def unique_name
+                        @properties['unique_name']
+                    end
+                    
+                    ##
+                    # @return [String] The description.
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [VoiceV2ConfigurationTranscriptionConfiguration] 
+                    def configuration
+                        @properties['configuration']
+                    end
+                    
+                    ##
+                    # @return [String] Error message
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [String] Twilio error code
+                    def code
+                        @properties['code']
+                    end
+                    
+                    ##
+                    # @return [String] status code
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] More information about the error
+                    def more_info
+                        @properties['more_info']
+                    end
+                    
+                    ##
+                    # Delete the TranscriptionInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the TranscriptionInstance
+                    # @return [TranscriptionInstance] Fetched TranscriptionInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the TranscriptionInstance
+                    # @param [VoiceV2ConfigurationTranscriptionRequest] voice_v2_configuration_transcription_request 
+                    # @return [TranscriptionInstance] Updated TranscriptionInstance
+                    def update(voice_v2_configuration_transcription_request: :unset
+                    )
+
+                        context.update(
+                            voice_v2_configuration_transcription_request: voice_v2_configuration_transcription_request, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Voice.V2.TranscriptionInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Voice.V2.TranscriptionInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end