twilio-ruby 5.19.0 → 5.74.2

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,13 +31,17 @@ 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 unique ID for the conference associated with
-            #   the recording, if the recording is of a conference.
+            # @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 [Boolean] include_soft_deleted A boolean parameter indicating whether to
+            #   retrieve soft deleted recordings or not. Recordings metadata are kept after
+            #   deletion for a retention period of 40 days.
             # @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
@@ -45,13 +49,14 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Array] Array of up to limit results
-            def list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil)
+            def list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, limit: nil, page_size: nil)
               self.stream(
                   date_created_before: date_created_before,
                   date_created: date_created,
                   date_created_after: date_created_after,
                   call_sid: call_sid,
                   conference_sid: conference_sid,
+                  include_soft_deleted: include_soft_deleted,
                   limit: limit,
                   page_size: page_size
               ).entries
@@ -61,13 +66,17 @@ 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 unique ID for the conference associated with
-            #   the recording, if the recording is of a conference.
+            # @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 [Boolean] include_soft_deleted A boolean parameter indicating whether to
+            #   retrieve soft deleted recordings or not. Recordings metadata are kept after
+            #   deletion for a retention period of 40 days.
             # @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
@@ -75,7 +84,7 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Enumerable] Enumerable that will yield up to limit results
-            def stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil)
+            def stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
               page = self.page(
@@ -84,6 +93,7 @@ module Twilio
                   date_created_after: date_created_after,
                   call_sid: call_sid,
                   conference_sid: conference_sid,
+                  include_soft_deleted: include_soft_deleted,
                   page_size: limits[:page_size],
               )
 
@@ -107,33 +117,36 @@ 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 unique ID for the conference associated with
-            #   the recording, if the recording is of a conference.
+            # @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 [Boolean] include_soft_deleted A boolean parameter indicating whether to
+            #   retrieve soft deleted recordings or not. Recordings metadata are kept after
+            #   deletion for a retention period of 40 days.
             # @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
             # @return [Page] Page of RecordingInstance
-            def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'DateCreated<' => Twilio.serialize_iso8601_datetime(date_created_before),
                   'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                   'DateCreated>' => Twilio.serialize_iso8601_datetime(date_created_after),
                   'CallSid' => call_sid,
                   'ConferenceSid' => conference_sid,
+                  'IncludeSoftDeleted' => include_soft_deleted,
                   'PageToken' => page_token,
                   '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
 
@@ -190,10 +203,11 @@ module Twilio
             ##
             # Initialize the RecordingContext
             # @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
-            #   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 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)
@@ -208,25 +222,24 @@ module Twilio
             end
 
             ##
-            # Fetch a RecordingInstance
+            # Fetch the RecordingInstance
+            # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to
+            #   retrieve soft deleted recordings or not. Recordings metadata are kept after
+            #   deletion for a retention period of 40 days.
             # @return [RecordingInstance] Fetched RecordingInstance
-            def fetch
-              params = Twilio::Values.of({})
+            def fetch(include_soft_deleted: :unset)
+              params = Twilio::Values.of({'IncludeSoftDeleted' => include_soft_deleted, })
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri, params: params)
 
               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
 
             ##
@@ -279,6 +292,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
@@ -286,10 +306,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)
@@ -308,12 +329,13 @@ module Twilio
                   'price' => payload['price'],
                   'price_unit' => payload['price_unit'],
                   'status' => payload['status'],
-                  'channels' => payload['channels'].to_i,
+                  'channels' => payload['channels'] == nil ? payload['channels'] : payload['channels'].to_i,
                   'source' => payload['source'],
                   'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
                   'uri' => payload['uri'],
                   'encryption_details' => payload['encryption_details'],
                   'subresource_uris' => payload['subresource_uris'],
+                  'media_url' => payload['media_url'],
               }
 
               # Context
@@ -333,19 +355,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
@@ -357,19 +379,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
@@ -381,19 +403,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
@@ -411,45 +433,54 @@ 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 why the recording is missing, if Status is `absent`.
+            # @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] A dictionary of URIs for related resources
+            # @return [String] A list of related resources identified by their relative URIs
             def subresource_uris
               @properties['subresource_uris']
             end
 
             ##
-            # Fetch a RecordingInstance
+            # @return [String] The URL of the media file.
+            def media_url
+              @properties['media_url']
+            end
+
+            ##
+            # Fetch the RecordingInstance
+            # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to
+            #   retrieve soft deleted recordings or not. Recordings metadata are kept after
+            #   deletion for a retention period of 40 days.
             # @return [RecordingInstance] Fetched RecordingInstance
-            def fetch
-              context.fetch
+            def fetch(include_soft_deleted: :unset)
+              context.fetch(include_soft_deleted: include_soft_deleted, )
             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
@@ -16,7 +16,7 @@ module Twilio
             # Initialize the ShortCodeList
             # @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 this
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this
             #   ShortCode resource.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, account_sid: nil)
@@ -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
 
@@ -176,7 +174,7 @@ module Twilio
             # Initialize the ShortCodeContext
             # @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
             #   ShortCode resource(s) to fetch.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   ShortCode resource to fetch
@@ -190,16 +188,10 @@ 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
@@ -230,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
@@ -245,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
@@ -253,7 +248,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 this
+            #   {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
@@ -366,7 +361,7 @@ module Twilio
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
               context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -87,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
 
@@ -160,16 +158,10 @@ module Twilio
             end
 
             ##
-            # Fetch a SigningKeyInstance
+            # Fetch the SigningKeyInstance
             # @return [SigningKeyInstance] Fetched SigningKeyInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               SigningKeyInstance.new(
                   @version,
@@ -186,11 +178,7 @@ module Twilio
             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)
 
               SigningKeyInstance.new(
                   @version,
@@ -201,10 +189,10 @@ module Twilio
             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
 
             ##
@@ -213,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
@@ -276,7 +271,7 @@ module Twilio
             end
 
             ##
-            # Fetch a SigningKeyInstance
+            # Fetch the SigningKeyInstance
             # @return [SigningKeyInstance] Fetched SigningKeyInstance
             def fetch
               context.fetch
@@ -291,8 +286,8 @@ module Twilio
             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