twilio-ruby 5.31.0 → 5.46.0

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

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

@@ -19,9 +19,9 @@ module Twilio
               # Initialize the ParticipantList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the 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] 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 [ParticipantList] ParticipantList
               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)
+
                 ParticipantPage.new(@version, response, @solution)
               end
 
@@ -114,8 +112,7 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of ParticipantInstance records from the API.
-              # Request is executed immediately.
+              # Create the ParticipantInstance
               # @param [String] identifier The phone number of the Participant.
               # @param [String] friendly_name The string that you assigned to describe the
               #   participant. This value must be 255 characters or fewer. **This value should not
@@ -124,20 +121,29 @@ module Twilio
               #   Participant. If not specified, Proxy will select a number from the pool.
               # @param [String] proxy_identifier_sid The SID of the Proxy Identifier to assign
               #   to the Participant.
-              # @return [ParticipantInstance] Newly created ParticipantInstance
-              def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :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 Participant create 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 [ParticipantInstance] Created ParticipantInstance
+              def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset, fail_on_participant_conflict: :unset)
                 data = Twilio::Values.of({
                     'Identifier' => identifier,
                     'FriendlyName' => friendly_name,
                     'ProxyIdentifier' => proxy_identifier,
                     'ProxyIdentifierSid' => proxy_identifier_sid,
+                    'FailOnParticipantConflict' => fail_on_participant_conflict,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 ParticipantInstance.new(
                     @version,
@@ -197,10 +203,10 @@ module Twilio
               # Initialize the ParticipantContext
               # @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
               #   Participant resource to fetch.
@@ -217,16 +223,10 @@ module Twilio
               end
 
               ##
-              # Fetch a ParticipantInstance
+              # Fetch the ParticipantInstance
               # @return [ParticipantInstance] Fetched ParticipantInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 ParticipantInstance.new(
                     @version,
@@ -238,10 +238,10 @@ module Twilio
               end
 
               ##
-              # Deletes the ParticipantInstance
+              # Delete the ParticipantInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -296,9 +296,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 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] 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
               #   Participant resource to fetch.
               # @return [ParticipantInstance] ParticipantInstance
@@ -426,14 +426,14 @@ module Twilio
               end
 
               ##
-              # Fetch a ParticipantInstance
+              # Fetch the ParticipantInstance
               # @return [ParticipantInstance] Fetched ParticipantInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the ParticipantInstance
+              # Delete the ParticipantInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete

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

@@ -20,11 +20,11 @@ module Twilio
                 # Initialize the MessageInteractionList
                 # @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.
                 # @param [String] participant_sid The SID of the
-                #   [Participant](https://www.twilio.com/docs/proxy/api/participant) resource.
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
                 # @return [MessageInteractionList] MessageInteractionList
                 def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
                   super(version)
@@ -35,19 +35,14 @@ module Twilio
                 end
 
                 ##
-                # Retrieve a single page of MessageInteractionInstance records from the API.
-                # Request is executed immediately.
+                # Create the MessageInteractionInstance
                 # @param [String] body The message to send to the participant
-                # @param [String] media_url Reserved. Not currently supported.
-                # @return [MessageInteractionInstance] Newly created MessageInteractionInstance
+                # @param [Array[String]] media_url Reserved. Not currently supported.
+                # @return [MessageInteractionInstance] Created MessageInteractionInstance
                 def create(body: :unset, media_url: :unset)
                   data = Twilio::Values.of({'Body' => body, 'MediaUrl' => Twilio.serialize_list(media_url) { |e| e }, })
 
-                  payload = @version.create(
-                      'POST',
-                      @uri,
-                      data: data
-                  )
+                  payload = @version.create('POST', @uri, data: data)
 
                   MessageInteractionInstance.new(
                       @version,
@@ -119,11 +114,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   MessageInteractionPage.new(@version, response, @solution)
                 end
 
@@ -191,13 +184,13 @@ module Twilio
                 # Initialize the MessageInteractionContext
                 # @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] participant_sid The SID of the
-                #   [Participant](https://www.twilio.com/docs/proxy/api/participant) resource.
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
                 # @param [String] sid The Twilio-provided string that uniquely identifies the
                 #   MessageInteraction resource to fetch.
                 # @return [MessageInteractionContext] MessageInteractionContext
@@ -215,16 +208,10 @@ module Twilio
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
+                # Fetch the MessageInteractionInstance
                 # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   MessageInteractionInstance.new(
                       @version,
@@ -259,11 +246,11 @@ 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] participant_sid The SID of the
-                #   [Participant](https://www.twilio.com/docs/proxy/api/participant) resource.
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
                 # @param [String] sid The Twilio-provided string that uniquely identifies the
                 #   MessageInteraction resource to fetch.
                 # @return [MessageInteractionInstance] MessageInteractionInstance
@@ -442,7 +429,7 @@ module Twilio
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
+                # Fetch the MessageInteractionInstance
                 # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
                 def fetch
                   context.fetch

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)
@@ -29,20 +29,15 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
-            # Request is executed immediately.
+            # 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] Newly created ShortCodeInstance
+            # @return [ShortCodeInstance] Created ShortCodeInstance
             def create(sid: nil)
               data = Twilio::Values.of({'Sid' => sid, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -108,11 +103,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ShortCodePage.new(@version, response, @solution)
             end
 
@@ -174,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.
@@ -188,23 +181,17 @@ module Twilio
             end
 
             ##
-            # Deletes the ShortCodeInstance
+            # Delete the ShortCodeInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -212,18 +199,14 @@ 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 = Twilio::Values.of({'IsReserved' => is_reserved, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -251,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
@@ -349,14 +332,14 @@ module Twilio
             end
 
             ##
-            # Deletes the ShortCodeInstance
+            # Delete the ShortCodeInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
               context.fetch
@@ -365,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)