twilio-ruby 5.15.1 → 5.58.1

data/lib/twilio-ruby/rest/video/v1/recording_settings.rb

@@ -3,15 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
     class Video < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsList < ListResource
           ##
           # Initialize the RecordingSettingsList
@@ -31,8 +29,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsPage < Page
           ##
           # Initialize the RecordingSettingsPage
@@ -62,8 +58,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsContext < InstanceContext
           ##
           # Initialize the RecordingSettingsContext
@@ -78,37 +72,32 @@ module Twilio
           end
 
           ##
-          # Fetch a RecordingSettingsInstance
+          # Fetch the RecordingSettingsInstance
           # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             RecordingSettingsInstance.new(@version, payload, )
           end
 
           ##
-          # Retrieve a single page of RecordingSettingsInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] friendly_name Friendly name of the configuration to be shown in
-          #   the console
-          # @param [String] aws_credentials_sid SID of the Stored Credential resource `CRxx`
-          # @param [String] encryption_key_sid SID of the Public Key resource `CRxx`
-          # @param [String] aws_s3_url Identity of the external location where the
-          #   recordings should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/recordings`, where
-          #   `recordings` is the path where you want recordings to be stored.
-          # @param [Boolean] aws_storage_enabled `true|false` When set to `true`, all
-          #   Recordings will be written to the `AwsS3Url` specified above. When set to
-          #   `false`, all Recordings will be stored in Twilio's cloud.
-          # @param [Boolean] encryption_enabled `true|false` When set to `true`, all
-          #   Recordings will be stored encrypted. Dafault value is `false`
-          # @return [RecordingSettingsInstance] Newly created RecordingSettingsInstance
+          # Create the RecordingSettingsInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource and be shown to users in the console
+          # @param [String] aws_credentials_sid The SID of the stored Credential resource.
+          # @param [String] encryption_key_sid The SID of the Public Key resource to use for
+          #   encryption.
+          # @param [String] aws_s3_url The URL of the AWS S3 bucket where the recordings
+          #   should be stored. We only support DNS-compliant URLs like
+          #   `https://documentation-example-twilio-bucket/recordings`, where `recordings` is
+          #   the path in which you want the recordings to be stored. This URL accepts only
+          #   URI-valid characters, as described in the <a
+          #   href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
+          # @param [Boolean] aws_storage_enabled Whether all recordings should be written to
+          #   the `aws_s3_url`. When `false`, all recordings are stored in our cloud.
+          # @param [Boolean] encryption_enabled Whether all recordings should be stored in
+          #   an encrypted form. The default is `false`.
+          # @return [RecordingSettingsInstance] Created RecordingSettingsInstance
           def create(friendly_name: nil, aws_credentials_sid: :unset, encryption_key_sid: :unset, aws_s3_url: :unset, aws_storage_enabled: :unset, encryption_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
@@ -119,11 +108,7 @@ module Twilio
                 'EncryptionEnabled' => encryption_enabled,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             RecordingSettingsInstance.new(@version, payload, )
           end
@@ -134,10 +119,15 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Video.V1.RecordingSettingsContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Video.V1.RecordingSettingsContext #{context}>"
+          end
         end
 
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class RecordingSettingsInstance < InstanceResource
           ##
           # Initialize the RecordingSettingsInstance
@@ -176,77 +166,78 @@ module Twilio
           end
 
           ##
-          # @return [String] The Twilio Account SID associated with this item
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] Friendly name of the configuration to be shown in the console
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [String] SID of the Stored Credential resource CRxx
+          # @return [String] The SID of the stored Credential resource
           def aws_credentials_sid
             @properties['aws_credentials_sid']
           end
 
           ##
-          # @return [String] URL of the S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like http://<my-bucket>.s3-<aws-region>.amazonaws.com/recordings, where recordings is the path where you want recordings to be stored.
+          # @return [String] The URL of the AWS S3 bucket where the recordings are stored
           def aws_s3_url
             @properties['aws_s3_url']
           end
 
           ##
