twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/api/v2010/account/call/transcription.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [TranscriptionList] TranscriptionList
                     def initialize(version, account_sid: nil, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Transcriptions.json"
@@ -48,7 +49,8 @@ module Twilio
                     # @param [String] speech_model Recognition model used by the transcription engine, among those supported by the provider
                     # @param [String] hints A Phrase contains words and phrase \\\"hints\\\" so that the speech recognition engine is more likely to recognize them.
                     # @param [Boolean] enable_automatic_punctuation The provider will add punctuation to recognition result
-                    # @param [String] intelligence_service The SID or unique name of the [Intelligence Service](https://www.twilio.com/docs/conversational-intelligence/api/service-resource) for persisting transcripts and running post-call Language Operators .
+                    # @param [String] intelligence_service The SID or unique name of the [Intelligence Service](https://www.twilio.com/docs/conversational-intelligence/api/service-resource) for persisting transcripts and running post-call Language Operators
+                    # @param [Boolean] enable_provider_data Whether the callback includes raw provider data.
                     # @return [TranscriptionInstance] Created TranscriptionInstance
                     def create(
                         name: :unset, 
@@ -64,7 +66,8 @@ module Twilio
                         speech_model: :unset, 
                         hints: :unset, 
                         enable_automatic_punctuation: :unset, 
-                        intelligence_service: :unset
+                        intelligence_service: :unset, 
+                        enable_provider_data: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -82,6 +85,7 @@ module Twilio
                             'Hints' => hints,
                             'EnableAutomaticPunctuation' => enable_automatic_punctuation,
                             'IntelligenceService' => intelligence_service,
+                            'EnableProviderData' => enable_provider_data,
                         })
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
@@ -99,6 +103,81 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the TranscriptionInstanceMetadata
+                    # @param [String] name The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.
+                    # @param [Track] track 
+                    # @param [String] status_callback_url Absolute URL of the status callback.
+                    # @param [String] status_callback_method The http method for the status_callback (one of GET, POST).
+                    # @param [String] inbound_track_label Friendly name given to the Inbound Track
+                    # @param [String] outbound_track_label Friendly name given to the Outbound Track
+                    # @param [Boolean] partial_results Indicates if partial results are going to be sent to the customer
+                    # @param [String] language_code Language code used by the transcription engine, specified in [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format
+                    # @param [String] transcription_engine Definition of the transcription engine to be used, among those supported by Twilio
+                    # @param [Boolean] profanity_filter indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks
+                    # @param [String] speech_model Recognition model used by the transcription engine, among those supported by the provider
+                    # @param [String] hints A Phrase contains words and phrase \\\"hints\\\" so that the speech recognition engine is more likely to recognize them.
+                    # @param [Boolean] enable_automatic_punctuation The provider will add punctuation to recognition result
+                    # @param [String] intelligence_service The SID or unique name of the [Intelligence Service](https://www.twilio.com/docs/conversational-intelligence/api/service-resource) for persisting transcripts and running post-call Language Operators
+                    # @param [Boolean] enable_provider_data Whether the callback includes raw provider data.
+                    # @return [TranscriptionInstance] Created TranscriptionInstance
+                    def create_with_metadata(
+                      name: :unset, 
+                      track: :unset, 
+                      status_callback_url: :unset, 
+                      status_callback_method: :unset, 
+                      inbound_track_label: :unset, 
+                      outbound_track_label: :unset, 
+                      partial_results: :unset, 
+                      language_code: :unset, 
+                      transcription_engine: :unset, 
+                      profanity_filter: :unset, 
+                      speech_model: :unset, 
+                      hints: :unset, 
+                      enable_automatic_punctuation: :unset, 
+                      intelligence_service: :unset, 
+                      enable_provider_data: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Name' => name,
+                            'Track' => track,
+                            'StatusCallbackUrl' => status_callback_url,
+                            'StatusCallbackMethod' => status_callback_method,
+                            'InboundTrackLabel' => inbound_track_label,
+                            'OutboundTrackLabel' => outbound_track_label,
+                            'PartialResults' => partial_results,
+                            'LanguageCode' => language_code,
+                            'TranscriptionEngine' => transcription_engine,
+                            'ProfanityFilter' => profanity_filter,
+                            'SpeechModel' => speech_model,
+                            'Hints' => hints,
+                            'EnableAutomaticPunctuation' => enable_automatic_punctuation,
+                            'IntelligenceService' => intelligence_service,
+                            'EnableProviderData' => enable_provider_data,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        transcription_instance = TranscriptionInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                        TranscriptionInstanceMetadata.new(
+                            @version,
+                            transcription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -119,6 +198,7 @@ module Twilio
                     # @return [TranscriptionContext] TranscriptionContext
                     def initialize(version, account_sid, call_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid, sid: sid,  }
@@ -154,6 +234,40 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the TranscriptionInstanceMetadata
+                    # @param [UpdateStatus] status 
+                    # @return [TranscriptionInstance] Updated TranscriptionInstance
+                    def update_with_metadata(
+                      status: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        transcription_instance = TranscriptionInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                            sid: @solution[:sid],
+                        )
+                        TranscriptionInstanceMetadata.new(
+                            @version,
+                            transcription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -170,6 +284,53 @@ module Twilio
                     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
@@ -179,6 +340,7 @@ module Twilio
                     # @return [TranscriptionPage] TranscriptionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -198,6 +360,66 @@ module Twilio
                         '<Twilio.Api.V2010.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::Api::V2010PageMetadata>';
+                    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
@@ -211,6 +433,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, call_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [UserDefinedMessageList] UserDefinedMessageList
                     def initialize(version, account_sid: nil, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/UserDefinedMessages.json"
@@ -63,6 +64,42 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the UserDefinedMessageInstanceMetadata
+                    # @param [String] content The User Defined Message in the form of URL-encoded JSON string.
+                    # @param [String] idempotency_key A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+                    # @return [UserDefinedMessageInstance] Created UserDefinedMessageInstance
+                    def create_with_metadata(
+                      content: nil, 
+                      idempotency_key: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Content' => content,
+                            'IdempotencyKey' => idempotency_key,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        user_defined_message_instance = UserDefinedMessageInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                        UserDefinedMessageInstanceMetadata.new(
+                            @version,
+                            user_defined_message_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -81,6 +118,7 @@ module Twilio
                     # @return [UserDefinedMessagePage] UserDefinedMessagePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -100,6 +138,66 @@ module Twilio
                         '<Twilio.Api.V2010.UserDefinedMessagePage>'
                     end
                 end
+
+                class UserDefinedMessagePageMetadata < PageMetadata
+                    attr_reader :user_defined_message_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @user_defined_message_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @user_defined_message_page << UserDefinedMessageListResponse.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
+                        @user_defined_message_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class UserDefinedMessageListResponse < InstanceListResource
+
+                    # @param [Array<UserDefinedMessageInstance>] 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
+                      @user_defined_message = data_list.map do |data|
+                        UserDefinedMessageInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def user_defined_message
+                        @user_defined_message
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UserDefinedMessageInstance < InstanceResource
                     ##
                     # Initialize the UserDefinedMessageInstance
@@ -113,6 +211,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [UserDefinedMessageSubscriptionList] UserDefinedMessageSubscriptionList
                     def initialize(version, account_sid: nil, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/UserDefinedMessageSubscriptions.json"
@@ -66,6 +67,45 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the UserDefinedMessageSubscriptionInstanceMetadata
+                    # @param [String] callback The URL we should call using the `method` to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted).
+                    # @param [String] idempotency_key A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+                    # @param [String] method The HTTP method Twilio will use when requesting the above `Url`. Either `GET` or `POST`. Default is `POST`.
+                    # @return [UserDefinedMessageSubscriptionInstance] Created UserDefinedMessageSubscriptionInstance
+                    def create_with_metadata(
+                      callback: nil, 
+                      idempotency_key: :unset, 
+                      method: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Callback' => callback,
+                            'IdempotencyKey' => idempotency_key,
+                            'Method' => method,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        user_defined_message_subscription_instance = UserDefinedMessageSubscriptionInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                        UserDefinedMessageSubscriptionInstanceMetadata.new(
+                            @version,
+                            user_defined_message_subscription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -86,6 +126,7 @@ module Twilio
                     # @return [UserDefinedMessageSubscriptionContext] UserDefinedMessageSubscriptionContext
                     def initialize(version, account_sid, call_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid, sid: sid,  }
@@ -102,9 +143,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the UserDefinedMessageSubscriptionInstanceMetadata
+                    # @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)
+                          userDefinedMessageSubscription_instance = UserDefinedMessageSubscriptionInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          UserDefinedMessageSubscriptionInstanceMetadata.new(@version, userDefinedMessageSubscription_instance, response.headers, response.status_code)
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -121,6 +182,53 @@ module Twilio
                     end
                 end
 
+                class UserDefinedMessageSubscriptionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new UserDefinedMessageSubscriptionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}UserDefinedMessageSubscriptionInstance] user_defined_message_subscription_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 [UserDefinedMessageSubscriptionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, user_defined_message_subscription_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @user_defined_message_subscription_instance = user_defined_message_subscription_instance
+                    end
+
+                    def user_defined_message_subscription
+                        @user_defined_message_subscription_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.UserDefinedMessageSubscriptionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class UserDefinedMessageSubscriptionListResponse < InstanceListResource
+                    # @param [Array<UserDefinedMessageSubscriptionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @user_defined_message_subscription_instance = payload.body[key].map do |data|
+                        UserDefinedMessageSubscriptionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def user_defined_message_subscription_instance
+                          @instance
+                      end
+                  end
+
                 class UserDefinedMessageSubscriptionPage < Page
                     ##
                     # Initialize the UserDefinedMessageSubscriptionPage
@@ -130,6 +238,7 @@ module Twilio
                     # @return [UserDefinedMessageSubscriptionPage] UserDefinedMessageSubscriptionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -149,6 +258,66 @@ module Twilio
                         '<Twilio.Api.V2010.UserDefinedMessageSubscriptionPage>'
                     end
                 end
+
+                class UserDefinedMessageSubscriptionPageMetadata < PageMetadata
+                    attr_reader :user_defined_message_subscription_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @user_defined_message_subscription_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @user_defined_message_subscription_page << UserDefinedMessageSubscriptionListResponse.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
+                        @user_defined_message_subscription_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class UserDefinedMessageSubscriptionListResponse < InstanceListResource
+
+                    # @param [Array<UserDefinedMessageSubscriptionInstance>] 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
+                      @user_defined_message_subscription = data_list.map do |data|
+                        UserDefinedMessageSubscriptionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def user_defined_message_subscription
+                        @user_defined_message_subscription
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UserDefinedMessageSubscriptionInstance < InstanceResource
                     ##
                     # Initialize the UserDefinedMessageSubscriptionInstance
@@ -162,6 +331,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, call_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],