twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -25,20 +27,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of NewKeyInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @return [NewKeyInstance] Newly created NewKeyInstance
+            # Create the NewKeyInstance
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @return [NewKeyInstance] Created NewKeyInstance
             def create(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -67,7 +65,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [NewKeyInstance] NewKeyInstance
             def get_instance(payload)
-              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -99,31 +97,31 @@ module Twilio
             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
 
             ##
-            # @return [String] The secret
+            # @return [String] The secret your application uses to sign Access Tokens and to authenticate to the REST API.
             def secret
               @properties['secret']
             end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -25,20 +27,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of NewSigningKeyInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @return [NewSigningKeyInstance] Newly created NewSigningKeyInstance
+            # Create the NewSigningKeyInstance
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @return [NewSigningKeyInstance] Created NewSigningKeyInstance
             def create(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -67,7 +65,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [NewSigningKeyInstance] NewSigningKeyInstance
             def get_instance(payload)
-              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -99,31 +97,31 @@ module Twilio
             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
 
             ##
-            # @return [String] The secret
+            # @return [String] The secret your application uses to sign Access Tokens and to authenticate to the REST API.
             def secret
               @properties['secret']
             end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the NotificationList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
-            #   notification.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Notification resource.
             # @return [NotificationList] NotificationList
             def initialize(version, account_sid: nil)
               super(version)
@@ -28,7 +31,9 @@ module Twilio
             # Lists NotificationInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] log Only show notifications for this log level
+            # @param [String] log Only read notifications of the specified log level. Can be:
+            #   `0` to read only ERROR notifications or `1` to read only WARNING notifications.
+            #   By default, all notifications are read.
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
             # @param [Time] message_date_after Filter by date
@@ -54,7 +59,9 @@ module Twilio
             # Streams NotificationInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] log Only show notifications for this log level
+            # @param [String] log Only read notifications of the specified log level. Can be:
+            #   `0` to read only ERROR notifications or `1` to read only WARNING notifications.
+            #   By default, all notifications are read.
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
             # @param [Time] message_date_after Filter by date
@@ -86,7 +93,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],
@@ -96,7 +103,9 @@ module Twilio
             ##
             # Retrieve a single page of NotificationInstance records from the API.
             # Request is executed immediately.
-            # @param [String] log Only show notifications for this log level
+            # @param [String] log Only read notifications of the specified log level. Can be:
+            #   `0` to read only ERROR notifications or `1` to read only WARNING notifications.
+            #   By default, all notifications are read.
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
             # @param [Time] message_date_after Filter by date
@@ -114,11 +123,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               NotificationPage.new(@version, response, @solution)
             end
 
@@ -161,7 +168,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [NotificationInstance] NotificationInstance
             def get_instance(payload)
-              NotificationInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NotificationInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -175,42 +182,44 @@ module Twilio
             ##
             # Initialize the NotificationContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The notification 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
+            #   Notification resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Notification resource to fetch.
             # @return [NotificationContext] NotificationContext
             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]}/Notifications/#{@solution[:sid]}.json"
             end
 
             ##
-            # Fetch a NotificationInstance
+            # Fetch the NotificationInstance
             # @return [NotificationInstance] Fetched NotificationInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              NotificationInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
               )
-
-              NotificationInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
             end
 
             ##
-            # Deletes the NotificationInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.NotificationContext #{context}>"
             end
 
             ##
-            # Provide a user friendly representation
-            def to_s
+            # Provide a detailed, user friendly representation
+            def inspect
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.NotificationContext #{context}>"
             end
@@ -221,9 +230,11 @@ module Twilio
             # Initialize the NotificationInstance
             # @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
-            #   notification.
-            # @param [String] sid The notification 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
+            #   Notification resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Notification resource to fetch.
             # @return [NotificationInstance] NotificationInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -242,16 +253,16 @@ module Twilio
                   'more_info' => payload['more_info'],
                   'request_method' => payload['request_method'],
                   'request_url' => payload['request_url'],
-                  'sid' => payload['sid'],
-                  'uri' => payload['uri'],
                   'request_variables' => payload['request_variables'],
                   'response_body' => payload['response_body'],
                   'response_headers' => payload['response_headers'],
+                  'sid' => payload['sid'],
+                  'uri' => payload['uri'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -260,37 +271,37 @@ module Twilio
             # @return [NotificationContext] NotificationContext for this NotificationInstance
             def context
               unless @instance_context
-                @instance_context = NotificationContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = NotificationContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The unique sid that identifies this account
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The version of the Twilio API in use
+            # @return [String] The API version used to generate the notification
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [String] The string that uniquely identifies the call
+            # @return [String] The SID of the Call the resource is associated with
             def call_sid
               @properties['call_sid']
             end
 
             ##
-            # @return [Time] The date this resource was 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 this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
             def date_updated
               @properties['date_updated']
             end
@@ -314,7 +325,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The text of the notification.
+            # @return [String] The text of the notification
             def message_text
               @properties['message_text']
             end
@@ -344,43 +355,36 @@ module Twilio
             end
 
             ##
-            # @return [String] The HTTP body returned by your server.
+            # @return [String] The HTTP body returned by your server
             def response_body
               @properties['response_body']
             end
 
             ##
-            # @return [String] The HTTP headers returned by your server.
+            # @return [String] The HTTP headers returned by your server
             def response_headers
               @properties['response_headers']
             end
 
             ##
-            # @return [String] A string that uniquely identifies this notification
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The URI for this resource
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
 
             ##
-            # Fetch a NotificationInstance
+            # Fetch the NotificationInstance
             # @return [NotificationInstance] Fetched NotificationInstance
             def fetch
               context.fetch
             end
 
-            ##
-            # Deletes the NotificationInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
-            end
-
             ##
             # Provide a user friendly representation
             def to_s