twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/rest/api/v2010/account/key.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -53,7 +55,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(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
@@ -65,7 +67,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],
@@ -132,7 +134,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [KeyInstance] KeyInstance
             def get_instance(payload)
-              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -146,14 +148,17 @@ module Twilio
             ##
             # Initialize the KeyContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The sid
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created the Key
+            #   resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Key
+            #   resource to fetch.
             # @return [KeyContext] KeyContext
             def initialize(version, account_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {account_sid: account_sid, sid: sid}
+              @solution = {account_sid: account_sid, sid: sid, }
               @uri = "/Accounts/#{@solution[:account_sid]}/Keys/#{@solution[:sid]}.json"
             end
 
@@ -169,15 +174,16 @@ module Twilio
                   params,
               )
 
-              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the KeyInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [KeyInstance] Updated KeyInstance
             def update(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
               payload = @version.update(
                   'POST',
@@ -185,12 +191,12 @@ module Twilio
                   data: data,
               )
 
-              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the KeyInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -201,6 +207,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.KeyContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.KeyContext #{context}>"
+            end
           end
 
           class KeyInstance < InstanceResource
@@ -210,7 +223,8 @@ module Twilio
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] account_sid A 34 character string that uniquely identifies this
             #   resource.
-            # @param [String] sid The sid
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Key
+            #   resource to fetch.
             # @return [KeyInstance] KeyInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -225,7 +239,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -234,31 +248,31 @@ module Twilio
             # @return [KeyContext] KeyContext for this KeyInstance
             def context
               unless @instance_context
-                @instance_context = KeyContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = KeyContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
             def date_updated
               @properties['date_updated']
             end
@@ -272,15 +286,16 @@ module Twilio
 
             ##
             # Update the KeyInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [KeyInstance] Updated KeyInstance
             def update(friendly_name: :unset)
-              context.update(friendly_name: friendly_name)
+              context.update(friendly_name: friendly_name, )
             end
 
             ##
             # Deletes the KeyInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,11 @@ module Twilio
               ##
               # Initialize the FeedbackList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] message_sid The message_sid
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   MessageFeedback resource.
+              # @param [String] message_sid The SID of the Message resource for which the
+              #   feedback was provided.
               # @return [FeedbackList] FeedbackList
               def initialize(version, account_sid: nil, message_sid: nil)
                 super(version)
@@ -28,10 +33,12 @@ module Twilio
               ##
               # Retrieve a single page of FeedbackInstance records from the API.
               # Request is executed immediately.
-              # @param [feedback.Outcome] outcome The outcome
+              # @param [feedback.Outcome] outcome Whether the feedback has arrived. Can be:
+              #   `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP
+              #   POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`.
               # @return [FeedbackInstance] Newly created FeedbackInstance
               def create(outcome: :unset)
-                data = Twilio::Values.of({'Outcome' => outcome})
+                data = Twilio::Values.of({'Outcome' => outcome, })
 
                 payload = @version.create(
                     'POST',
@@ -93,8 +100,11 @@ module Twilio
               # Initialize the FeedbackInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The account_sid
-              # @param [String] message_sid The message_sid
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   MessageFeedback resource.
+              # @param [String] message_sid The SID of the Message resource for which the
+              #   feedback was provided.
               # @return [FeedbackInstance] FeedbackInstance
               def initialize(version, payload, account_sid: nil, message_sid: nil)
                 super(version)
@@ -111,37 +121,37 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The message_sid
+              # @return [String] The SID of the Message resource for which the feedback was provided
               def message_sid
                 @properties['message_sid']
               end
 
               ##
-              # @return [feedback.Outcome] The outcome
+              # @return [feedback.Outcome] Whether the feedback has arrived
               def outcome
                 @properties['outcome']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The uri
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end

data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,10 +16,11 @@ module Twilio
               ##
               # Initialize the MediaList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the Account responsible for this
-              #   media.
-              # @param [String] message_sid A 34 character string that uniquely identifies this
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Media
               #   resource.
+              # @param [String] message_sid The unique string that that we created to identify
+              #   the Message resource.
               # @return [MediaList] MediaList
               def initialize(version, account_sid: nil, message_sid: nil)
                 super(version)
@@ -31,9 +34,9 @@ module Twilio
               # Lists MediaInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [Time] date_created_before Filter by date created
-              # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after Filter by date created
+              # @param [Time] date_created_before Only include media that was created on this date
+              # @param [Time] date_created Only include media that was created on this date
+              # @param [Time] date_created_after Only include media that was created on this date
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -55,9 +58,9 @@ module Twilio
               # Streams MediaInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Time] date_created_before Filter by date created
-              # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after Filter by date created
+              # @param [Time] date_created_before Only include media that was created on this date
+              # @param [Time] date_created Only include media that was created on this date
+              # @param [Time] date_created_after Only include media that was created on this date
               # @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
@@ -85,7 +88,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],
@@ -95,9 +98,9 @@ module Twilio
               ##
               # Retrieve a single page of MediaInstance records from the API.
               # Request is executed immediately.
-              # @param [Time] date_created_before Filter by date created
-              # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after Filter by date created
+              # @param [Time] date_created_before Only include media that was created on this date
+              # @param [Time] date_created Only include media that was created on this date
+              # @param [Time] date_created_after Only include media that was created on this date
               # @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
@@ -177,21 +180,25 @@ module Twilio
               ##
               # Initialize the MediaContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] message_sid The message_sid
-              # @param [String] sid The media Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the Media
+              #   resource(s) to fetch.
+              # @param [String] message_sid The SID of the Message resource that this Media
+              #   resource belongs to.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Media resource to fetch
               # @return [MediaContext] MediaContext
               def initialize(version, account_sid, message_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, message_sid: message_sid, sid: sid}
+                @solution = {account_sid: account_sid, message_sid: message_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Messages/#{@solution[:message_sid]}/Media/#{@solution[:sid]}.json"
               end
 
               ##
               # Deletes the MediaInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -223,6 +230,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.MediaContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.MediaContext #{context}>"
+              end
             end
 
             class MediaInstance < InstanceResource
@@ -230,11 +244,13 @@ module Twilio
               # Initialize the MediaInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The unique id of the Account responsible for this
-              #   media.
-              # @param [String] message_sid A 34 character string that uniquely identifies this
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Media
               #   resource.
-              # @param [String] sid The media Sid that uniquely identifies this resource
+              # @param [String] message_sid The unique string that that we created to identify
+              #   the Message resource.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Media resource to fetch
               # @return [MediaInstance] MediaInstance
               def initialize(version, payload, account_sid: nil, message_sid: nil, sid: nil)
                 super(version)
@@ -276,7 +292,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique sid that identifies this account
+              # @return [String] The SID of the Account that created this resource
               def account_sid
                 @properties['account_sid']
               end
@@ -288,38 +304,38 @@ module Twilio
               end
 
               ##
-              # @return [Time] The date this resource was created
+              # @return [Time] The RFC 2822 date and time in GMT that this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this resource was last updated
+              # @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The unique id of the resource that created the media.
+              # @return [String] The SID of the resource that created the media
               def parent_sid
                 @properties['parent_sid']
               end
 
               ##
-              # @return [String] A string that uniquely identifies this media
+              # @return [String] The unique string that identifies this resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The URI for this resource
+              # @return [String] The URI of this resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
               # Deletes the MediaInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end