twilio-ruby 5.8.1 → 5.9.0

data/lib/twilio-ruby/rest/preview/wireless.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/preview.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -141,8 +143,9 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this Add-on
-      #   installation.
+      # @param [String] sid 34 character string that uniquely identifies the Add-on.
+      #   This Sid can also be found in the Console on that specific Add-ons page as the
+      #   'Available Add-on Sid'.
       # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnInstance] if sid was passed.
       # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
       def installed_add_ons(sid=:unset)

data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing/v1/messaging.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing/v1/phone_number.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing/v1/voice.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing/v1.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/pricing.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -280,7 +282,7 @@ module Twilio
             end
 
             ##
-            # @return [Time] The date this Phone Number was created
+            # @return [Time] The date this Phone Number was added to the service
             def date_created
               @properties['date_created']
             end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -31,16 +33,10 @@ module Twilio
               # Lists InteractionInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
-              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
+              # @param [interaction.ResourceStatus] inbound_participant_status The
+              #   inbound_participant_status
+              # @param [interaction.ResourceStatus] outbound_participant_status The
+              #   outbound_participant_status
               # @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,16 +57,10 @@ module Twilio
               # Streams InteractionInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
-              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
+              # @param [interaction.ResourceStatus] inbound_participant_status The
+              #   inbound_participant_status
+              # @param [interaction.ResourceStatus] outbound_participant_status The
+              #   outbound_participant_status
               # @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
@@ -107,16 +97,10 @@ module Twilio
               ##
               # Retrieve a single page of InteractionInstance records from the API.
               # Request is executed immediately.
-              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
-              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
+              # @param [interaction.ResourceStatus] inbound_participant_status The
+              #   inbound_participant_status
+              # @param [interaction.ResourceStatus] outbound_participant_status The
+              #   outbound_participant_status
               # @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
@@ -372,7 +356,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The URL of the Twilio resource.
+              # @return [String] The URL of the Twilio inbound resource.
               def inbound_resource_url
                 @properties['inbound_resource_url']
               end
@@ -402,7 +386,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The URL of the Twilio resource.
+              # @return [String] The URL of the Twilio outbound resource.
               def outbound_resource_url
                 @properties['outbound_resource_url']
               end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -32,7 +34,7 @@ module Twilio
                 ##
                 # Retrieve a single page of MessageInteractionInstance records from the API.
                 # Request is executed immediately.
-                # @param [String] body The body
+                # @param [String] body The message to send to the participant
                 # @param [String] media_url The media_url
                 # @return [MessageInteractionInstance] Newly created MessageInteractionInstance
                 def create(body: :unset, media_url: :unset)
@@ -185,11 +187,10 @@ module Twilio
                 ##
                 # Initialize the MessageInteractionContext
                 # @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] participant_sid The unique SID identifier of the Participant.
-                # @param [String] sid A 34 character string that uniquely identifies this Message
-                #   Interaction.
+                # @param [String] service_sid The service_sid
+                # @param [String] session_sid The session_sid
+                # @param [String] participant_sid The participant_sid
+                # @param [String] sid The sid
                 # @return [MessageInteractionContext] MessageInteractionContext
                 def initialize(version, service_sid, session_sid, participant_sid, sid)
                   super(version)
@@ -244,8 +245,7 @@ module 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] participant_sid The unique SID identifier of the Participant.
-                # @param [String] sid A 34 character string that uniquely identifies this Message
-                #   Interaction.
+                # @param [String] sid The sid
                 # @return [MessageInteractionInstance] MessageInteractionInstance
                 def initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil)
                   super(version)
@@ -326,7 +326,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] Further details about an interaction.
+                # @return [String] Message body
                 def data
                   @properties['data']
                 end
@@ -350,7 +350,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] Inbound Resource Sid.
+                # @return [String] Inbound message resource Sid.
                 def inbound_resource_sid
                   @properties['inbound_resource_sid']
                 end
@@ -362,13 +362,13 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The type of the Inbound Resource, Call or Message.
+                # @return [String] Message
                 def inbound_resource_type
                   @properties['inbound_resource_type']
                 end
 
                 ##
-                # @return [String] The URL of the Twilio resource.
+                # @return [String] The URL of the Twilio message resource.
                 def inbound_resource_url
                   @properties['inbound_resource_url']
                 end
@@ -380,7 +380,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] Outbound Resource Sid.
+                # @return [String] Outbound message resource Sid.
                 def outbound_resource_sid
                   @properties['outbound_resource_sid']
                 end
