twilio-ruby 5.19.0 → 5.74.2

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,15 +112,16 @@ 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
+              # @param [String] proxy_identifier_sid The SID of the Proxy Identifier to assign
+              #   to the Participant.
+              # @return [ParticipantInstance] Created ParticipantInstance
               def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
                 data = Twilio::Values.of({
                     'Identifier' => identifier,
@@ -131,11 +130,7 @@ module Twilio
                     'ProxyIdentifierSid' => proxy_identifier_sid,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 ParticipantInstance.new(
                     @version,
@@ -194,12 +189,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 +210,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 +225,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 +266,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 +282,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 +335,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 or channel identifier 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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,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)
@@ -88,11 +90,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               SessionPage.new(@version, response, @solution)
             end
 
@@ -110,22 +110,24 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of SessionInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] unique_name Your unique identifier for this Session such as a
-            #   Job ID or conversation ID. *Should not contain PII.*
-            # @param [Time] date_expiry An absolute time (ISO 8601) at which this Session
-            #   should close. If this is populated, it takes precedence over TTL values.
-            # @param [String] ttl The time, in seconds, after the latest of Session create
-            #   time or the Session's last Interaction time at which the session will expire.
-            # @param [session.Mode] mode The type of communications mediums allowed on a
-            #   Session. Defaults to `voice-and-message`. Other options are `voice-only` or
-            #   `message-only`.
-            # @param [session.Status] status Set this value to `closed` to close the session.
-            #   A Session can be re-opened by posting to a closed session with the value
-            #   `in-progress`.  This will be `open` by default on create.
-            # @param [Hash] participants The participants
-            # @return [SessionInstance] Newly created SessionInstance
+            # 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.
+            # @return [SessionInstance] Created SessionInstance
             def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
@@ -136,11 +138,7 @@ module Twilio
                   'Participants' => Twilio.serialize_list(participants) { |e| Twilio.serialize_object(e) },
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -189,9 +187,11 @@ module Twilio
             ##
             # Initialize the SessionContext
             # @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] 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)
@@ -206,52 +206,39 @@ module Twilio
             end
 
             ##
-            # Fetch a SessionInstance
+            # Fetch the SessionInstance
             # @return [SessionInstance] Fetched SessionInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the SessionInstance
-            # @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 [Time] date_expiry The date that this Session should expire, given in ISO
-            #   8601 format.
-            # @param [String] ttl The time, in seconds, after the latest of Session create
-            #   time or the Session's last Interaction time at which the session will expire.
-            # @param [session.Mode] mode The mode
-            # @param [session.Status] status The Status of this Session. Set to `in-progress`
-            #   to re-open a session or `closed` to close a session.
-            # @param [Hash] participants The participants
+            # @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.
             # @return [SessionInstance] Updated SessionInstance
-            def update(date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
+            def update(date_expiry: :unset, ttl: :unset, status: :unset)
               data = Twilio::Values.of({
                   'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
                   'Ttl' => ttl,
-                  'Mode' => mode,
                   'Status' => status,
-                  'Participants' => Twilio.serialize_list(participants) { |e| Twilio.serialize_object(e) },
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -306,6 +293,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
 
           ##
@@ -315,8 +309,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)
@@ -333,7 +330,7 @@ module Twilio
                   'unique_name' => payload['unique_name'],
                   'status' => payload['status'],
                   'closed_reason' => payload['closed_reason'],
-                  'ttl' => payload['ttl'].to_i,
+                  'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
                   'mode' => payload['mode'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
@@ -358,134 +355,127 @@ module Twilio
             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 last had an 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 should expire
+            # @return [Time] The ISO 8601 date when the Session should expire
             def date_expiry
               @properties['date_expiry']
             end
 
             ##
-            # @return [String] A unique, developer assigned identifier for 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 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 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 [Time] date_expiry The date that this Session should expire, given in ISO
-            #   8601 format.
-            # @param [String] ttl The time, in seconds, after the latest of Session create
-            #   time or the Session's last Interaction time at which the session will expire.
-            # @param [session.Mode] mode The mode
-            # @param [session.Status] status The Status of this Session. Set to `in-progress`
-            #   to re-open a session or `closed` to close a session.
-            # @param [Hash] participants The participants
+            # @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.
             # @return [SessionInstance] Updated SessionInstance
-            def update(date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
-              context.update(
-                  date_expiry: date_expiry,
-                  ttl: ttl,
-                  mode: mode,
-                  status: status,
-                  participants: participants,
-              )
+            def update(date_expiry: :unset, ttl: :unset, status: :unset)
+              context.update(date_expiry: date_expiry, ttl: ttl, status: status, )
             end
 
             ##