twilio-ruby 5.39.2 → 5.60.0

data/lib/twilio-ruby/rest/proxy/v1/service/session.rb

@@ -18,7 +18,7 @@ module Twilio
             # Initialize the SessionList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/proxy/api/service) the session is
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] the session is
             #   associated with.
             # @return [SessionList] SessionList
             def initialize(version, service_sid: nil)
@@ -114,7 +114,7 @@ module Twilio
             # @param [String] unique_name An application-defined string that uniquely
             #   identifies the resource. This value must be 191 characters or fewer in length
             #   and be unique. **This value should not have PII.**
-            # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+            # @param [Time] date_expiry The {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
             #   date when the Session should expire. If this is value is present, it overrides
             #   the `ttl` value.
             # @param [String] ttl The time, in seconds, when the session will expire. The time
@@ -125,10 +125,22 @@ module Twilio
             # @param [session.Status] status The initial status of the Session. Can be:
             #   `open`, `in-progress`, `closed`, `failed`, or `unknown`. The default is `open`
             #   on create.
-            # @param [Hash] participants The Participant objects to include in the new
+            # @param [Array[Hash]] participants The Participant objects to include in the new
             #   session.
+            # @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
+            #   the ProxyAllowParticipantConflict account flag, setting to true enables
+            #   per-request opt-in to allowing Proxy to reject a Session create (with
+            #   Participants) request that could cause the same Identifier/ProxyIdentifier pair
+            #   to be active in multiple Sessions. Depending on the context, this could be a 409
+            #   error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not
+            #   provided, requests will be allowed to succeed and a Debugger notification
+            #   (80802) will be emitted. Having multiple, active Participants with the same
+            #   Identifier/ProxyIdentifier pair causes calls and messages from affected
+            #   Participants to be routed incorrectly. Please note, the default behavior for
+            #   accounts without the ProxyAllowParticipantConflict flag is to reject the request
+            #   as described.  This will eventually be the default for all accounts.
             # @return [SessionInstance] Created SessionInstance
-            def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
+            def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset, fail_on_participant_conflict: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
                   'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
@@ -136,6 +148,7 @@ module Twilio
                   'Mode' => mode,
                   'Status' => status,
                   'Participants' => Twilio.serialize_list(participants) { |e| Twilio.serialize_object(e) },
+                  'FailOnParticipantConflict' => fail_on_participant_conflict,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -188,7 +201,7 @@ module Twilio
             # Initialize the SessionContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] of the resource to
             #   fetch.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Session resource to fetch.
@@ -223,19 +236,31 @@ module Twilio
 
             ##
             # Update the SessionInstance
-            # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+            # @param [Time] date_expiry The {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
             #   date when the Session should expire. If this is value is present, it overrides
             #   the `ttl` value.
             # @param [String] ttl The time, in seconds, when the session will expire. The time
             #   is measured from the last Session create or the Session's last Interaction.
             # @param [session.Status] status The new status of the resource. Can be:
             #   `in-progress` to re-open a session or `closed` to close a session.
+            # @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
+            #   the ProxyAllowParticipantConflict account flag, setting to true enables
+            #   per-request opt-in to allowing Proxy to return a 400 error (Twilio error code
+            #   80604) when a request to set a Session to in-progress would cause Participants
+            #   with the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
+            #   If not provided, requests will be allowed to succeed, and a Debugger
+            #   notification (80801) will be emitted. Having multiple, active Participants with
+            #   the same Identifier/ProxyIdentifier pair causes calls and messages from affected
+            #   Participants to be routed incorrectly. Please note, the default behavior for
+            #   accounts without the ProxyAllowParticipantConflict flag is to reject the request
+            #   as described.  This will eventually be the default for all accounts.
             # @return [SessionInstance] Updated SessionInstance
-            def update(date_expiry: :unset, ttl: :unset, status: :unset)
+            def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
               data = Twilio::Values.of({
                   'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
                   'Ttl' => ttl,
                   'Status' => status,
+                  'FailOnParticipantConflict' => fail_on_participant_conflict,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -310,7 +335,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/proxy/api/service) the session is
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] the session is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Session resource to fetch.
@@ -466,16 +491,32 @@ module Twilio
 
             ##
             # Update the SessionInstance
-            # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+            # @param [Time] date_expiry The {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
             #   date when the Session should expire. If this is value is present, it overrides
             #   the `ttl` value.
             # @param [String] ttl The time, in seconds, when the session will expire. The time
             #   is measured from the last Session create or the Session's last Interaction.
             # @param [session.Status] status The new status of the resource. Can be:
             #   `in-progress` to re-open a session or `closed` to close a session.
+            # @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
+            #   the ProxyAllowParticipantConflict account flag, setting to true enables
+            #   per-request opt-in to allowing Proxy to return a 400 error (Twilio error code
+            #   80604) when a request to set a Session to in-progress would cause Participants
+            #   with the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
+            #   If not provided, requests will be allowed to succeed, and a Debugger
+            #   notification (80801) will be emitted. Having multiple, active Participants with
+            #   the same Identifier/ProxyIdentifier pair causes calls and messages from affected
+            #   Participants to be routed incorrectly. Please note, the default behavior for
+            #   accounts without the ProxyAllowParticipantConflict flag is to reject the request
+            #   as described.  This will eventually be the default for all accounts.
             # @return [SessionInstance] Updated SessionInstance
-            def update(date_expiry: :unset, ttl: :unset, status: :unset)
-              context.update(date_expiry: date_expiry, ttl: ttl, status: status, )
+            def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
+              context.update(
+                  date_expiry: date_expiry,
+                  ttl: ttl,
+                  status: status,
+                  fail_on_participant_conflict: fail_on_participant_conflict,
+              )
             end
 
             ##

data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb

@@ -18,7 +18,7 @@ module Twilio
             # Initialize the ShortCodeList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the ShortCode resource's parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service) resource.
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, service_sid: nil)
               super(version)
@@ -31,7 +31,7 @@ module Twilio
             ##
             # Create the ShortCodeInstance
             # @param [String] sid The SID of a Twilio
-            #   [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that
+            #   {ShortCode}[https://www.twilio.com/docs/sms/api/short-code] resource that
             #   represents the short code you would like to assign to your Proxy Service.
             # @return [ShortCodeInstance] Created ShortCodeInstance
             def create(sid: nil)
@@ -167,7 +167,7 @@ module Twilio
             # Initialize the ShortCodeContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service) to fetch the resource
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] to fetch the resource
             #   from.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   ShortCode resource to fetch.
@@ -199,8 +199,8 @@ module Twilio
             ##
             # Update the ShortCodeInstance
             # @param [Boolean] is_reserved Whether the short code should be reserved and not
-            #   be assigned to a participant using proxy pool logic. See [Reserved Phone
-            #   Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more
+            #   be assigned to a participant using proxy pool logic. See {Reserved Phone
+            #   Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
             #   information.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(is_reserved: :unset)
@@ -234,7 +234,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the ShortCode resource's parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service) resource.
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   ShortCode resource to fetch.
             # @return [ShortCodeInstance] ShortCodeInstance
@@ -348,8 +348,8 @@ module Twilio
             ##
             # Update the ShortCodeInstance
             # @param [Boolean] is_reserved Whether the short code should be reserved and not
-            #   be assigned to a participant using proxy pool logic. See [Reserved Phone
-            #   Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more
+            #   be assigned to a participant using proxy pool logic. See {Reserved Phone
+            #   Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
             #   information.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(is_reserved: :unset)

data/lib/twilio-ruby/rest/proxy/v1/service.rb

@@ -126,7 +126,7 @@ module Twilio
           #   `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`.
           #   `prefer-sticky` means that we will try and select the same Proxy Number for a
           #   given participant if they have previous
-          #   [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail
+          #   {Sessions}[https://www.twilio.com/docs/proxy/api/session], but we will not fail
           #   if that Proxy Number cannot be used.  `avoid-sticky` means that we will try to
           #   use different Proxy Numbers as long as that is possible within a given pool
           #   rather than try and use a previously assigned number.
@@ -135,12 +135,12 @@ module Twilio
           #   continues.
           # @param [String] out_of_session_callback_url The URL we should call when an
           #   inbound call or SMS action occurs on a closed or non-existent Session. If your
