twilio-ruby 5.40.3 → 5.74.1

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the CallList
             # @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 Call
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
             #   resource.
             # @return [CallList] CallList
             def initialize(version, account_sid: nil)
@@ -34,8 +34,8 @@ module Twilio
             # Create the CallInstance
             # @param [String] to The phone number, SIP address, or client identifier to call.
             # @param [String] from The phone number or client identifier to use as the caller
-            #   id. If using a phone number, it must be a Twilio number or a Verified [outgoing
-            #   caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your
+            #   id. If using a phone number, it must be a Twilio number or a Verified {outgoing
+            #   caller id}[https://www.twilio.com/docs/voice/api/outgoing-caller-ids] for your
             #   account. If the `to` parameter is a phone number, `From` must also be a phone
             #   number.
             # @param [String] method The HTTP method we should use when calling the `url`
@@ -52,12 +52,12 @@ module Twilio
             #   `status_callback_event` is specified, we will send the `completed` status. If an
             #   `application_sid` parameter is present, this parameter is ignored. URLs must
             #   contain a valid hostname (underscores are not permitted).
-            # @param [String] status_callback_event The call progress events that we will send
-            #   to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and
-            #   `completed`. If no event is specified, we send the `completed` status. If you
-            #   want to receive multiple events, specify each one in a separate
-            #   `status_callback_event` parameter. See the code sample for [monitoring call
-            #   progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json).
+            # @param [Array[String]] status_callback_event The call progress events that we
+            #   will send to the `status_callback` URL. Can be: `initiated`, `ringing`,
+            #   `answered`, and `completed`. If no event is specified, we send the `completed`
+            #   status. If you want to receive multiple events, specify each one in a separate
+            #   `status_callback_event` parameter. See the code sample for {monitoring call
+            #   progress}[https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json].
             #   If an `application_sid` is present, this parameter is ignored.
             # @param [String] status_callback_method The HTTP method we should use when
             #   calling the `status_callback` URL. Can be: `GET` or `POST` and the default is
@@ -101,21 +101,21 @@ module Twilio
             #   Use `Enable` if you would like us to return `AnsweredBy` as soon as the called
             #   party is identified. Use `DetectMessageEnd`, if you would like to leave a
             #   message on an answering machine. If `send_digits` is provided, this parameter is
-            #   ignored. For more information, see [Answering Machine
-            #   Detection](https://www.twilio.com/docs/voice/answering-machine-detection).
+            #   ignored. For more information, see {Answering Machine
+            #   Detection}[https://www.twilio.com/docs/voice/answering-machine-detection].
             # @param [String] machine_detection_timeout The number of seconds that we should
             #   attempt to detect an answering machine before timing out and sending a voice
             #   request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.
-            # @param [String] recording_status_callback_event The recording status events that
-            #   will trigger calls to the URL specified in `recording_status_callback`. Can be:
-            #   `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate
-            #   multiple values with a space.
+            # @param [Array[String]] recording_status_callback_event The recording status
+            #   events that will trigger calls to the URL specified in
+            #   `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`.
+            #   Defaults to `completed`. Separate  multiple values with a space.
             # @param [String] trim Whether to trim any leading and trailing silence from the
             #   recording. Can be: `trim-silence` or `do-not-trim` and the default is
             #   `trim-silence`.
             # @param [String] caller_id The phone number, SIP address, or Client identifier
-            #   that made this call. Phone numbers are in [E.164
-            #   format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212).
+            #   that made this call. Phone numbers are in {E.164
+            #   format}[https://wwnw.twilio.com/docs/glossary/what-e164] (e.g., +16175551212).
             #   SIP addresses are formatted as `name@company.com`.
             # @param [String] machine_detection_speech_threshold The number of milliseconds
             #   that is used as the measuring stick for the length of the speech activity, where
@@ -142,18 +142,29 @@ module Twilio
             # @param [String] call_reason The Reason for the outgoing call. Use it to specify
             #   the purpose of the call that is presented on the called party's phone. (Branded
             #   Calls Beta)
