twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -27,18 +27,14 @@ 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, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
@@ -101,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,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -27,18 +27,14 @@ 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, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
@@ -101,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,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +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](https://www.twilio.com/docs/iam/api/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)
@@ -31,8 +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, using the integer log
-            #   values shown above.
+            # @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
@@ -58,8 +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, using the integer log
-            #   values shown above.
+            # @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
@@ -101,8 +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, using the integer log
-            #   values shown above.
+            # @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
@@ -120,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
 
@@ -181,8 +182,11 @@ 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)
@@ -193,16 +197,10 @@ module Twilio
             end
 
             ##
-            # Fetch a NotificationInstance
+            # Fetch the NotificationInstance
             # @return [NotificationInstance] Fetched NotificationInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               NotificationInstance.new(
                   @version,
@@ -213,15 +211,15 @@ module Twilio
             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
@@ -232,10 +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](https://www.twilio.com/docs/iam/api/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)
@@ -254,11 +253,11 @@ 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
@@ -278,31 +277,31 @@ module Twilio
             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
@@ -326,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
@@ -356,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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the OutgoingCallerIdList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique ID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
-            #   Caller Id.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   OutgoingCallerId resource.
             # @return [OutgoingCallerIdList] OutgoingCallerIdList
             def initialize(version, account_sid: nil)
               super(version)
@@ -31,10 +31,10 @@ module Twilio
             # Lists OutgoingCallerIdInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number.
-            # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name.
+            # @param [String] phone_number The phone number of the OutgoingCallerId resources
+            #   to read.
+            # @param [String] friendly_name The string that identifies the OutgoingCallerId
+            #   resources to read.
             # @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,10 +55,10 @@ module Twilio
             # Streams OutgoingCallerIdInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number.
-            # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name.
+            # @param [String] phone_number The phone number of the OutgoingCallerId resources
+            #   to read.
+            # @param [String] friendly_name The string that identifies the OutgoingCallerId
+            #   resources to read.
             # @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
@@ -95,10 +95,10 @@ module Twilio
             ##
             # Retrieve a single page of OutgoingCallerIdInstance records from the API.
             # Request is executed immediately.
-            # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number.
-            # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name.
+            # @param [String] phone_number The phone number of the OutgoingCallerId resources
+            #   to read.
+            # @param [String] friendly_name The string that identifies the OutgoingCallerId
+            #   resources to read.
             # @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
@@ -111,11 +111,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               OutgoingCallerIdPage.new(@version, response, @solution)
             end
 
@@ -172,9 +170,11 @@ module Twilio
             ##
             # Initialize the OutgoingCallerIdContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The outgoing-caller-id 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
+            #   OutgoingCallerId resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   OutgoingCallerId resource to fetch.
             # @return [OutgoingCallerIdContext] OutgoingCallerIdContext
             def initialize(version, account_sid, sid)
               super(version)
@@ -185,16 +185,10 @@ module Twilio
             end
 
             ##
-            # Fetch a OutgoingCallerIdInstance
+            # Fetch the OutgoingCallerIdInstance
             # @return [OutgoingCallerIdInstance] Fetched OutgoingCallerIdInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               OutgoingCallerIdInstance.new(
                   @version,
@@ -206,18 +200,13 @@ module Twilio
 
             ##
             # Update the OutgoingCallerIdInstance
-            # @param [String] friendly_name A human readable description of a Caller ID, with
-            #   maximum length of 64 characters. Defaults to a nicely formatted version of the
-            #   phone number.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [OutgoingCallerIdInstance] Updated OutgoingCallerIdInstance
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               OutgoingCallerIdInstance.new(
                   @version,
@@ -228,10 +217,10 @@ module Twilio
             end
 
             ##
-            # Deletes the OutgoingCallerIdInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the OutgoingCallerIdInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -240,6 +229,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.OutgoingCallerIdContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.OutgoingCallerIdContext #{context}>"
+            end
           end
 
           class OutgoingCallerIdInstance < InstanceResource
@@ -247,11 +243,11 @@ module Twilio
             # Initialize the OutgoingCallerIdInstance
             # @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](https://www.twilio.com/docs/api/rest/account) responsible for this
-            #   Caller Id.
-            # @param [String] sid The outgoing-caller-id 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
+            #   OutgoingCallerId resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   OutgoingCallerId resource to fetch.
             # @return [OutgoingCallerIdInstance] OutgoingCallerIdInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -284,49 +280,49 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this outgoing-caller-ids
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['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
 
             ##
-            # @return [String] A human readable description for this resource
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             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 incoming phone number
+            # @return [String] The phone number in E.164 format
             def phone_number
               @properties['phone_number']
             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 OutgoingCallerIdInstance
+            # Fetch the OutgoingCallerIdInstance
             # @return [OutgoingCallerIdInstance] Fetched OutgoingCallerIdInstance
             def fetch
               context.fetch
@@ -334,17 +330,16 @@ module Twilio
 
             ##
             # Update the OutgoingCallerIdInstance
-            # @param [String] friendly_name A human readable description of a Caller ID, with
-            #   maximum length of 64 characters. Defaults to a nicely formatted version of the
-            #   phone number.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [OutgoingCallerIdInstance] Updated OutgoingCallerIdInstance
             def update(friendly_name: :unset)
               context.update(friendly_name: friendly_name, )
             end
 
             ##
-            # Deletes the OutgoingCallerIdInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the OutgoingCallerIdInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end