-          #   server (or a Twilio [function](https://www.twilio.com/functions)) responds with
-          #   valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This
+          #   server (or a Twilio {function}[https://www.twilio.com/functions]) responds with
+          #   valid {TwiML}[https://www.twilio.com/docs/voice/twiml], we will process it. This
           #   means it is possible, for example, to play a message for a call, send an
           #   automated text message response, or redirect a call to another Phone Number. See
-          #   [Out-of-Session Callback Response
-          #   Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide)
+          #   {Out-of-Session Callback Response
+          #   Guide}[https://www.twilio.com/docs/proxy/out-session-callback-response-guide]
           #   for more information.
           # @param [String] chat_instance_sid The SID of the Chat Service Instance managed
           #   by Proxy Service. The Chat Service enables Proxy to forward SMS and channel
@@ -260,7 +260,7 @@ module Twilio
           #   `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`.
           #   `prefer-sticky` means that we will try and select the same Proxy Number for a
           #   given participant if they have previous
-          #   [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail
+          #   {Sessions}[https://www.twilio.com/docs/proxy/api/session], but we will not fail
           #   if that Proxy Number cannot be used.  `avoid-sticky` means that we will try to
           #   use different Proxy Numbers as long as that is possible within a given pool
           #   rather than try and use a previously assigned number.
@@ -269,12 +269,12 @@ module Twilio
           #   continues.
           # @param [String] out_of_session_callback_url The URL we should call when an
           #   inbound call or SMS action occurs on a closed or non-existent Session. If your
-          #   server (or a Twilio [function](https://www.twilio.com/functions)) responds with
-          #   valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This
+          #   server (or a Twilio {function}[https://www.twilio.com/functions]) responds with
+          #   valid {TwiML}[https://www.twilio.com/docs/voice/twiml], we will process it. This
           #   means it is possible, for example, to play a message for a call, send an
           #   automated text message response, or redirect a call to another Phone Number. See
-          #   [Out-of-Session Callback Response
-          #   Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide)
+          #   {Out-of-Session Callback Response
+          #   Guide}[https://www.twilio.com/docs/proxy/out-session-callback-response-guide]
           #   for more information.
           # @param [String] chat_instance_sid The SID of the Chat Service Instance managed
           #   by Proxy Service. The Chat Service enables Proxy to forward SMS and channel
@@ -532,7 +532,7 @@ module Twilio
           #   `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`.
           #   `prefer-sticky` means that we will try and select the same Proxy Number for a
           #   given participant if they have previous
-          #   [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail
+          #   {Sessions}[https://www.twilio.com/docs/proxy/api/session], but we will not fail
           #   if that Proxy Number cannot be used.  `avoid-sticky` means that we will try to
           #   use different Proxy Numbers as long as that is possible within a given pool
           #   rather than try and use a previously assigned number.
@@ -541,12 +541,12 @@ module Twilio
           #   continues.
           # @param [String] out_of_session_callback_url The URL we should call when an
           #   inbound call or SMS action occurs on a closed or non-existent Session. If your
-          #   server (or a Twilio [function](https://www.twilio.com/functions)) responds with
-          #   valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This
+          #   server (or a Twilio {function}[https://www.twilio.com/functions]) responds with
+          #   valid {TwiML}[https://www.twilio.com/docs/voice/twiml], we will process it. This
           #   means it is possible, for example, to play a message for a call, send an
           #   automated text message response, or redirect a call to another Phone Number. See
-          #   [Out-of-Session Callback Response
-          #   Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide)
+          #   {Out-of-Session Callback Response
+          #   Guide}[https://www.twilio.com/docs/proxy/out-session-callback-response-guide]
           #   for more information.
           # @param [String] chat_instance_sid The SID of the Chat Service Instance managed
           #   by Proxy Service. The Chat Service enables Proxy to forward SMS and channel

data/lib/twilio-ruby/rest/proxy/v1.rb

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Proxy::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb

@@ -13,7 +13,7 @@ module Twilio
         class ServiceContext < InstanceContext
           class AssetContext < InstanceContext
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class AssetVersionList < ListResource
               ##
               # Initialize the AssetVersionList
@@ -21,7 +21,7 @@ module Twilio
               # @param [String] service_sid The SID of the Service that the Asset Version
               #   resource is associated with.
               # @param [String] asset_sid The SID of the Asset resource that is the parent of
-              #   the asset version.
+              #   the Asset Version.
               # @return [AssetVersionList] AssetVersionList
               def initialize(version, service_sid: nil, asset_sid: nil)
                 super(version)
