twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,9 @@ module Twilio
             ##
             # Initialize the SessionList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] the session is
+            #   associated with.
             # @return [SessionList] SessionList
             def initialize(version, service_sid: nil)
               super(version)
@@ -29,11 +33,6 @@ module Twilio
             # Lists SessionInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] unique_name Provides a unique and addressable name to be
-            #   assigned to this Session, assigned by the developer, to be optionally used in
-            #   addition to SID.
-            # @param [session.Status] status The Status of this Session. One of `in-progess`,
-            #   `closed`, `failed`, `unknown` or `completed`.
             # @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
@@ -41,19 +40,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(unique_name: :unset, status: :unset, limit: nil, page_size: nil)
-              self.stream(unique_name: unique_name, status: status, 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 SessionInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] unique_name Provides a unique and addressable name to be
-            #   assigned to this Session, assigned by the developer, to be optionally used in
-            #   addition to SID.
-            # @param [session.Status] status The Status of this Session. One of `in-progess`,
-            #   `closed`, `failed`, `unknown` or `completed`.
             # @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
@@ -61,10 +55,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(unique_name: :unset, status: :unset, limit: nil, page_size: nil)
+            def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(unique_name: unique_name, status: status, 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
@@ -76,7 +70,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],
@@ -86,28 +80,19 @@ module Twilio
             ##
             # Retrieve a single page of SessionInstance records from the API.
             # Request is executed immediately.
-            # @param [String] unique_name Provides a unique and addressable name to be
-            #   assigned to this Session, assigned by the developer, to be optionally used in
-            #   addition to SID.
-            # @param [session.Status] status The Status of this Session. One of `in-progess`,
-            #   `closed`, `failed`, `unknown` or `completed`.
             # @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 SessionInstance
-            def page(unique_name: :unset, status: :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({
-                  'UniqueName' => unique_name,
-                  'Status' => status,
                   'PageToken' => page_token,
                   '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
 
@@ -125,21 +110,37 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of SessionInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] unique_name Provides a unique and addressable name to be
-            #   assigned to this Session, assigned by the developer, to be optionally used in
-            #   addition to SID.
-            # @param [Time] date_expiry The date that this Session was expiry, given in ISO
-            #   8601 format.
-            # @param [String] ttl The Time to Live for a Session, in seconds.
-            # @param [session.Mode] mode The Mode of this Session. One of `message-only`,
-            #   `voice-only` or `voice-and-message`.
-            # @param [session.Status] status The Status of this Session. One of `in-progess`,
-            #   `closed`, `failed`, `unknown` or `completed`.
-            # @param [Hash] participants A list of phone numbers to add to this Session.
-            # @return [SessionInstance] Newly created SessionInstance
-            def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
+            # 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]
+            #   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.Mode] mode The Mode of the Session. Can be: `message-only`,
+            #   `voice-only`, or `voice-and-message` and the default value is
+            #   `voice-and-message`.
+            # @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 [Array[Hash]] participants The Participant objects to include in the new
+            #   session.
+            # @param [Boolean] fail_on_participant_conflict [Experimental] For accounts with
+            #   the ProxyAllowParticipantConflict account flag, setting to true enables
+            #   per-request opt-in to allowing Proxy to reject a Session create (with
+            #   Participants) request that could cause the same Identifier/ProxyIdentifier pair
+            #   to be active in multiple Sessions. Depending on the context, this could be a 409
+            #   error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not
+            #   provided, requests will be allowed to succeed and a Debugger notification
+            #   (80802) will be emitted. Having multiple, active Participants with the same
+            #   Identifier/ProxyIdentifier pair causes calls and messages from affected
+            #   Participants to be routed incorrectly. Please note, the default behavior for
+            #   accounts without the ProxyAllowParticipantConflict flag is to reject the request
+            #   as described.  This will eventually be the default for all accounts.
+            # @return [SessionInstance] Created SessionInstance
+            def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset, fail_on_participant_conflict: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
                   'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
@@ -147,15 +148,12 @@ 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])
+              SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -186,7 +184,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [SessionInstance] SessionInstance
             def get_instance(payload)
-              SessionInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -202,14 +200,17 @@ module Twilio
             ##
             # Initialize the SessionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service.
-            # @param [String] sid A 34 character string that uniquely identifies this Session.
+            # @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] sid The Twilio-provided string that uniquely identifies the
+            #   Session resource to fetch.
             # @return [SessionContext] SessionContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:sid]}"
 
               # Dependents