@@ -392,13 +392,13 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The type of the Outbound Resource, Call or Message.
+                # @return [String] Message
                 def outbound_resource_type
                   @properties['outbound_resource_type']
                 end
 
                 ##
-                # @return [String] The URL of the Twilio resource.
+                # @return [String] The URL of the Twilio message resource.
                 def outbound_resource_url
                   @properties['outbound_resource_url']
                 end

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
@@ -118,10 +120,10 @@ module Twilio
               # 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.
+              #   to 64 characters. Should not include PII.
+              # @param [String] proxy_identifier The proxy phone number to use for this
+              #   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)
                 data = Twilio::Values.of({
@@ -240,12 +242,10 @@ module Twilio
 
               ##
               # 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.
+              # @param [String] identifier The identifier
+              # @param [String] friendly_name The friendly_name
+              # @param [String] proxy_identifier The proxy_identifier
+              # @param [String] proxy_identifier_sid The proxy_identifier_sid
               # @return [ParticipantInstance] Updated ParticipantInstance
               def update(identifier: :unset, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
                 data = Twilio::Values.of({
@@ -401,7 +401,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The proxy_identifier
+              # @return [String] Proxy Identifier.
               def proxy_identifier
                 @properties['proxy_identifier']
               end
@@ -458,12 +458,10 @@ module Twilio
 
               ##
               # 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.
+              # @param [String] identifier The identifier
+              # @param [String] friendly_name The friendly_name
+              # @param [String] proxy_identifier The proxy_identifier
+              # @param [String] proxy_identifier_sid The proxy_identifier_sid
               # @return [ParticipantInstance] Updated ParticipantInstance
               def update(identifier: :unset, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
                 context.update(

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
@@ -29,9 +31,7 @@ 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 [String] unique_name The unique_name
             # @param [session.Status] status The Status of this Session. One of `in-progress`,
             #   `closed`, `failed`, `unknown` or `completed`.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -49,9 +49,7 @@ module Twilio
             # 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 [String] unique_name The unique_name
             # @param [session.Status] status The Status of this Session. One of `in-progress`,
             #   `closed`, `failed`, `unknown` or `completed`.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -86,9 +84,7 @@ 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 [String] unique_name The unique_name
             # @param [session.Status] status The Status of this Session. One of `in-progress`,
             #   `closed`, `failed`, `unknown` or `completed`.
             # @param [String] page_token PageToken provided by the API
@@ -127,17 +123,20 @@ 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 [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-progress`,
-            #   `closed`, `failed`, `unknown` or `completed`.
-            # @param [Hash] participants A list of phone numbers to add to this Session.
+            # @param [String] unique_name Your identifier for this Session such as a Job ID or
+            #   conversation ID.
+            # @param [Time] date_expiry An absolute time at which this Session should close.
+            #   If this is populated, it takes precedence over TTL values.
+            # @param [String] ttl The Time To Live for this Session. The amount of time,
+            #   specified in seconds, that this Session should live for before closing. Keys off
+            #   the last interaction or session creation time.
+            # @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
             def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
               data = Twilio::Values.of({
@@ -241,17 +240,15 @@ module Twilio
 
             ##
             # 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-progress`,
-            #   `closed`, `failed`, `unknown` or `completed`.
-            # @param [Hash] participants A list of phone numbers to add to this Session.
+            # @param [String] unique_name The unique_name
+            # @param [Time] date_expiry The date that this Session should be expired, given in
+            #   ISO 8601 format.
+            # @param [String] ttl The time delay, in seconds, after which a session will be
+            #   expired.  Keyed off of last interaction time.
+            # @param [session.Mode] mode The mode
+            # @param [session.Status] status The Status of this Session. Set `in-progress` to
+            #   re-open a session, `closed` to close a session.
+            # @param [Hash] participants The participants
             # @return [SessionInstance] Updated SessionInstance
             def update(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
               data = Twilio::Values.of({
@@ -485,17 +482,15 @@ module Twilio
 
             ##
             # 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-progress`,
-            #   `closed`, `failed`, `unknown` or `completed`.
-            # @param [Hash] participants A list of phone numbers to add to this Session.
+            # @param [String] unique_name The unique_name
+            # @param [Time] date_expiry The date that this Session should be expired, given in
+            #   ISO 8601 format.
+            # @param [String] ttl The time delay, in seconds, after which a session will be
+            #   expired.  Keyed off of last interaction time.
+            # @param [session.Mode] mode The mode
+            # @param [session.Status] status The Status of this Session. Set `in-progress` to
+            #   re-open a session, `closed` to close a session.
+            # @param [Hash] participants The participants
             # @return [SessionInstance] Updated SessionInstance
             def update(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
               context.update(