twilio-ruby 5.15.1 → 5.58.1

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the RecordingList
             # @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
-            #   recording.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Recording resource.
             # @return [RecordingList] RecordingList
             def initialize(version, account_sid: nil)
               super(version)
@@ -31,12 +31,14 @@ module Twilio
             # Lists RecordingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [String] call_sid Only show recordings made during the call indicated by
-            #   this call SID
-            # @param [String] conference_sid The conference_sid
+            # @param [Time] date_created_before Only include recordings that were created on this date
+            # @param [Time] date_created Only include recordings that were created on this date
+            # @param [Time] date_created_after Only include recordings that were created on this date
+            # @param [String] call_sid The
+            #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources
+            #   to read.
+            # @param [String] conference_sid The Conference SID that identifies the conference
+            #   associated with the recording 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
@@ -60,12 +62,14 @@ module Twilio
             # Streams RecordingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [String] call_sid Only show recordings made during the call indicated by
-            #   this call SID
-            # @param [String] conference_sid The conference_sid
+            # @param [Time] date_created_before Only include recordings that were created on this date
+            # @param [Time] date_created Only include recordings that were created on this date
+            # @param [Time] date_created_after Only include recordings that were created on this date
+            # @param [String] call_sid The
+            #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources
+            #   to read.
+            # @param [String] conference_sid The Conference SID that identifies the conference
+            #   associated with the recording 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
@@ -105,12 +109,14 @@ module Twilio
             ##
             # Retrieve a single page of RecordingInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [String] call_sid Only show recordings made during the call indicated by
-            #   this call SID
-            # @param [String] conference_sid The conference_sid
+            # @param [Time] date_created_before Only include recordings that were created on this date
+            # @param [Time] date_created Only include recordings that were created on this date
+            # @param [Time] date_created_after Only include recordings that were created on this date
+            # @param [String] call_sid The
+            #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources
+            #   to read.
+            # @param [String] conference_sid The Conference SID that identifies the conference
+            #   associated with the recording 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
@@ -126,11 +132,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               RecordingPage.new(@version, response, @solution)
             end
 
@@ -187,8 +191,11 @@ module Twilio
             ##
             # Initialize the RecordingContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The unique recording SID that identifies this resource
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Recording resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Recording resource to fetch.
             # @return [RecordingContext] RecordingContext
             def initialize(version, account_sid, sid)
               super(version)
@@ -203,25 +210,19 @@ module Twilio
             end
 
             ##
-            # Fetch a RecordingInstance
+            # Fetch the RecordingInstance
             # @return [RecordingInstance] Fetched RecordingInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               RecordingInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the RecordingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -274,6 +275,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.RecordingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.RecordingContext #{context}>"
+            end
           end
 
           class RecordingInstance < InstanceResource
@@ -281,10 +289,11 @@ module Twilio
             # Initialize the RecordingInstance
             # @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
-            #   recording.
-            # @param [String] sid The unique recording SID that identifies this resource
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Recording resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Recording resource to fetch.
             # @return [RecordingInstance] RecordingInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -328,19 +337,19 @@ 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 API in use during the recording.
+            # @return [String] The API version used during the recording.
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [String] The unique ID for the call leg that corresponds to the recording.
+            # @return [String] The SID of the Call the resource is associated with
             def call_sid
               @properties['call_sid']
             end
@@ -352,19 +361,19 @@ module Twilio
             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 [Time] The start time of the recording, in RFC 2822 format.
+            # @return [Time] The start time of the recording, given in RFC 2822 format
             def start_time
               @properties['start_time']
             end
@@ -376,19 +385,19 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this recording
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The one-time cost of creating this recording.
+            # @return [String] The one-time cost of creating the recording.
             def price
               @properties['price']
             end
 
             ##
-            # @return [String] The currency used in the Price property.
+            # @return [String] The currency used in the price property.
             def price_unit
               @properties['price_unit']
             end
@@ -406,45 +415,45 @@ module Twilio
             end
 
             ##
-            # @return [recording.Source] The way in which this recording was created.
+            # @return [recording.Source] How the recording was created
             def source
               @properties['source']
             end
 
             ##
-            # @return [String] More information about the recording failure, if Status is failed.
+            # @return [String] More information about why the recording is missing, if status is `absent`.
             def error_code
               @properties['error_code']
             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
 
             ##
-            # @return [Hash] Details for how to decrypt the recording.
+            # @return [Hash] How to decrypt the recording.
             def encryption_details
               @properties['encryption_details']
             end
 
             ##
-            # @return [String] The subresource_uris
+            # @return [String] A list of related resources identified by their relative URIs
             def subresource_uris
               @properties['subresource_uris']
             end
 
             ##
-            # Fetch a RecordingInstance
+            # Fetch the RecordingInstance
             # @return [RecordingInstance] Fetched RecordingInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the RecordingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +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](https://www.twilio.com/docs/api/rest/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)
@@ -31,8 +31,8 @@ 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.
@@ -56,8 +56,8 @@ 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.
@@ -97,8 +97,8 @@ 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.
@@ -114,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
 
@@ -175,8 +173,11 @@ 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)
@@ -187,35 +188,29 @@ module Twilio
             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], )
             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. Either `2010-04-01` or `2008-08-01`.
-            # @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 that should be used to
-            #   request the `SmsFallbackUrl`. 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({
@@ -227,11 +222,7 @@ 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], )
             end
@@ -242,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
@@ -249,10 +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](https://www.twilio.com/docs/api/rest/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)
@@ -290,31 +289,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique sid that identifies this account
+            # @return [String] The SID of the Account that created this resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @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
@@ -326,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
@@ -350,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
@@ -370,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. Either `2010-04-01` or `2008-08-01`.
-            # @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 that should be used to
-            #   request the `SmsFallbackUrl`. 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(