@@ -119,7 +119,7 @@ module Twilio
             end
 
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class AssetVersionPage < Page
               ##
               # Initialize the AssetVersionPage
@@ -155,7 +155,7 @@ module Twilio
             end
 
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class AssetVersionContext < InstanceContext
               ##
               # Initialize the AssetVersionContext
@@ -205,7 +205,7 @@ module Twilio
             end
 
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class AssetVersionInstance < InstanceResource
               ##
               # Initialize the AssetVersionInstance
@@ -214,7 +214,7 @@ module Twilio
               # @param [String] service_sid The SID of the Service that the Asset Version
               #   resource is associated with.
               # @param [String] asset_sid The SID of the Asset resource that is the parent of
-              #   the asset version.
+              #   the Asset Version.
               # @param [String] sid The SID of the Asset Version resource to fetch.
               # @return [AssetVersionInstance] AssetVersionInstance
               def initialize(version, payload, service_sid: nil, asset_sid: nil, sid: nil)
@@ -276,19 +276,19 @@ module Twilio
               end
 
               ##
-              # @return [String] The SID of the Asset resource that is the parent of the asset version
+              # @return [String] The SID of the Asset resource that is the parent of the Asset Version
               def asset_sid
                 @properties['asset_sid']
               end
 
               ##
-              # @return [String] The URL-friendly string by which the asset version can be referenced
+              # @return [String] The URL-friendly string by which the Asset Version can be referenced
               def path
                 @properties['path']
               end
 
               ##
-              # @return [asset_version.Visibility] The access control that determines how the asset version can be accessed
+              # @return [asset_version.Visibility] The access control that determines how the Asset Version can be accessed
               def visibility
                 @properties['visibility']
               end

data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb

@@ -12,7 +12,7 @@ module Twilio
       class V1 < Version
         class ServiceContext < InstanceContext
           ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class AssetList < ListResource
             ##
             # Initialize the AssetList
@@ -111,7 +111,7 @@ module Twilio
             ##
             # Create the AssetInstance
             # @param [String] friendly_name A descriptive string that you create to describe
-            #   the Asset resource. It can be up to 255 characters long.
+            #   the Asset resource. It can be a maximum of 255 characters.
             # @return [AssetInstance] Created AssetInstance
             def create(friendly_name: nil)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -129,7 +129,7 @@ module Twilio
           end
 
           ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class AssetPage < Page
             ##
             # Initialize the AssetPage
@@ -160,14 +160,14 @@ module Twilio
           end
 
           ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class AssetContext < InstanceContext
             ##
             # Initialize the AssetContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the Service to fetch the Asset resource
             #   from.
-            # @param [String] sid The SID of the Asset resource to fetch.
+            # @param [String] sid The SID that identifies the Asset resource to fetch.
             # @return [AssetContext] AssetContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -199,7 +199,7 @@ module Twilio
             ##
             # Update the AssetInstance
             # @param [String] friendly_name A descriptive string that you create to describe
-            #   the Asset resource. It can be up to 255 characters long.
+            #   the Asset resource. It can be a maximum of 255 characters.
             # @return [AssetInstance] Updated AssetInstance
             def update(friendly_name: nil)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -247,7 +247,7 @@ module Twilio
           end
 
           ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class AssetInstance < InstanceResource
             ##
             # Initialize the AssetInstance
@@ -255,7 +255,7 @@ module Twilio
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the Service that the Asset resource is
             #   associated with.
-            # @param [String] sid The SID of the Asset resource to fetch.
+            # @param [String] sid The SID that identifies the Asset resource to fetch.
             # @return [AssetInstance] AssetInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -331,7 +331,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The links to the nested resources of the asset
+            # @return [String] The URLs of the Asset resource's nested resources
             def links
               @properties['links']
             end
@@ -353,7 +353,7 @@ module Twilio
             ##
             # Update the AssetInstance
             # @param [String] friendly_name A descriptive string that you create to describe
-            #   the Asset resource. It can be up to 255 characters long.
+            #   the Asset resource. It can be a maximum of 255 characters.
             # @return [AssetInstance] Updated AssetInstance
             def update(friendly_name: nil)
               context.update(friendly_name: friendly_name, )