twilio-ruby 5.77.0 → 7.3.3

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

@@ -0,0 +1,307 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Api
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Api < ApiBase
+            class V2010 < Version
+                class AccountContext < InstanceContext
+                class CallContext < InstanceContext
+
+                     class TranscriptionList < ListResource
+                
+                    ##
+                    # Initialize the TranscriptionList
+                    # @param [Version] version Version that contains the resource
+                    # @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"
+                        
+                    end
+                    ##
+                    # Create the TranscriptionInstance
+                    # @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
+                    # @return [TranscriptionInstance] Created TranscriptionInstance
+                    def create(
+                        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
+                    )
+
+                        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,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        TranscriptionInstance.new(
+                            @version,
+                            payload,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Api.V2010.TranscriptionList>'
+                    end
+                end
+
+
+                class TranscriptionContext < InstanceContext
+                    ##
+                    # Initialize the TranscriptionContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Transcription resource.
+                    # @param [String] call_sid The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with.
+                    # @param [String] sid The SID of the Transcription resource, or the `name` used when creating the resource
+                    # @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,  }
+                        @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Transcriptions/#{@solution[:sid]}.json"
+
+                        
+                    end
+                    ##
+                    # Update the TranscriptionInstance
+                    # @param [UpdateStatus] status 
+                    # @return [TranscriptionInstance] Updated TranscriptionInstance
+                    def update(
+                        status: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        TranscriptionInstance.new(
+                            @version,
+                            payload,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Api.V2010.TranscriptionContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Api.V2010.TranscriptionContext #{context}>"
+                    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, account_sid: @solution[:account_sid], call_sid: @solution[:call_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Api.V2010.TranscriptionPage>'
+                    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 , account_sid: nil, call_sid: nil, sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'call_sid' => payload['call_sid'],
+                            'name' => payload['name'],
+                            'status' => payload['status'],
+                            'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                            'uri' => payload['uri'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'account_sid' => account_sid  ,'call_sid' => call_sid  || @properties['call_sid']  ,'sid' => sid  || @properties['sid']  , }
+                    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['account_sid'], @params['call_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Transcription resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Transcription resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with.
+                    def call_sid
+                        @properties['call_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.
+                    def name
+                        @properties['name']
+                    end
+                    
+                    ##
+                    # @return [Status] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT that this resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def uri
+                        @properties['uri']
+                    end
+                    
+                    ##
+                    # Update the TranscriptionInstance
+                    # @param [UpdateStatus] status 
+                    # @return [TranscriptionInstance] Updated TranscriptionInstance
+                    def update(
+                        status: nil
+                    )
+
+                        context.update(
+                            status: status, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Api.V2010.TranscriptionInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Api.V2010.TranscriptionInstance #{values}>"
+                    end
+                end
+
+             end
+             end
+            end
+        end
+    end
+end
+
+

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

@@ -1,160 +1,166 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Api
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
 #
-# frozen_string_literal: true
 
-module Twilio
-  module REST
-    class Api < Domain
-      class V2010 < Version
-        class AccountContext < InstanceContext
-          class CallContext < InstanceContext
-            class UserDefinedMessageList < ListResource
-              ##
-              # Initialize the UserDefinedMessageList
-              # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The SID of the
-              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created User Defined
-              #   Message.
-              # @param [String] call_sid The SID of the
-              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] the User Defined
-              #   Message is associated with.
-              # @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"
-              end
-
-              ##
-              # Create the UserDefinedMessageInstance
-              # @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(content: nil, idempotency_key: :unset)
-                data = Twilio::Values.of({'Content' => content, 'IdempotencyKey' => idempotency_key, })
-
-                payload = @version.create('POST', @uri, data: data)
-
-                UserDefinedMessageInstance.new(
-                    @version,
-                    payload,
-                    account_sid: @solution[:account_sid],
-                    call_sid: @solution[:call_sid],
-                )
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '#<Twilio.Api.V2010.UserDefinedMessageList>'
-              end
-            end
 
-            class UserDefinedMessagePage < Page
-              ##
-              # Initialize the UserDefinedMessagePage
-              # @param [Version] version Version that contains the resource
-              # @param [Response] response Response from the API
-              # @param [Hash] solution Path solution for the resource
-              # @return [UserDefinedMessagePage] UserDefinedMessagePage
-              def initialize(version, response, solution)
-                super(version, response)
-
-                # Path Solution
-                @solution = solution
-              end
-
-              ##
-              # Build an instance of UserDefinedMessageInstance
-              # @param [Hash] payload Payload response from the API
-              # @return [UserDefinedMessageInstance] UserDefinedMessageInstance
-              def get_instance(payload)
-                UserDefinedMessageInstance.new(
-                    @version,
-                    payload,
-                    account_sid: @solution[:account_sid],
-                    call_sid: @solution[:call_sid],
-                )
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '<Twilio.Api.V2010.UserDefinedMessagePage>'
-              end
-            end
-
-            class UserDefinedMessageInstance < InstanceResource
-              ##
-              # Initialize the UserDefinedMessageInstance
-              # @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 User Defined
-              #   Message.
-              # @param [String] call_sid The SID of the
-              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] the User Defined
-              #   Message is associated with.
-              # @return [UserDefinedMessageInstance] UserDefinedMessageInstance
-              def initialize(version, payload, account_sid: nil, call_sid: nil)
-                super(version)
-
-                # Marshaled Properties
-                @properties = {
-                    'account_sid' => payload['account_sid'],
-                    'call_sid' => payload['call_sid'],
-                    'sid' => payload['sid'],
-                    'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
-                }
-              end
-
-              ##
-              # @return [String] Account SID.
-              def account_sid
-                @properties['account_sid']
-              end
-
-              ##
-              # @return [String] Call SID.
-              def call_sid
-                @properties['call_sid']
-              end
-
-              ##
-              # @return [String] User Defined Message SID.
-              def sid
-                @properties['sid']
-              end
-
-              ##
-              # @return [Time] The date this User Defined Message was created.
-              def date_created
-                @properties['date_created']
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                "<Twilio.Api.V2010.UserDefinedMessageInstance>"
-              end
-
-              ##
-              # Provide a detailed, user friendly representation
-              def inspect
-                "<Twilio.Api.V2010.UserDefinedMessageInstance>"
-              end
+module Twilio
+    module REST
+        class Api < ApiBase
+            class V2010 < Version
+                class AccountContext < InstanceContext
+                class CallContext < InstanceContext
+
+                     class UserDefinedMessageList < ListResource
+                
+                    ##
+                    # Initialize the UserDefinedMessageList
+                    # @param [Version] version Version that contains the resource
+                    # @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"
+                        
+                    end
+                    ##
+                    # Create the UserDefinedMessageInstance
+                    # @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(
+                        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', })
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        UserDefinedMessageInstance.new(
+                            @version,
+                            payload,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Api.V2010.UserDefinedMessageList>'
+                    end
+                end
+
+                class UserDefinedMessagePage < Page
+                    ##
+                    # Initialize the UserDefinedMessagePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [UserDefinedMessagePage] UserDefinedMessagePage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of UserDefinedMessageInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [UserDefinedMessageInstance] UserDefinedMessageInstance
+                    def get_instance(payload)
+                        UserDefinedMessageInstance.new(@version, payload, account_sid: @solution[:account_sid], call_sid: @solution[:call_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Api.V2010.UserDefinedMessagePage>'
+                    end
+                end
+                class UserDefinedMessageInstance < InstanceResource
+                    ##
+                    # Initialize the UserDefinedMessageInstance
+                    # @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 UserDefinedMessage
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [UserDefinedMessageInstance] UserDefinedMessageInstance
+                    def initialize(version, payload , account_sid: nil, call_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'call_sid' => payload['call_sid'],
+                            'sid' => payload['sid'],
+                            'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created User Defined Message.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message is associated with.
+                    def call_sid
+                        @properties['call_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID that uniquely identifies this User Defined Message.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this User Defined Message was created, given in RFC 2822 format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Api.V2010.UserDefinedMessageInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Api.V2010.UserDefinedMessageInstance>"
+                    end
+                end
+
+             end
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+