+            # @param [String] call_token A token string needed to invoke a forwarded call. A
+            #   call_token is generated when an incoming call is received on a Twilio number.
+            #   Pass an incoming call's call_token value to a forwarded call via the call_token
+            #   parameter when creating a new call. A forwarded call should bear the same
+            #   CallerID of the original incoming call.
+            # @param [String] recording_track The audio track to record for the call. Can be:
+            #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
+            #   audio that is received by Twilio. `outbound` records the audio that is generated
+            #   from Twilio. `both` records the audio that is received and generated by Twilio.
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @param [String] url The absolute URL that returns the TwiML instructions for the
             #   call. We will call this URL using the `method` when the call connects. For more
-            #   information, see the [Url
-            #   Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter)
-            #   section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).
+            #   information, see the {Url
+            #   Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter]
+            #   section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls].
             # @param [String] twiml TwiML instructions for the call Twilio will use without
             #   fetching Twiml from url parameter. If both `twiml` and `url` are provided then
-            #   `twiml` parameter will be ignored.
+            #   `twiml` parameter will be ignored. Max 4000 characters.
             # @param [String] application_sid The SID of the Application resource that will
             #   handle the call, if the call will be handled by an application.
             # @return [CallInstance] Created CallInstance
-            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, url: :unset, twiml: :unset, application_sid: :unset)
+            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, call_token: :unset, recording_track: :unset, time_limit: :unset, url: :unset, twiml: :unset, application_sid: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -187,6 +198,9 @@ module Twilio
                   'AsyncAmdStatusCallbackMethod' => async_amd_status_callback_method,
                   'Byoc' => byoc,
                   'CallReason' => call_reason,
+                  'CallToken' => call_token,
+                  'RecordingTrack' => recording_track,
+                  'TimeLimit' => time_limit,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -411,7 +425,7 @@ module Twilio
             # Initialize the CallContext
             # @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 the Call
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the Call
             #   resource(s) to fetch.
             # @param [String] sid The SID of the Call resource to fetch.
             # @return [CallContext] CallContext
@@ -426,7 +440,12 @@ module Twilio
               @recordings = nil
               @notifications = nil
               @feedback = nil
+              @events = nil
               @payments = nil
+              @siprec = nil
+              @streams = nil
+              @user_defined_message_subscriptions = nil
+              @user_defined_messages = nil
             end
 
             ##
@@ -449,9 +468,9 @@ module Twilio
             # Update the CallInstance
             # @param [String] url The absolute URL that returns the TwiML instructions for the
             #   call. We will call this URL using the `method` when the call connects. For more
-            #   information, see the [Url
-            #   Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter)
-            #   section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).
+            #   information, see the {Url
+            #   Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter]
+            #   section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls].
             # @param [String] method The HTTP method we should use when calling the `url`. Can
             #   be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter
             #   is present, this parameter is ignored.
