twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,7 +16,9 @@ module Twilio
               ##
               # Initialize the DependentPhoneNumberList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   DependentPhoneNumber resource.
               # @param [String] address_sid The unique string that that we created to identify
               #   the Address resource.
               # @return [DependentPhoneNumberList] DependentPhoneNumberList
@@ -89,11 +91,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 DependentPhoneNumberPage.new(@version, response, @solution)
               end
 
@@ -156,7 +156,9 @@ module Twilio
               # Initialize the DependentPhoneNumberInstance
               # @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] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   DependentPhoneNumber resource.
               # @param [String] address_sid The unique string that that we created to identify
               #   the Address resource.
               # @return [DependentPhoneNumberInstance] DependentPhoneNumberInstance
@@ -195,157 +197,157 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               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 friendly_name
+              # @return [String] The string that you assigned to describe the resource
               def friendly_name
                 @properties['friendly_name']
               end
 
               ##
-              # @return [String] The phone_number
+              # @return [String] The phone number in E.164 format
               def phone_number
                 @properties['phone_number']
               end
 
               ##
-              # @return [String] The voice_url
+              # @return [String] The URL we call when the phone number receives a call
               def voice_url
                 @properties['voice_url']
               end
 
               ##
-              # @return [String] The voice_method
+              # @return [String] The HTTP method used with the voice_url
               def voice_method
                 @properties['voice_method']
               end
 
               ##
-              # @return [String] The voice_fallback_method
+              # @return [String] The HTTP method used with voice_fallback_url
               def voice_fallback_method
                 @properties['voice_fallback_method']
               end
 
               ##
-              # @return [String] The voice_fallback_url
+              # @return [String] The URL we call when an error occurs in TwiML
               def voice_fallback_url
                 @properties['voice_fallback_url']
               end
 
               ##
-              # @return [Boolean] The voice_caller_id_lookup
+              # @return [Boolean] Whether to lookup the caller's name
               def voice_caller_id_lookup
                 @properties['voice_caller_id_lookup']
               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 sms_fallback_method
+              # @return [String] The HTTP method used with sms_fallback_url
               def sms_fallback_method
                 @properties['sms_fallback_method']
               end
 
               ##
-              # @return [String] The sms_fallback_url
+              # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML
               def sms_fallback_url
                 @properties['sms_fallback_url']
               end
 
               ##
-              # @return [String] The sms_method
+              # @return [String] The HTTP method to use with sms_url
               def sms_method
                 @properties['sms_method']
               end
 
               ##
-              # @return [String] The sms_url
+              # @return [String] The URL we call when the phone number receives an incoming SMS message
               def sms_url
                 @properties['sms_url']
               end
 
               ##
-              # @return [dependent_phone_number.AddressRequirement] The address_requirements
+              # @return [dependent_phone_number.AddressRequirement] Whether the phone number requires an Address registered with Twilio
               def address_requirements
                 @properties['address_requirements']
               end
 
               ##
-              # @return [Hash] The capabilities
+              # @return [Hash] Indicate if a phone can receive calls or messages
               def capabilities
                 @properties['capabilities']
               end
 
               ##
-              # @return [String] The status_callback
+              # @return [String] The URL to send status information to your application
               def status_callback
                 @properties['status_callback']
               end
 
               ##
-              # @return [String] The status_callback_method
+              # @return [String] The HTTP method we use to call status_callback
               def status_callback_method
                 @properties['status_callback_method']
               end
 
               ##
-              # @return [String] The api_version
+              # @return [String] The API version used to start a new TwiML session
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [String] The sms_application_sid
+              # @return [String] The SID of the application that handles SMS messages sent to the phone number
               def sms_application_sid
                 @properties['sms_application_sid']
               end
 
               ##
-              # @return [String] The voice_application_sid
+              # @return [String] The SID of the application that handles calls to the phone number
               def voice_application_sid
                 @properties['voice_application_sid']
               end
 
               ##
-              # @return [String] The trunk_sid
+              # @return [String] The SID of the Trunk that handles calls to the phone number
               def trunk_sid
                 @properties['trunk_sid']
               end
 
               ##
-              # @return [dependent_phone_number.EmergencyStatus] The emergency_status
+              # @return [dependent_phone_number.EmergencyStatus] Whether the phone number is enabled for emergency calling
               def emergency_status
                 @properties['emergency_status']
               end
 
               ##
-              # @return [String] The emergency_address_sid
+              # @return [String] The emergency address configuration to use for emergency calling
               def emergency_address_sid
                 @properties['emergency_address_sid']
               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/application.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,7 +16,7 @@ module Twilio
             # Initialize the ApplicationList
             # @param [Version] version Version that contains the resource
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
             #   Application resource.
             # @return [ApplicationList] ApplicationList
             def initialize(version, account_sid: nil)
@@ -28,10 +28,7 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ApplicationInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name A descriptive string that you create to describe
-            #   the new application. It can be up to 64 characters long.
+            # Create the ApplicationInstance
             # @param [String] api_version The API version to use to start a new TwiML session.
             #   Can be: `2010-04-01` or `2008-08-01`. The default value is the account's default
             #   API version.
@@ -62,10 +59,11 @@ module Twilio
             #   to send status information about SMS messages sent by the application.
             # @param [String] message_status_callback The URL we should call using a POST
             #   method to send message status information to your application.
