twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -16,8 +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 Service.
-              # @param [String] session_sid The unique SID identifier of the 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)
@@ -31,7 +35,6 @@ module Twilio
               # Lists ParticipantInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] identifier The identifier
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -39,15 +42,14 @@ module Twilio
               #    but a limit is defined, stream() will attempt to read the limit with the most
               #    efficient page size, i.e. min(limit, 1000)
               # @return [Array] Array of up to limit results
-              def list(identifier: :unset, limit: nil, page_size: nil)
-                self.stream(identifier: identifier, limit: limit, page_size: page_size).entries
+              def list(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
               end
 
               ##
               # Streams ParticipantInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] identifier The identifier
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -55,10 +57,10 @@ module Twilio
               #    but a limit is defined, stream() will attempt to read the limit with the most
               #    efficient page size, i.e. min(limit, 1000)
               # @return [Enumerable] Enumerable that will yield up to limit results
-              def stream(identifier: :unset, limit: nil, page_size: nil)
+              def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(identifier: identifier, page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -70,7 +72,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -80,23 +82,19 @@ module Twilio
               ##
               # Retrieve a single page of ParticipantInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identifier The identifier
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
               # @return [Page] Page of ParticipantInstance
-              def page(identifier: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
-                    'Identifier' => identifier,
                     'PageToken' => page_token,
                     '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.
-              # @param [String] proxy_identifier The proxy phone number for this Participant.
-              # @param [String] proxy_identifier_sid The unique SID identifier of the Proxy
-              #   Identifier.
-              # @return [ParticipantInstance] Newly created ParticipantInstance
-              def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
+              # 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 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,16 +202,20 @@ module Twilio
               ##
               # Initialize the ParticipantContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Service.
-              # @param [String] session_sid The unique SID identifier of the 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)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, session_sid: session_sid, sid: sid}
+                @solution = {service_sid: service_sid, session_sid: session_sid, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:sid]}"
 
                 # Dependents
@@ -211,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,
@@ -232,42 +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)
-              end
-
-              ##
-              # Update the ParticipantInstance
-              # @param [String] identifier The phone number of this Participant.
-              # @param [String] friendly_name A human readable description of this resource, up
-              #   to 64 characters.
-              # @param [String] proxy_identifier The proxy phone number for this Participant.
-              # @param [String] proxy_identifier_sid The unique SID identifier of the Proxy
-              #   Identifier.
-              # @return [ParticipantInstance] Updated ParticipantInstance
-              def update(identifier: :unset, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
-                data = Twilio::Values.of({
-                    'Identifier' => identifier,
-                    'FriendlyName' => friendly_name,
-                    'ProxyIdentifier' => proxy_identifier,
-                    'ProxyIdentifierSid' => proxy_identifier_sid,
-                })
-
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
-
-                ParticipantInstance.new(
-                    @version,
-                    payload,
-                    service_sid: @solution[:service_sid],
-                    session_sid: @solution[:session_sid],
-                    sid: @solution[:sid],
-                )
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -305,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
 
             ##
@@ -314,10 +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 Service.
-              # @param [String] session_sid The unique SID identifier of the 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)
@@ -365,115 +348,97 @@ 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 or channel identifier of the Participant
               def identifier
                 @properties['identifier']
               end
 
               ##
-              # @return [String] The 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 deleted
+              # @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 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
 
-              ##
-              # Update the ParticipantInstance
-              # @param [String] identifier The phone number of this Participant.
-              # @param [String] friendly_name A human readable description of this resource, up
-              #   to 64 characters.
-              # @param [String] proxy_identifier The proxy phone number for this Participant.
-              # @param [String] proxy_identifier_sid The unique SID identifier of the Proxy
-              #   Identifier.
-              # @return [ParticipantInstance] Updated ParticipantInstance
-              def update(identifier: :unset, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
-                context.update(
-                    identifier: identifier,
-                    friendly_name: friendly_name,
-                    proxy_identifier: proxy_identifier,
-                    proxy_identifier_sid: proxy_identifier_sid,
-                )
-              end
-
               ##
               # Access the message_interactions
               # @return [message_interactions] message_interactions