twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -18,10 +18,10 @@ module Twilio
               ##
               # Initialize the InteractionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the parent
-              #   [Service](https://www.twilio.com/docs/proxy/api/service).
-              # @param [String] session_sid The unique SID identifier of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session).
+              # @param [String] service_sid The SID of the parent
+              #   {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.
               # @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
 
@@ -162,12 +160,14 @@ module Twilio
               ##
               # Initialize the InteractionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the parent
-              #   [Service](https://www.twilio.com/docs/proxy/api/service).
-              # @param [String] session_sid The unique SID identifier of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session).
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   Interaction.
+              # @param [String] service_sid The SID of the parent
+              #   {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
+              #   fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Interaction resource to fetch.
               # @return [InteractionContext] InteractionContext
               def initialize(version, service_sid, session_sid, sid)
                 super(version)
@@ -178,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,
@@ -199,10 +193,10 @@ module Twilio
               end
 
               ##
-              # Deletes the InteractionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the InteractionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -211,6 +205,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Proxy.V1.InteractionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Proxy.V1.InteractionContext #{context}>"
+              end
             end
 
             ##
@@ -220,12 +221,12 @@ module Twilio
               # Initialize the InteractionInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The unique SID identifier of the parent
-              #   [Service](https://www.twilio.com/docs/proxy/api/service).
-              # @param [String] session_sid The unique SID identifier of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session).
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   Interaction.
+              # @param [String] service_sid The SID of the parent
+              #   {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.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Interaction resource to fetch.
               # @return [InteractionInstance] InteractionInstance
               def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
                 super(version)
@@ -279,129 +280,129 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this Interaction.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] Session Sid.
+              # @return [String] The SID of the resource's parent Session
               def session_sid
                 @properties['session_sid']
               end
 
               ##
-              # @return [String] Service Sid.
+              # @return [String] The SID of the resource's parent Service
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] Account Sid.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] Further details about an interaction.
+              # @return [String] A JSON string that includes the message body of message interactions
               def data
                 @properties['data']
               end
 
               ##
-              # @return [interaction.Type] The Type of this Interaction
+              # @return [interaction.Type] The Type of the Interaction
               def type
                 @properties['type']
               end
 
               ##
-              # @return [String] Inbound Participant Sid.
+              # @return [String] The SID of the inbound Participant resource
               def inbound_participant_sid
                 @properties['inbound_participant_sid']
               end
 
               ##
-              # @return [String] Inbound Resource Sid.
+              # @return [String] The SID of the inbound resource
               def inbound_resource_sid
                 @properties['inbound_resource_sid']
               end
 
               ##
-              # @return [interaction.ResourceStatus] The Inbound Resource Status of this Interaction
+              # @return [interaction.ResourceStatus] The inbound resource status of the Interaction
               def inbound_resource_status
                 @properties['inbound_resource_status']
               end
 
               ##
-              # @return [String] The type of the Inbound Resource, Call or Message.
+              # @return [String] The inbound resource type
               def inbound_resource_type
                 @properties['inbound_resource_type']
               end
 
               ##
-              # @return [String] The URL of the Twilio inbound resource.
+              # @return [String] The URL of the Twilio inbound resource
               def inbound_resource_url
                 @properties['inbound_resource_url']
               end
 
               ##
-              # @return [String] Outbound Participant Sid.
+              # @return [String] The SID of the outbound Participant
               def outbound_participant_sid
                 @properties['outbound_participant_sid']
               end
 
               ##
-              # @return [String] Outbound Resource Sid.
+              # @return [String] The SID of the outbound resource
               def outbound_resource_sid
                 @properties['outbound_resource_sid']
               end
 
               ##
-              # @return [interaction.ResourceStatus] The Outbound Resource Status of this Interaction
+              # @return [interaction.ResourceStatus] The outbound resource status of the Interaction
               def outbound_resource_status
                 @properties['outbound_resource_status']
               end
 
               ##
-              # @return [String] The type of the Outbound Resource, Call or Message.
+              # @return [String] The outbound resource type
               def outbound_resource_type
                 @properties['outbound_resource_type']
               end
 
               ##
-              # @return [String] The URL of the Twilio outbound resource.
+              # @return [String] The URL of the Twilio outbound resource
               def outbound_resource_url
                 @properties['outbound_resource_url']
               end
 
               ##
-              # @return [Time] The date this Interaction was created
+              # @return [Time] The ISO 8601 date and time in GMT when the Interaction was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this Interaction was last updated
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The URL of this resource.
+              # @return [String] The absolute URL of the Interaction resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a InteractionInstance
+              # Fetch the InteractionInstance
               # @return [InteractionInstance] Fetched InteractionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the InteractionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the InteractionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -18,10 +18,10 @@ module Twilio
               ##
               # Initialize the ParticipantList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the parent
-              #   [Service](https://www.twilio.com/docs/proxy/api/service).
-              # @param [String] session_sid The unique SID identifier of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session).
+              # @param [String] service_sid The SID of the resource's parent
+              #   {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.
               # @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,28 +112,38 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of ParticipantInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] identifier The phone number of this Participant.
-              # @param [String] friendly_name A human-readable description of this resource, up
-              #   to 64 characters. Should not include PII.
-              # @param [String] proxy_identifier The proxy phone number to use for this
+              # 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
+              #   have PII.**
+              # @param [String] proxy_identifier The proxy phone number to use for the
               #   Participant. If not specified, Proxy will select a number from the pool.
-              # @param [String] proxy_identifier_sid The proxy_identifier_sid
-              # @return [ParticipantInstance] Newly created ParticipantInstance
-              def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
+              # @param [String] proxy_identifier_sid The SID of the Proxy Identifier to assign
+              #   to the Participant.
+              # @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,
@@ -194,12 +202,14 @@ module Twilio
               ##
               # Initialize the ParticipantContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the parent
-              #   [Service](https://www.twilio.com/docs/proxy/api/service).
-              # @param [String] session_sid The unique SID identifier of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session).
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   Participant.
+              # @param [String] service_sid The SID of the parent
+              #   {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
+              #   fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Participant resource to fetch.
               # @return [ParticipantContext] ParticipantContext
               def initialize(version, service_sid, session_sid, sid)
                 super(version)
@@ -213,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,
@@ -234,10 +238,10 @@ module Twilio
               end
 
               ##
-              # Deletes the ParticipantInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the ParticipantInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -275,6 +279,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Proxy.V1.ParticipantContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Proxy.V1.ParticipantContext #{context}>"
+              end
             end
 
             ##
@@ -284,12 +295,12 @@ module Twilio
               # Initialize the ParticipantInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The unique SID identifier of the parent
-              #   [Service](https://www.twilio.com/docs/proxy/api/service).
-              # @param [String] session_sid The unique SID identifier of the parent
-              #   [Session](https://www.twilio.com/docs/proxy/api/session).
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   Participant.
+              # @param [String] service_sid The SID of the resource's parent
+              #   {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.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Participant resource to fetch.
               # @return [ParticipantInstance] ParticipantInstance
               def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
                 super(version)
@@ -337,93 +348,93 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this Participant.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] Session Sid.
+              # @return [String] The SID of the resource's parent Session
               def session_sid
                 @properties['session_sid']
               end
 
               ##
-              # @return [String] Service Sid.
+              # @return [String] The SID of the resource's parent Service
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] Account Sid.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] A human-readable description of this resource.
+              # @return [String] The string that you assigned to describe the participant
               def friendly_name
                 @properties['friendly_name']
               end
 
               ##
-              # @return [String] The phone number of this Participant.
+              # @return [String] The phone number of the Participant
               def identifier
                 @properties['identifier']
               end
 
               ##
-              # @return [String] Proxy Identifier.
+              # @return [String] The phone number or short code of the participant's partner
               def proxy_identifier
                 @properties['proxy_identifier']
               end
 
               ##
-              # @return [String] Proxy Identifier Sid.
+              # @return [String] The SID of the Proxy Identifier assigned to the Participant
               def proxy_identifier_sid
                 @properties['proxy_identifier_sid']
               end
 
               ##
-              # @return [Time] The date this Participant was removed
+              # @return [Time] The ISO 8601 date the Participant was removed
               def date_deleted
                 @properties['date_deleted']
               end
 
               ##
-              # @return [Time] The date this Participant was created
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this Participant was last updated
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The URL of this resource.
+              # @return [String] The absolute URL of the Participant resource
               def url
                 @properties['url']
               end
 
               ##
-              # @return [String] Nested resource URLs.
+              # @return [String] The URLs to resources related the participant
               def links
                 @properties['links']
               end
 
               ##
-              # Fetch a ParticipantInstance
+              # Fetch the ParticipantInstance
               # @return [ParticipantInstance] Fetched ParticipantInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the ParticipantInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the ParticipantInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end