twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the ShortCodeList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account that owns this short
-            #   code.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this
+            #   ShortCode resource.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, account_sid: nil)
               super(version)
@@ -28,10 +31,11 @@ module Twilio
             # Lists ShortCodeInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] friendly_name Only show the ShortCode resources with friendly
-            #   names that exactly match this name
+            # @param [String] friendly_name The string that identifies the ShortCode resources
+            #   to read.
             # @param [String] short_code Only show the ShortCode resources that match this
-            #   pattern. You can specify partial numbers and use '*' as a wildcard for any digit
+            #   pattern. You can specify partial numbers and use '*' as a wildcard for any
+            #   digit.
             # @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
@@ -52,10 +56,11 @@ module Twilio
             # Streams ShortCodeInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] friendly_name Only show the ShortCode resources with friendly
-            #   names that exactly match this name
+            # @param [String] friendly_name The string that identifies the ShortCode resources
+            #   to read.
             # @param [String] short_code Only show the ShortCode resources that match this
-            #   pattern. You can specify partial numbers and use '*' as a wildcard for any digit
+            #   pattern. You can specify partial numbers and use '*' as a wildcard for any
+            #   digit.
             # @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
@@ -66,7 +71,11 @@ module Twilio
             def stream(friendly_name: :unset, short_code: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(friendly_name: friendly_name, short_code: short_code, page_size: limits[:page_size])
+              page = self.page(
+                  friendly_name: friendly_name,
+                  short_code: short_code,
+                  page_size: limits[:page_size],
+              )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -78,7 +87,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],
@@ -88,10 +97,11 @@ module Twilio
             ##
             # Retrieve a single page of ShortCodeInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name Only show the ShortCode resources with friendly
-            #   names that exactly match this name
+            # @param [String] friendly_name The string that identifies the ShortCode resources
+            #   to read.
             # @param [String] short_code Only show the ShortCode resources that match this
-            #   pattern. You can specify partial numbers and use '*' as a wildcard for any digit
+            #   pattern. You can specify partial numbers and use '*' as a wildcard for any
+            #   digit.
             # @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
@@ -104,11 +114,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
 
@@ -151,7 +159,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ShortCodeInstance] ShortCodeInstance
             def get_instance(payload)
-              ShortCodeInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              ShortCodeInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -165,47 +173,44 @@ module Twilio
             ##
             # Initialize the ShortCodeContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The short-code 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
+            #   ShortCode resource(s) to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch
             # @return [ShortCodeContext] ShortCodeContext
             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]}/SMS/ShortCodes/#{@solution[:sid]}.json"
             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, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              ShortCodeInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the ShortCodeInstance