@@ -476,8 +495,10 @@ module Twilio
             #   `POST`. If an `application_sid` parameter is present, this parameter is ignored.
             # @param [String] twiml TwiML instructions for the call Twilio will use without
             #   fetching Twiml from url. Twiml and url parameters are mutually exclusive
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @return [CallInstance] Updated CallInstance
-            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset)
+            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :unset)
               data = Twilio::Values.of({
                   'Url' => url,
                   'Method' => method,
@@ -487,6 +508,7 @@ module Twilio
                   'StatusCallback' => status_callback,
                   'StatusCallbackMethod' => status_callback_method,
                   'Twiml' => twiml,
+                  'TimeLimit' => time_limit,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -546,6 +568,18 @@ module Twilio
               FeedbackContext.new(@version, @solution[:account_sid], @solution[:sid], )
             end
 
+            ##
+            # Access the events
+            # @return [EventList]
+            # @return [EventContext]
+            def events
+              unless @events
+                @events = EventList.new(@version, account_sid: @solution[:account_sid], call_sid: @solution[:sid], )
+              end
+
+              @events
+            end
+
             ##
             # Access the payments
             # @return [PaymentList]
@@ -568,6 +602,85 @@ module Twilio
               @payments
             end
 
+            ##
+            # Access the siprec
+            # @return [SiprecList]
+            # @return [SiprecContext] if sid was passed.
+            def siprec(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return SiprecContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
+              end
+
+              unless @siprec
+                @siprec = SiprecList.new(@version, account_sid: @solution[:account_sid], call_sid: @solution[:sid], )
+              end
+
+              @siprec
+            end
+
+            ##
+            # Access the streams
+            # @return [StreamList]
+            # @return [StreamContext] if sid was passed.
+            def streams(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return StreamContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
+              end
+
+              unless @streams
+                @streams = StreamList.new(@version, account_sid: @solution[:account_sid], call_sid: @solution[:sid], )
+              end
+
+              @streams
+            end
+
+            ##
+            # Access the user_defined_message_subscriptions
+            # @return [UserDefinedMessageSubscriptionList]
+            # @return [UserDefinedMessageSubscriptionContext] if sid was passed.
+            def user_defined_message_subscriptions(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return UserDefinedMessageSubscriptionContext.new(
+                    @version,
+                    @solution[:account_sid],
+                    @solution[:sid],
+                    sid,
+                )
+              end
+
+              unless @user_defined_message_subscriptions
+                @user_defined_message_subscriptions = UserDefinedMessageSubscriptionList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:sid],
+                )
+              end
+
+              @user_defined_message_subscriptions
+            end
+
+            ##
+            # Access the user_defined_messages
+            # @return [UserDefinedMessageList]
+            # @return [UserDefinedMessageContext]
+            def user_defined_messages
+              unless @user_defined_messages
+                @user_defined_messages = UserDefinedMessageList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:sid],
+                )
+              end
+
+              @user_defined_messages
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -589,7 +702,7 @@ module Twilio
             # @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 Call
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
             #   resource.
             # @param [String] sid The SID of the Call resource to fetch.
             # @return [CallInstance] CallInstance
@@ -616,7 +729,6 @@ module Twilio
                   'price_unit' => payload['price_unit'],
                   'direction' => payload['direction'],
                   'answered_by' => payload['answered_by'],
-                  'annotation' => payload['annotation'],
                   'api_version' => payload['api_version'],
                   'forwarded_from' => payload['forwarded_from'],
                   'group_sid' => payload['group_sid'],
@@ -751,12 +863,6 @@ module Twilio
               @properties['answered_by']
             end
 
-            ##
-            # @return [String] The annotation provided for the call
-            def annotation
-              @properties['annotation']
-            end
-
             ##
             # @return [String] The API Version used to create the call
             def api_version
@@ -823,9 +929,9 @@ module Twilio
             # Update the CallInstance
             # @param [String] url The absolute URL that returns the TwiML instructions for the
             #   call. We will call this URL using the `method` when the call connects. For more
-            #   information, see the [Url
-            #   Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter)
-            #   section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).
+            #   information, see the {Url
+            #   Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter]
+            #   section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls].
             # @param [String] method The HTTP method we should use when calling the `url`. Can
             #   be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter
             #   is present, this parameter is ignored.
@@ -850,8 +956,10 @@ module Twilio
             #   `POST`. If an `application_sid` parameter is present, this parameter is ignored.
             # @param [String] twiml TwiML instructions for the call Twilio will use without
             #   fetching Twiml from url. Twiml and url parameters are mutually exclusive
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @return [CallInstance] Updated CallInstance
-            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset)
+            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :unset)
               context.update(
                   url: url,
                   method: method,
@@ -861,6 +969,7 @@ module Twilio
                   status_callback: status_callback,
                   status_callback_method: status_callback_method,
                   twiml: twiml,
+                  time_limit: time_limit,
               )
             end
 
@@ -885,6 +994,13 @@ module Twilio
               context.feedback
             end
 
+            ##
+            # Access the events
+            # @return [events] events
+            def events
+              context.events
+            end
+
             ##
             # Access the payments
             # @return [payments] payments
@@ -892,6 +1008,34 @@ module Twilio
               context.payments
             end
 
+            ##
+            # Access the siprec
+            # @return [siprec] siprec
+            def siprec
+              context.siprec
+            end
+
+            ##
+            # Access the streams
+            # @return [streams] streams
+            def streams
+              context.streams
+            end
+
+            ##
+            # Access the user_defined_message_subscriptions
+            # @return [user_defined_message_subscriptions] user_defined_message_subscriptions
+            def user_defined_message_subscriptions
+              context.user_defined_message_subscriptions
+            end
+
+            ##
+            # Access the user_defined_messages
+            # @return [user_defined_messages] user_defined_messages
+            def user_defined_messages
+              context.user_defined_messages
+            end
+
             ##
             # Provide a user friendly representation
             def to_s