@@ -218,58 +219,53 @@ 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])
+              SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the SessionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # 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 [String] unique_name Provides a unique and addressable name to be
-            #   assigned to this Session, assigned by the developer, to be optionally used in
-            #   addition to SID.
-            # @param [Time] date_expiry The date that this Session was expiry, given in ISO
-            #   8601 format.
-            # @param [String] ttl The Time to Live for a Session, in seconds.
-            # @param [session.Mode] mode The Mode of this Session. One of `message-only`,
-            #   `voice-only` or `voice-and-message`.
-            # @param [session.Status] status The Status of this Session. One of `in-progess`,
-            #   `closed`, `failed`, `unknown` or `completed`.
-            # @param [Hash] participants A list of phone numbers to add to this Session.
+            # @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(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
+            def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
               data = Twilio::Values.of({
-                  'UniqueName' => unique_name,
                   'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
                   'Ttl' => ttl,
-                  'Mode' => mode,
                   'Status' => status,
-                  'Participants' => Twilio.serialize_list(participants) { |e| Twilio.serialize_object(e) },
+                  '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])
+              SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -280,7 +276,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return InteractionContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return InteractionContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @interactions
@@ -302,7 +298,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return ParticipantContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return ParticipantContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @participants
@@ -322,6 +318,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Proxy.V1.SessionContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Proxy.V1.SessionContext #{context}>"
+            end
           end
 
           ##
@@ -331,8 +334,11 @@ module Twilio
             # Initialize the SessionInstance
             # @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] sid A 34 character string that uniquely identifies this Session.
+            # @param [String] service_sid The SID of the
+            #   {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.
             # @return [SessionInstance] SessionInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -359,7 +365,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -368,143 +374,148 @@ module Twilio
             # @return [SessionContext] SessionContext for this SessionInstance
             def context
               unless @instance_context
-                @instance_context = SessionContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = SessionContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Session.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['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 [Time] The date this Session was started
+            # @return [Time] The ISO 8601 date when the Session started
             def date_started
               @properties['date_started']
             end
 
             ##
-            # @return [Time] The date this Session was ended
+            # @return [Time] The ISO 8601 date when the Session ended
             def date_ended
               @properties['date_ended']
             end
 
             ##
-            # @return [Time] The date this Session was interaction
+            # @return [Time] The ISO 8601 date when the Session last had an interaction
             def date_last_interaction
               @properties['date_last_interaction']
             end
 
             ##
-            # @return [Time] The date this Session was expiry
+            # @return [Time] The ISO 8601 date when the Session should expire
             def date_expiry
               @properties['date_expiry']
             end
 
             ##
-            # @return [String] A unique, developer assigned name of this Session.
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [session.Status] The Status of this Session
+            # @return [session.Status] The status of the Session
             def status
               @properties['status']
             end
 
             ##
-            # @return [String] Reason Session ended.
+            # @return [String] The reason the Session ended
             def closed_reason
               @properties['closed_reason']
             end
 
             ##
-            # @return [String] TTL for a Session, in seconds.
+            # @return [String] When the session will expire
             def ttl
               @properties['ttl']
             end
 
             ##
-            # @return [session.Mode] The Mode of this Session
+            # @return [session.Mode] The Mode of the Session
             def mode
               @properties['mode']
             end
 
             ##
-            # @return [Time] The date this Session 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 Session 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 Session resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Nested resource URLs.
+            # @return [String] The URLs of resources related to the Session
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a SessionInstance
+            # Fetch the SessionInstance
             # @return [SessionInstance] Fetched SessionInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the SessionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the SessionInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the SessionInstance
-            # @param [String] unique_name Provides a unique and addressable name to be
-            #   assigned to this Session, assigned by the developer, to be optionally used in
-            #   addition to SID.
-            # @param [Time] date_expiry The date that this Session was expiry, given in ISO
-            #   8601 format.
-            # @param [String] ttl The Time to Live for a Session, in seconds.
-            # @param [session.Mode] mode The Mode of this Session. One of `message-only`,
-            #   `voice-only` or `voice-and-message`.
-            # @param [session.Status] status The Status of this Session. One of `in-progess`,
-            #   `closed`, `failed`, `unknown` or `completed`.
-            # @param [Hash] participants A list of phone numbers to add to this Session.
+            # @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(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
+            def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
               context.update(
-                  unique_name: unique_name,
                   date_expiry: date_expiry,
                   ttl: ttl,
-                  mode: mode,
                   status: status,
-                  participants: participants,
+                  fail_on_participant_conflict: fail_on_participant_conflict,
               )
             end