twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -19,12 +19,12 @@ module Twilio
                 ##
                 # Initialize the MessageInteractionList
                 # @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] participant_sid The unique SID identifier of the
-                #   [Participant](https://www.twilio.com/docs/proxy/api/participants).
+                # @param [String] service_sid The SID of the parent
+                #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+                # @param [String] session_sid The SID of the parent
+                #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
+                # @param [String] participant_sid The SID of the
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
                 # @return [MessageInteractionList] MessageInteractionList
                 def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
                   super(version)
@@ -35,19 +35,14 @@ module Twilio
                 end
 
                 ##
-                # Retrieve a single page of MessageInteractionInstance records from the API.
-                # Request is executed immediately.
+                # Create the MessageInteractionInstance
                 # @param [String] body The message to send to the participant
-                # @param [String] media_url Not currently supported during beta.
-                # @return [MessageInteractionInstance] Newly created MessageInteractionInstance
+                # @param [Array[String]] media_url Reserved. Not currently supported.
+                # @return [MessageInteractionInstance] Created MessageInteractionInstance
                 def create(body: :unset, media_url: :unset)
                   data = Twilio::Values.of({'Body' => body, 'MediaUrl' => Twilio.serialize_list(media_url) { |e| e }, })
 
-                  payload = @version.create(
-                      'POST',
-                      @uri,
-                      data: data
-                  )
+                  payload = @version.create('POST', @uri, data: data)
 
                   MessageInteractionInstance.new(
                       @version,
@@ -119,11 +114,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   MessageInteractionPage.new(@version, response, @solution)
                 end
 
@@ -190,10 +183,16 @@ module Twilio
                 ##
                 # Initialize the MessageInteractionContext
                 # @param [Version] version Version that contains the resource
-                # @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
+                # @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] participant_sid The SID of the
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   MessageInteraction resource to fetch.
                 # @return [MessageInteractionContext] MessageInteractionContext
                 def initialize(version, service_sid, session_sid, participant_sid, sid)
                   super(version)
@@ -209,16 +208,10 @@ module Twilio
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
+                # Fetch the MessageInteractionInstance
                 # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   MessageInteractionInstance.new(
                       @version,
@@ -236,6 +229,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Proxy.V1.MessageInteractionContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Proxy.V1.MessageInteractionContext #{context}>"
+                end
               end
 
               ##
@@ -245,13 +245,14 @@ module Twilio
                 # Initialize the MessageInteractionInstance
                 # @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] participant_sid The unique SID identifier of the
-                #   [Participant](https://www.twilio.com/docs/proxy/api/participants).
-                # @param [String] sid The sid
+                # @param [String] service_sid The SID of the parent
+                #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+                # @param [String] session_sid The SID of the parent
+                #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
+                # @param [String] participant_sid The SID of the
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   MessageInteraction resource to fetch.
                 # @return [MessageInteractionInstance] MessageInteractionInstance
                 def initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil)
                   super(version)
@@ -308,127 +309,127 @@ module Twilio
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies this Message Interaction.
+                # @return [String] The unique string that identifies the resource
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] Session Sid.
+                # @return [String] The SID of the resource's parent Session
                 def session_sid
                   @properties['session_sid']
                 end
 
                 ##
-                # @return [String] Service Sid.
+                # @return [String] The SID of the resource's parent Service
                 def service_sid
                   @properties['service_sid']
                 end
 
                 ##
-                # @return [String] Account Sid.
+                # @return [String] The SID of the Account that created the resource
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] Message body
+                # @return [String] A JSON string that includes the message body sent to the participant
                 def data
                   @properties['data']
                 end
 
                 ##
-                # @return [message_interaction.Type] The Type of this Message Interaction
+                # @return [message_interaction.Type] The Type of Message Interaction
                 def type
                   @properties['type']
                 end
 
                 ##
-                # @return [String] Participant Sid.
+                # @return [String] The SID of the Participant resource
                 def participant_sid
                   @properties['participant_sid']
                 end
 
                 ##
-                # @return [String] Always empty for Message Interactions.
+                # @return [String] Always empty for Message Interactions
                 def inbound_participant_sid
                   @properties['inbound_participant_sid']
                 end
 
                 ##
-                # @return [String] Always empty for Message Interactions.
+                # @return [String] Always empty for Message Interactions
                 def inbound_resource_sid
                   @properties['inbound_resource_sid']
                 end
 
                 ##
-                # @return [message_interaction.ResourceStatus] Always empty for Message Interactions.
+                # @return [message_interaction.ResourceStatus] Always empty for Message Interactions
                 def inbound_resource_status
                   @properties['inbound_resource_status']
                 end
 
                 ##
-                # @return [String] Always empty for Message Interactions.
+                # @return [String] Always empty for Message Interactions
                 def inbound_resource_type
                   @properties['inbound_resource_type']
                 end
 
                 ##
