twilio-ruby 5.31.1 → 5.54.0

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

@@ -18,7 +18,7 @@ module Twilio
             # Initialize the PhoneNumberList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the PhoneNumber resource's parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service) resource.
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
             # @return [PhoneNumberList] PhoneNumberList
             def initialize(version, service_sid: nil)
               super(version)
@@ -29,27 +29,24 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of PhoneNumberInstance records from the API.
-            # Request is executed immediately.
+            # Create the PhoneNumberInstance
             # @param [String] sid The SID of a Twilio
-            #   [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the Twilio Number you would like to assign to your Proxy Service.
+            #   {IncomingPhoneNumber}[https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource]
+            #   resource that represents the Twilio Number you would like to assign to your
+            #   Proxy Service.
             # @param [String] phone_number The phone number in
-            #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format.  E.164 phone
+            #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.  E.164 phone
             #   numbers consist of a + followed by the country code and subscriber number
             #   without punctuation characters. For example, +14155551234.
             # @param [Boolean] is_reserved Whether the new phone number 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
+            #   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
             #   information.
-            # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
+            # @return [PhoneNumberInstance] Created PhoneNumberInstance
             def create(sid: :unset, phone_number: :unset, is_reserved: :unset)
               data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number, 'IsReserved' => is_reserved, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -115,11 +112,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               PhoneNumberPage.new(@version, response, @solution)
             end
 
@@ -181,7 +176,7 @@ module Twilio
             # Initialize the PhoneNumberContext
             # @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 PhoneNumber
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] of the PhoneNumber
             #   resource to fetch.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   PhoneNumber resource to fetch.
@@ -195,23 +190,17 @@ module Twilio
             end
 
             ##
-            # Deletes the PhoneNumberInstance
+            # Delete the PhoneNumberInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a PhoneNumberInstance
+            # Fetch the PhoneNumberInstance
             # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               PhoneNumberInstance.new(
                   @version,
@@ -224,18 +213,14 @@ module Twilio
             ##
             # Update the PhoneNumberInstance
             # @param [Boolean] is_reserved Whether the phone number 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 [PhoneNumberInstance] Updated PhoneNumberInstance
             def update(is_reserved: :unset)
               data = Twilio::Values.of({'IsReserved' => is_reserved, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               PhoneNumberInstance.new(
                   @version,
@@ -268,7 +253,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 PhoneNumber 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
             #   PhoneNumber resource to fetch.
             # @return [PhoneNumberInstance] PhoneNumberInstance
@@ -380,14 +365,14 @@ module Twilio
             end
 
             ##
-            # Deletes the PhoneNumberInstance
+            # Delete the PhoneNumberInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a PhoneNumberInstance
+            # Fetch the PhoneNumberInstance
             # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
             def fetch
               context.fetch
@@ -396,8 +381,8 @@ module Twilio
             ##
             # Update the PhoneNumberInstance
             # @param [Boolean] is_reserved Whether the phone number 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 [PhoneNumberInstance] Updated PhoneNumberInstance
             def update(is_reserved: :unset)

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)
@@ -90,11 +90,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               SessionPage.new(@version, response, @solution)
             end
 
@@ -112,12 +110,11 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of SessionInstance records from the API.
-            # Request is executed immediately.
+            # Create the SessionInstance
             # @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
@@ -128,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.
-            # @return [SessionInstance] Newly created SessionInstance
-            def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
+            # @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, fail_on_participant_conflict: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
                   'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
@@ -139,13 +148,10 @@ 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
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -195,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.
@@ -213,49 +219,51 @@ module Twilio
             end
 
             ##
-            # Fetch a SessionInstance
+            # Fetch the SessionInstance
             # @return [SessionInstance] Fetched SessionInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the SessionInstance
+            # Delete the SessionInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # 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,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -327,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.
@@ -468,14 +476,14 @@ module Twilio
             end
 
             ##
-            # Fetch a SessionInstance
+            # Fetch the SessionInstance
             # @return [SessionInstance] Fetched SessionInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the SessionInstance
+            # Delete the SessionInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
@@ -483,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/session/interaction.rb

@@ -19,9 +19,9 @@ module Twilio
               # Initialize the InteractionList
               # @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) resource.
+              #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
               # @param [String] session_sid The SID of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session) resource.
+              #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
               # @return [InteractionList] InteractionList
               def initialize(version, service_sid: nil, session_sid: nil)
                 super(version)
@@ -92,11 +92,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 InteractionPage.new(@version, response, @solution)
               end
 
@@ -163,10 +161,10 @@ module Twilio
               # Initialize the InteractionContext
               # @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] session_sid The SID of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to
+              #   {Session}[https://www.twilio.com/docs/proxy/api/session] of the resource to
               #   fetch.
               # @param [String] sid The Twilio-provided string that uniquely identifies the
               #   Interaction resource to fetch.
@@ -180,16 +178,10 @@ module Twilio
               end
 
               ##
-              # Fetch a InteractionInstance
+              # Fetch the InteractionInstance
               # @return [InteractionInstance] Fetched InteractionInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 InteractionInstance.new(
                     @version,
@@ -201,10 +193,10 @@ module Twilio
               end
 
               ##
-              # Deletes the InteractionInstance
+              # Delete the InteractionInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -230,9 +222,9 @@ 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 parent
-              #   [Service](https://www.twilio.com/docs/proxy/api/service) resource.
+              #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
               # @param [String] session_sid The SID of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session) resource.
+              #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
               # @param [String] sid The Twilio-provided string that uniquely identifies the
               #   Interaction resource to fetch.
               # @return [InteractionInstance] InteractionInstance
@@ -402,14 +394,14 @@ module Twilio
               end
 
               ##
-              # Fetch a InteractionInstance
+              # Fetch the InteractionInstance
               # @return [InteractionInstance] Fetched InteractionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the InteractionInstance
+              # Delete the InteractionInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete