twilio-ruby 5.46.1 → 5.77.0

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

@@ -0,0 +1,160 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# 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
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,251 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class CallContext < InstanceContext
+            class UserDefinedMessageSubscriptionList < ListResource
+              ##
+              # Initialize the UserDefinedMessageSubscriptionList
+              # @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 subscribed to the
+              #   User Defined Messages.
+              # @param [String] call_sid The SID of the
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] the User Defined
+              #   Message Subscription is associated with. This refers to the Call SID that is
+              #   producing the User Defined Messages.
+              # @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"
+              end
+
+              ##
+              # Create the UserDefinedMessageSubscriptionInstance
+              # @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(callback: nil, idempotency_key: :unset, method: :unset)
+                data = Twilio::Values.of({
+                    'Callback' => callback,
+                    'IdempotencyKey' => idempotency_key,
+                    'Method' => method,
+                })
+
+                payload = @version.create('POST', @uri, data: data)
+
+                UserDefinedMessageSubscriptionInstance.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.UserDefinedMessageSubscriptionList>'
+              end
+            end
+
+            class UserDefinedMessageSubscriptionPage < Page
+              ##
+              # Initialize the UserDefinedMessageSubscriptionPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [UserDefinedMessageSubscriptionPage] UserDefinedMessageSubscriptionPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of UserDefinedMessageSubscriptionInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [UserDefinedMessageSubscriptionInstance] UserDefinedMessageSubscriptionInstance
+              def get_instance(payload)
+                UserDefinedMessageSubscriptionInstance.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.UserDefinedMessageSubscriptionPage>'
+              end
+            end
+
+            class UserDefinedMessageSubscriptionContext < InstanceContext
+              ##
+              # Initialize the UserDefinedMessageSubscriptionContext
+              # @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 subscribed to the
+              #   User Defined Messages.
+              # @param [String] call_sid The SID of the
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] the User Defined
+              #   Message Subscription is associated with. This refers to the Call SID that is
+              #   producing the User Defined Messages.
+              # @param [String] sid The SID that uniquely identifies this User Defined Message
+              #   Subscription.
+              # @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, }
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/UserDefinedMessageSubscriptions/#{@solution[:sid]}.json"
+              end
+
+              ##
+              # Delete the UserDefinedMessageSubscriptionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                 @version.delete('DELETE', @uri)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.UserDefinedMessageSubscriptionContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.UserDefinedMessageSubscriptionContext #{context}>"
+              end
+            end
+
+            class UserDefinedMessageSubscriptionInstance < InstanceResource
+              ##
+              # Initialize the UserDefinedMessageSubscriptionInstance
+              # @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 subscribed to the
+              #   User Defined Messages.
+              # @param [String] call_sid The SID of the
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] the User Defined
+              #   Message Subscription is associated with. This refers to the Call SID that is
+              #   producing the User Defined Messages.
+              # @param [String] sid The SID that uniquely identifies this User Defined Message
+              #   Subscription.
+              # @return [UserDefinedMessageSubscriptionInstance] UserDefinedMessageSubscriptionInstance
+              def initialize(version, payload, account_sid: nil, call_sid: nil, 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']),
+                    'uri' => payload['uri'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'account_sid' => account_sid, 'call_sid' => 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 [UserDefinedMessageSubscriptionContext] UserDefinedMessageSubscriptionContext for this UserDefinedMessageSubscriptionInstance
+              def context
+                unless @instance_context
+                  @instance_context = UserDefinedMessageSubscriptionContext.new(
+                      @version,
+                      @params['account_sid'],
+                      @params['call_sid'],
+                      @params['sid'],
+                  )
+                end
+                @instance_context
+              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 Subscription SID.
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [Time] The date this User Defined Message Subscription was created.
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [String] The URI of the User Defined Message Subscription Resource, relative to `https://api.twilio.com`.
+              def uri
+                @properties['uri']
+              end
+
+              ##
+              # Delete the UserDefinedMessageSubscriptionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.UserDefinedMessageSubscriptionInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.UserDefinedMessageSubscriptionInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -142,10 +142,17 @@ 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
@@ -153,11 +160,11 @@ module Twilio
             #   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, recording_track: :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,
@@ -191,7 +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)
@@ -433,6 +442,10 @@ module Twilio
               @feedback = nil
               @events = nil
               @payments = nil
+              @siprec = nil
+              @streams = nil
+              @user_defined_message_subscriptions = nil
+              @user_defined_messages = nil
             end
 
             ##
@@ -482,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,
@@ -493,6 +508,7 @@ module Twilio
                   'StatusCallback' => status_callback,
                   'StatusCallbackMethod' => status_callback_method,
                   'Twiml' => twiml,
+                  'TimeLimit' => time_limit,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -586,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
@@ -634,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'],
@@ -769,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
@@ -868,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,
@@ -879,6 +969,7 @@ module Twilio
                   status_callback: status_callback,
                   status_callback_method: status_callback_method,
                   twiml: twiml,
+                  time_limit: time_limit,
               )
             end
 
@@ -917,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