-            # @return [ApplicationInstance] Newly created ApplicationInstance
-            def create(friendly_name: nil, api_version: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, voice_caller_id_lookup: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, sms_status_callback: :unset, message_status_callback: :unset)
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new application. It can be up to 64 characters long.
+            # @return [ApplicationInstance] Created ApplicationInstance
+            def create(api_version: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, voice_caller_id_lookup: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, sms_status_callback: :unset, message_status_callback: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
-                  'FriendlyName' => friendly_name,
                   'ApiVersion' => api_version,
                   'VoiceUrl' => voice_url,
                   'VoiceMethod' => voice_method,
@@ -80,13 +78,10 @@ module Twilio
                   'SmsFallbackMethod' => sms_fallback_method,
                   'SmsStatusCallback' => sms_status_callback,
                   'MessageStatusCallback' => message_status_callback,
+                  'FriendlyName' => friendly_name,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ApplicationInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
@@ -159,11 +154,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ApplicationPage.new(@version, response, @solution)
             end
 
@@ -221,7 +214,7 @@ module Twilio
             # Initialize the ApplicationContext
             # @param [Version] version Version that contains the resource
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
             #   Application resource to fetch.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Application resource to fetch.
@@ -235,23 +228,17 @@ module Twilio
             end
 
             ##
-            # Deletes the ApplicationInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ApplicationInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a ApplicationInstance
+            # Fetch the ApplicationInstance
             # @return [ApplicationInstance] Fetched ApplicationInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               ApplicationInstance.new(
                   @version,
@@ -291,8 +278,9 @@ module Twilio
             #   occurs while retrieving or executing the TwiML from `sms_url`.
             # @param [String] sms_fallback_method The HTTP method we should use to call
             #   `sms_fallback_url`. Can be: `GET` or `POST`.
-            # @param [String] sms_status_callback The URL we should call using a POST method
-            #   to send status information about SMS messages sent by the application.
+            # @param [String] sms_status_callback Same as message_status_callback: The URL we
+            #   should call using a POST method to send status information about SMS messages
+            #   sent by the application. Deprecated, included for backwards compatibility.
             # @param [String] message_status_callback The URL we should call using a POST
             #   method to send message status information to your application.
             # @return [ApplicationInstance] Updated ApplicationInstance
@@ -315,11 +303,7 @@ module Twilio
                   'MessageStatusCallback' => message_status_callback,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               ApplicationInstance.new(
                   @version,
@@ -335,6 +319,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.ApplicationContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.ApplicationContext #{context}>"
+            end
           end
 
           class ApplicationInstance < InstanceResource
@@ -343,7 +334,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
             #   Application resource.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Application resource to fetch.
@@ -512,14 +503,14 @@ module Twilio
             end
 
             ##
-            # Deletes the ApplicationInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ApplicationInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a ApplicationInstance
+            # Fetch the ApplicationInstance
             # @return [ApplicationInstance] Fetched ApplicationInstance
             def fetch
               context.fetch
@@ -555,8 +546,9 @@ module Twilio
             #   occurs while retrieving or executing the TwiML from `sms_url`.
             # @param [String] sms_fallback_method The HTTP method we should use to call
             #   `sms_fallback_url`. Can be: `GET` or `POST`.
-            # @param [String] sms_status_callback The URL we should call using a POST method
-            #   to send status information about SMS messages sent by the application.
+            # @param [String] sms_status_callback Same as message_status_callback: The URL we
+            #   should call using a POST method to send status information about SMS messages
+            #   sent by the application. Deprecated, included for backwards compatibility.
             # @param [String] message_status_callback The URL we should call using a POST
             #   method to send message status information to your application.
             # @return [ApplicationInstance] Updated ApplicationInstance

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,7 +16,7 @@ module Twilio
             # Initialize the AuthorizedConnectAppList
             # @param [Version] version Version that contains the resource
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
             #   AuthorizedConnectApp resource.
             # @return [AuthorizedConnectAppList] AuthorizedConnectAppList
             def initialize(version, account_sid: nil)
@@ -88,11 +88,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               AuthorizedConnectAppPage.new(@version, response, @solution)
             end
 
@@ -150,7 +148,7 @@ module Twilio
             # Initialize the AuthorizedConnectAppContext
             # @param [Version] version Version that contains the resource
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
             #   AuthorizedConnectApp resource to fetch.
             # @param [String] connect_app_sid The SID of the Connect App to fetch.
             # @return [AuthorizedConnectAppContext] AuthorizedConnectAppContext
@@ -163,16 +161,10 @@ module Twilio
             end
 
             ##
-            # Fetch a AuthorizedConnectAppInstance
+            # Fetch the AuthorizedConnectAppInstance
             # @return [AuthorizedConnectAppInstance] Fetched AuthorizedConnectAppInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               AuthorizedConnectAppInstance.new(
                   @version,
@@ -188,6 +180,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.AuthorizedConnectAppContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.AuthorizedConnectAppContext #{context}>"
+            end
           end
 
           class AuthorizedConnectAppInstance < InstanceResource
@@ -196,7 +195,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
             #   AuthorizedConnectApp resource.
             # @param [String] connect_app_sid The SID of the Connect App to fetch.
             # @return [AuthorizedConnectAppInstance] AuthorizedConnectAppInstance
@@ -289,7 +288,7 @@ module Twilio
             end
 
             ##
-            # @return [authorized_connect_app.Permission] Permissions authorized to the app
+            # @return [Array[authorized_connect_app.Permission]] Permissions authorized to the app
             def permissions
               @properties['permissions']
             end
@@ -301,7 +300,7 @@ module Twilio
             end
 
             ##
-            # Fetch a AuthorizedConnectAppInstance
+            # Fetch the AuthorizedConnectAppInstance
             # @return [AuthorizedConnectAppInstance] Fetched AuthorizedConnectAppInstance
             def fetch
               context.fetch