-          # @return [Boolean] true|false When set to true, all Recordings will be written to the AwsS3Url specified above. When set to false, all Recordings will be stored in Twilio's cloud.
+          # @return [Boolean] Whether all recordings are written to the aws_s3_url
           def aws_storage_enabled
             @properties['aws_storage_enabled']
           end
 
           ##
-          # @return [String] SID of the Public Key resource CRxx
+          # @return [String] The SID of the Public Key resource used for encryption
           def encryption_key_sid
             @properties['encryption_key_sid']
           end
 
           ##
-          # @return [Boolean] true|false When set to true, all Recordings will be stored encrypted.
+          # @return [Boolean] Whether all recordings are stored in an encrypted form
           def encryption_enabled
             @properties['encryption_enabled']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a RecordingSettingsInstance
+          # Fetch the RecordingSettingsInstance
           # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Retrieve a single page of RecordingSettingsInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] friendly_name Friendly name of the configuration to be shown in
-          #   the console
-          # @param [String] aws_credentials_sid SID of the Stored Credential resource `CRxx`
-          # @param [String] encryption_key_sid SID of the Public Key resource `CRxx`
-          # @param [String] aws_s3_url Identity of the external location where the
-          #   recordings should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/recordings`, where
-          #   `recordings` is the path where you want recordings to be stored.
-          # @param [Boolean] aws_storage_enabled `true|false` When set to `true`, all
-          #   Recordings will be written to the `AwsS3Url` specified above. When set to
-          #   `false`, all Recordings will be stored in Twilio's cloud.
-          # @param [Boolean] encryption_enabled `true|false` When set to `true`, all
-          #   Recordings will be stored encrypted. Dafault value is `false`
-          # @return [RecordingSettingsInstance] Newly created RecordingSettingsInstance
+          # Create the RecordingSettingsInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource and be shown to users in the console
+          # @param [String] aws_credentials_sid The SID of the stored Credential resource.
+          # @param [String] encryption_key_sid The SID of the Public Key resource to use for
+          #   encryption.
+          # @param [String] aws_s3_url The URL of the AWS S3 bucket where the recordings
+          #   should be stored. We only support DNS-compliant URLs like
+          #   `https://documentation-example-twilio-bucket/recordings`, where `recordings` is
+          #   the path in which you want the recordings to be stored. This URL accepts only
+          #   URI-valid characters, as described in the <a
+          #   href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
+          # @param [Boolean] aws_storage_enabled Whether all recordings should be written to
+          #   the `aws_s3_url`. When `false`, all recordings are stored in our cloud.
+          # @param [Boolean] encryption_enabled Whether all recordings should be stored in
+          #   an encrypted form. The default is `false`.
+          # @return [RecordingSettingsInstance] Created RecordingSettingsInstance
           def create(friendly_name: nil, aws_credentials_sid: :unset, encryption_key_sid: :unset, aws_s3_url: :unset, aws_storage_enabled: :unset, encryption_enabled: :unset)
             context.create(
                 friendly_name: friendly_name,

data/lib/twilio-ruby/rest/video/v1/room/recording.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,7 +15,8 @@ module Twilio
             ##
             # Initialize the RoomRecordingList
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
+            # @param [String] room_sid The SID of the Room resource the recording is
+            #   associated with.
             # @return [RoomRecordingList] RoomRecordingList
             def initialize(version, room_sid: nil)
               super(version)
@@ -29,10 +30,13 @@ module Twilio
             # Lists RoomRecordingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [room_recording.Status] status The status
-            # @param [String] source_sid The source_sid
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @param [room_recording.Status] status Read only the recordings with this status.
+            #   Can be: `processing`, `completed`, or `deleted`.
+            # @param [String] source_sid Read only the recordings that have this `source_sid`.
+            # @param [Time] date_created_after Read only recordings that started on or after
+            #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone.
+            # @param [Time] date_created_before Read only Recordings that started before this
+            #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -55,10 +59,13 @@ module Twilio
             # Streams RoomRecordingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [room_recording.Status] status The status
-            # @param [String] source_sid The source_sid
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @param [room_recording.Status] status Read only the recordings with this status.
+            #   Can be: `processing`, `completed`, or `deleted`.
+            # @param [String] source_sid Read only the recordings that have this `source_sid`.
+            # @param [Time] date_created_after Read only recordings that started on or after
+            #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone.
+            # @param [Time] date_created_before Read only Recordings that started before this
+            #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone.
             # @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
@@ -97,10 +104,13 @@ module Twilio
             ##
             # Retrieve a single page of RoomRecordingInstance records from the API.
             # Request is executed immediately.
-            # @param [room_recording.Status] status The status
-            # @param [String] source_sid The source_sid
-            # @param [Time] date_created_after The date_created_after
-            # @param [Time] date_created_before The date_created_before
+            # @param [room_recording.Status] status Read only the recordings with this status.
+            #   Can be: `processing`, `completed`, or `deleted`.
+            # @param [String] source_sid Read only the recordings that have this `source_sid`.
+            # @param [Time] date_created_after Read only recordings that started on or after
+            #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone.
+            # @param [Time] date_created_before Read only Recordings that started before this
+            #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with time zone.
             # @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
@@ -115,11 +125,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               RoomRecordingPage.new(@version, response, @solution)
             end
 
@@ -176,8 +184,9 @@ module Twilio
             ##
             # Initialize the RoomRecordingContext
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
-            # @param [String] sid The sid
+            # @param [String] room_sid The SID of the Room resource with the recording to
+            #   fetch.
+            # @param [String] sid The SID of the RoomRecording resource to fetch.
             # @return [RoomRecordingContext] RoomRecordingContext
             def initialize(version, room_sid, sid)
               super(version)
@@ -188,25 +197,19 @@ module Twilio
             end
 
             ##
-            # Fetch a RoomRecordingInstance
+            # Fetch the RoomRecordingInstance
             # @return [RoomRecordingInstance] Fetched RoomRecordingInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               RoomRecordingInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the RoomRecordingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RoomRecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -215,6 +218,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Video.V1.RoomRecordingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Video.V1.RoomRecordingContext #{context}>"
+            end
           end
 
           class RoomRecordingInstance < InstanceResource
@@ -222,8 +232,9 @@ module Twilio
             # Initialize the RoomRecordingInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] room_sid The room_sid
-            # @param [String] sid The sid
+            # @param [String] room_sid The SID of the Room resource the recording is
+            #   associated with.
+            # @param [String] sid The SID of the RoomRecording resource to fetch.
             # @return [RoomRecordingInstance] RoomRecordingInstance
             def initialize(version, payload, room_sid: nil, sid: nil)
               super(version)
@@ -265,111 +276,111 @@ module Twilio
             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 [room_recording.Status] The status
+            # @return [room_recording.Status] The status of the recording
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The source_sid
+            # @return [String] The SID of the recording source
             def source_sid
               @properties['source_sid']
             end
 
             ##
-            # @return [String] The size
+            # @return [String] The size of the recorded track in bytes
             def size
               @properties['size']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [room_recording.Type] The type
+            # @return [room_recording.Type] The recording's media type
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] The duration
+            # @return [String] The duration of the recording in seconds
             def duration
               @properties['duration']
             end
 
             ##
-            # @return [room_recording.Format] The container_format
+            # @return [room_recording.Format] The file format for the recording
             def container_format
               @properties['container_format']
             end
 
             ##
-            # @return [room_recording.Codec] The codec
+            # @return [room_recording.Codec] The codec used for the recording
             def codec
               @properties['codec']
             end
 
             ##
-            # @return [Hash] The grouping_sids
+            # @return [Hash] A list of SIDs related to the Recording
             def grouping_sids
               @properties['grouping_sids']
             end
 
             ##
-            # @return [String] The track_name
+            # @return [String] The name that was given to the source track of the recording
             def track_name
               @properties['track_name']
             end
 
             ##
-            # @return [String] The offset
+            # @return [String] The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started
             def offset
               @properties['offset']
             end
 
             ##
-            # @return [String] The room_sid
+            # @return [String] The SID of the Room resource the recording is associated with
             def room_sid
               @properties['room_sid']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a RoomRecordingInstance
+            # Fetch the RoomRecordingInstance
             # @return [RoomRecordingInstance] Fetched RoomRecordingInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the RoomRecordingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RoomRecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end