-            # @param [String] friendly_name A human readable descriptive text for this
-            #   resource, up to 64 characters long. By default, the `FriendlyName` is just the
-            #   short code.
-            # @param [String] api_version SMSs to this short code will start a new TwiML
-            #   session with this API version.
-            # @param [String] sms_url The URL Twilio will request when receiving an incoming
-            #   SMS message to this short code.
-            # @param [String] sms_method The HTTP method Twilio will use when making requests
-            #   to the `SmsUrl`. Either `GET` or `POST`.
-            # @param [String] sms_fallback_url The URL that Twilio will request if an error
-            #   occurs retrieving or executing the TwiML from `SmsUrl`.
-            # @param [String] sms_fallback_method The HTTP method Twilio will use when
-            #   requesting the above URL. Either `GET` or `POST`.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long. By default, the
+            #   `FriendlyName` is the short code.
+            # @param [String] api_version The API version to use to start a new TwiML session.
+            #   Can be: `2010-04-01` or `2008-08-01`.
+            # @param [String] sms_url The URL we should call when receiving an incoming SMS
+            #   message to this short code.
+            # @param [String] sms_method The HTTP method we should use when calling the
+            #   `sms_url`. Can be: `GET` or `POST`.
+            # @param [String] sms_fallback_url The URL that we should call if an error occurs
+            #   while retrieving or executing the TwiML from `sms_url`.
+            # @param [String] sms_fallback_method The HTTP method that we should use to call
+            #   the `sms_fallback_url`. Can be: `GET` or `POST`.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(friendly_name: :unset, api_version: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset)
               data = Twilio::Values.of({
@@ -217,13 +222,9 @@ module Twilio
                   'SmsFallbackMethod' => sms_fallback_method,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              ShortCodeInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              ShortCodeInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -232,6 +233,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.ShortCodeContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.ShortCodeContext #{context}>"
+            end
           end
 
           class ShortCodeInstance < InstanceResource
@@ -239,9 +247,11 @@ module Twilio
             # Initialize the ShortCodeInstance
             # @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 that owns this short
-            #   code.
-            # @param [String] sid The short-code 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 this
+            #   ShortCode resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch
             # @return [ShortCodeInstance] ShortCodeInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -264,7 +274,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
 
             ##
@@ -273,37 +283,37 @@ module Twilio
             # @return [ShortCodeContext] ShortCodeContext for this ShortCodeInstance
             def context
               unless @instance_context
-                @instance_context = ShortCodeContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = ShortCodeContext.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 this resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The API version to use
+            # @return [String] The API version used to start a new TwiML session
             def api_version
               @properties['api_version']
             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] A human readable description of this resource
+            # @return [String] A string that you assigned to describe this resource
             def friendly_name
               @properties['friendly_name']
             end
@@ -315,13 +325,13 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this short-codes
+            # @return [String] The unique string that identifies this resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] HTTP method Twilio will use with sms fallback url
+            # @return [String] HTTP method we use to call the sms_fallback_url
             def sms_fallback_method
               @properties['sms_fallback_method']
             end
@@ -339,19 +349,19 @@ module Twilio
             end
 
             ##
-            # @return [String] URL Twilio will request when receiving an SMS
+            # @return [String] URL we call when receiving an incoming SMS message to this short code
             def sms_url
               @properties['sms_url']
             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
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
               context.fetch
@@ -359,19 +369,19 @@ module Twilio
 
             ##
             # Update the ShortCodeInstance
-            # @param [String] friendly_name A human readable descriptive text for this
-            #   resource, up to 64 characters long. By default, the `FriendlyName` is just the
-            #   short code.
-            # @param [String] api_version SMSs to this short code will start a new TwiML
-            #   session with this API version.
-            # @param [String] sms_url The URL Twilio will request when receiving an incoming
-            #   SMS message to this short code.
-            # @param [String] sms_method The HTTP method Twilio will use when making requests
-            #   to the `SmsUrl`. Either `GET` or `POST`.
-            # @param [String] sms_fallback_url The URL that Twilio will request if an error
-            #   occurs retrieving or executing the TwiML from `SmsUrl`.
-            # @param [String] sms_fallback_method The HTTP method Twilio will use when
-            #   requesting the above URL. Either `GET` or `POST`.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long. By default, the
+            #   `FriendlyName` is the short code.
+            # @param [String] api_version The API version to use to start a new TwiML session.
+            #   Can be: `2010-04-01` or `2008-08-01`.
+            # @param [String] sms_url The URL we should call when receiving an incoming SMS
+            #   message to this short code.
+            # @param [String] sms_method The HTTP method we should use when calling the
+            #   `sms_url`. Can be: `GET` or `POST`.
+            # @param [String] sms_fallback_url The URL that we should call if an error occurs
+            #   while retrieving or executing the TwiML from `sms_url`.
+            # @param [String] sms_fallback_method The HTTP method that we should use to call
+            #   the `sms_fallback_url`. Can be: `GET` or `POST`.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(friendly_name: :unset, api_version: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset)
               context.update(

data/lib/twilio-ruby/rest/api/v2010/account/signing_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],
@@ -85,11 +87,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               SigningKeyPage.new(@version, response, @solution)
             end
 
@@ -132,7 +132,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [SigningKeyInstance] SigningKeyInstance
             def get_instance(payload)
-              SigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              SigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -153,23 +153,22 @@ module Twilio
               super(version)
 
               # Path Solution
-              @solution = {account_sid: account_sid, sid: sid}
+              @solution = {account_sid: account_sid, sid: sid, }
               @uri = "/Accounts/#{@solution[:account_sid]}/SigningKeys/#{@solution[:sid]}.json"
             end
 
             ##
-            # Fetch a SigningKeyInstance
+            # Fetch the SigningKeyInstance
             # @return [SigningKeyInstance] Fetched SigningKeyInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              SigningKeyInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
               )
-
-              SigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
             end
 
             ##
@@ -177,22 +176,23 @@ module Twilio
             # @param [String] friendly_name The friendly_name
             # @return [SigningKeyInstance] Updated SigningKeyInstance
             def update(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              SigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              SigningKeyInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
-            # Deletes the SigningKeyInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the SigningKeyInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -201,6 +201,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.SigningKeyContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.SigningKeyContext #{context}>"
+            end
           end
 
           class SigningKeyInstance < InstanceResource
@@ -225,7 +232,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,7 +241,7 @@ module Twilio
             # @return [SigningKeyContext] SigningKeyContext for this SigningKeyInstance
             def context
               unless @instance_context
-                @instance_context = SigningKeyContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = SigningKeyContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
@@ -264,7 +271,7 @@ module Twilio
             end
 
             ##
-            # Fetch a SigningKeyInstance
+            # Fetch the SigningKeyInstance
             # @return [SigningKeyInstance] Fetched SigningKeyInstance
             def fetch
               context.fetch
@@ -275,12 +282,12 @@ module Twilio
             # @param [String] friendly_name The friendly_name
             # @return [SigningKeyInstance] Updated SigningKeyInstance
             def update(friendly_name: :unset)
-              context.update(friendly_name: friendly_name)
+              context.update(friendly_name: friendly_name, )
             end
 
             ##
-            # Deletes the SigningKeyInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the SigningKeyInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end