-                # @return [String] Always empty for Message Interactions.
+                # @return [String] Always empty for Message Interactions
                 def inbound_resource_url
                   @properties['inbound_resource_url']
                 end
 
                 ##
-                # @return [String] Outbound Participant Sid.
+                # @return [String] The SID of the outbound Participant resource
                 def outbound_participant_sid
                   @properties['outbound_participant_sid']
                 end
 
                 ##
-                # @return [String] Outbound message resource Sid.
+                # @return [String] The SID of the outbound Message resource
                 def outbound_resource_sid
                   @properties['outbound_resource_sid']
                 end
 
                 ##
-                # @return [message_interaction.ResourceStatus] The Outbound Resource Status of this Message Interaction
+                # @return [message_interaction.ResourceStatus] The outbound resource status
                 def outbound_resource_status
                   @properties['outbound_resource_status']
                 end
 
                 ##
-                # @return [String] Message
+                # @return [String] The outbound resource type
                 def outbound_resource_type
                   @properties['outbound_resource_type']
                 end
 
                 ##
-                # @return [String] The URL of the Twilio message resource.
+                # @return [String] The URL of the Twilio message resource
                 def outbound_resource_url
                   @properties['outbound_resource_url']
                 end
 
                 ##
-                # @return [Time] The date this Message Interaction 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 Message Interaction was last updated
+                # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
                 def date_updated
                   @properties['date_updated']
                 end
 
                 ##
-                # @return [String] The URL of this resource.
+                # @return [String] The absolute URL of the MessageInteraction resource
                 def url
                   @properties['url']
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
+                # Fetch the MessageInteractionInstance
                 # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
                 def fetch
                   context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,7 +17,8 @@ module Twilio
             ##
             # Initialize the ShortCodeList
             # @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 ShortCode resource's parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,19 +29,15 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] sid A 34 character string that uniquely identifies this Short
-            #   Code.
-            # @return [ShortCodeInstance] Newly created ShortCodeInstance
+            # Create the ShortCodeInstance
+            # @param [String] sid The SID of a Twilio
+            #   {ShortCode}[https://www.twilio.com/docs/sms/api/short-code] resource that
+            #   represents the short code you would like to assign to your Proxy Service.
+            # @return [ShortCodeInstance] Created ShortCodeInstance
             def create(sid: nil)
               data = Twilio::Values.of({'Sid' => sid, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -106,11 +103,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ShortCodePage.new(@version, response, @solution)
             end
 
@@ -171,9 +166,11 @@ module Twilio
             ##
             # Initialize the ShortCodeContext
             # @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 Short
-            #   Code.
+            # @param [String] service_sid The SID of the parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] to fetch the resource
+            #   from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch.
             # @return [ShortCodeContext] ShortCodeContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -184,40 +181,32 @@ module Twilio
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ShortCodeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the ShortCodeInstance
-            # @param [Boolean] is_reserved Whether or not the short code should be excluded
-            #   from being assigned to a participant using proxy pool logic
+            # @param [Boolean] is_reserved Whether the short code should be reserved and not
+            #   be assigned to a participant using proxy pool logic. See {Reserved Phone
+            #   Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
+            #   information.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(is_reserved: :unset)
               data = Twilio::Values.of({'IsReserved' => is_reserved, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -228,6 +217,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Proxy.V1.ShortCodeContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Proxy.V1.ShortCodeContext #{context}>"
+            end
           end
 
           ##
@@ -237,9 +233,10 @@ module Twilio
             # Initialize the ShortCodeInstance
             # @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 Short
-            #   Code.
+            # @param [String] service_sid The SID of the ShortCode resource's parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch.
             # @return [ShortCodeInstance] ShortCodeInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -275,74 +272,74 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Short Code.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['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] Service Sid.
+            # @return [String] The SID of the resource's parent Service
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date this Short Code was added to the service
+            # @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 Short Code 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] Shortcode.
+            # @return [String] The short code's number
             def short_code
               @properties['short_code']
             end
 
             ##
-            # @return [String] ISO Country Code,
+            # @return [String] The ISO Country Code
             def iso_country
               @properties['iso_country']
             end
 
             ##
-            # @return [String] A list of capabilities.
+            # @return [String] The capabilities of the short code
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [String] The URL of this resource.
+            # @return [String] The absolute URL of the ShortCode resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [Boolean] Reserve for manual assignment to participants only.
+            # @return [Boolean] Whether the short code should be reserved for manual assignment to participants only
             def is_reserved
               @properties['is_reserved']
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ShortCodeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
               context.fetch
@@ -350,8 +347,10 @@ module Twilio
 
             ##
             # Update the ShortCodeInstance
-            # @param [Boolean] is_reserved Whether or not the short code should be excluded
-            #   from being assigned to a participant using proxy pool logic
+            # @param [Boolean] is_reserved Whether the short code should be reserved and not
+            #   be assigned to a participant using proxy pool logic. See {Reserved Phone
+            #   Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
+            #   information.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(is_reserved: :unset)
               context.update(is_reserved: is_reserved, )