twilio-ruby 5.15.1 → 5.58.1

data/lib/twilio-ruby/rest/video/v1/composition_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 CompositionSettingsList < ListResource
           ##
           # Initialize the CompositionSettingsList
@@ -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 CompositionSettingsPage < Page
           ##
           # Initialize the CompositionSettingsPage
@@ -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 CompositionSettingsContext < InstanceContext
           ##
           # Initialize the CompositionSettingsContext
@@ -78,37 +72,32 @@ module Twilio
           end
 
           ##
-          # Fetch a CompositionSettingsInstance
+          # Fetch the CompositionSettingsInstance
           # @return [CompositionSettingsInstance] Fetched CompositionSettingsInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CompositionSettingsInstance.new(@version, payload, )
           end
 
           ##
-          # Retrieve a single page of CompositionSettingsInstance 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
-          #   compositions should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`,  where
-          #   `compositions` is the path where you want compositions to be stored.
-          # @param [Boolean] aws_storage_enabled `true|false` When set to `true`, all
-          #   Compositions will be written to the `AwsS3Url` specified above. When set to
-          #   `false`, all Compositions will be stored in Twilio's cloud.
-          # @param [Boolean] encryption_enabled `true|false` When set to `true`, all
-          #   Compositions will be stored encrypted. Dafault value is `false`
-          # @return [CompositionSettingsInstance] Newly created CompositionSettingsInstance
+          # Create the CompositionSettingsInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource and show to the user 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 compositions
+          #   should be stored. We only support DNS-compliant URLs like
+          #   `https://documentation-example-twilio-bucket/compositions`, where `compositions`
+          #   is the path in which you want the compositions 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 compositions should be written
+          #   to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
+          # @param [Boolean] encryption_enabled Whether all compositions should be stored in
+          #   an encrypted form. The default is `false`.
+          # @return [CompositionSettingsInstance] Created CompositionSettingsInstance
           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)
 
             CompositionSettingsInstance.new(@version, payload, )
           end
@@ -134,10 +119,15 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Video.V1.CompositionSettingsContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Video.V1.CompositionSettingsContext #{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 CompositionSettingsInstance < InstanceResource
           ##
           # Initialize the CompositionSettingsInstance
@@ -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 compositions should be stored. We only support DNS-compliant URLs like http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions, where compositions is the path where you want compositions to be stored.
+          # @return [String] The URL of the AWS S3 bucket where the compositions are stored
           def aws_s3_url
             @properties['aws_s3_url']
           end
 
           ##
-          # @return [Boolean] true|false When set to true, all Compositions will be written to the AwsS3Url specified above. When set to false, all Compositions will be stored in Twilio's cloud.
+          # @return [Boolean] Whether all compositions 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 Compositions will be stored encrypted.
+          # @return [Boolean] Whether all compositions 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 CompositionSettingsInstance
+          # Fetch the CompositionSettingsInstance
           # @return [CompositionSettingsInstance] Fetched CompositionSettingsInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Retrieve a single page of CompositionSettingsInstance 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
-          #   compositions should be stored. We only support DNS-compliant URLs like
-          #   `http://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`,  where
-          #   `compositions` is the path where you want compositions to be stored.
-          # @param [Boolean] aws_storage_enabled `true|false` When set to `true`, all
-          #   Compositions will be written to the `AwsS3Url` specified above. When set to
-          #   `false`, all Compositions will be stored in Twilio's cloud.
-          # @param [Boolean] encryption_enabled `true|false` When set to `true`, all
-          #   Compositions will be stored encrypted. Dafault value is `false`
-          # @return [CompositionSettingsInstance] Newly created CompositionSettingsInstance
+          # Create the CompositionSettingsInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource and show to the user 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 compositions
+          #   should be stored. We only support DNS-compliant URLs like
+          #   `https://documentation-example-twilio-bucket/compositions`, where `compositions`
+          #   is the path in which you want the compositions 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 compositions should be written
+          #   to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
+          # @param [Boolean] encryption_enabled Whether all compositions should be stored in
+          #   an encrypted form. The default is `false`.
+          # @return [CompositionSettingsInstance] Created CompositionSettingsInstance
           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/recording.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -27,15 +27,19 @@ 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 [recording.Status] status Only show Recordings with the given status.
-          # @param [String] source_sid Only show the Recordings with the given source Sid
-          #   (you can use this to filter Recordings by `TrackSid` for Video Room Recordings.
-          # @param [String] grouping_sid Only show Recordings that have this GroupingSid,
-          #   which may include a ParticipantSid and/or a RoomSid.
-          # @param [Time] date_created_after Only show Recordings that started on or after
-          #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
-          # @param [Time] date_created_before Only show Recordings that started before this
-          #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+          # @param [recording.Status] status Read only the recordings that have this status.
+          #   Can be: `processing`, `completed`, or `deleted`.
+          # @param [String] source_sid Read only the recordings that have this `source_sid`.
+          # @param [Array[String]] grouping_sid Read only recordings with this
+          #   `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
+          # @param [Time] date_created_after Read only recordings that started on or after
+          #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
+          #   zone.
+          # @param [Time] date_created_before Read only recordings that started before this
+          #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time zone,
+          #   given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.
+          # @param [recording.Type] media_type Read only recordings that have this media
+          #   type. Can be either `audio` or `video`.
           # @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
@@ -43,13 +47,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(status: :unset, source_sid: :unset, grouping_sid: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
+          def list(status: :unset, source_sid: :unset, grouping_sid: :unset, date_created_after: :unset, date_created_before: :unset, media_type: :unset, limit: nil, page_size: nil)
             self.stream(
                 status: status,
                 source_sid: source_sid,
                 grouping_sid: grouping_sid,
                 date_created_after: date_created_after,
                 date_created_before: date_created_before,
+                media_type: media_type,
                 limit: limit,
                 page_size: page_size
             ).entries
@@ -59,15 +64,19 @@ 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 [recording.Status] status Only show Recordings with the given status.
-          # @param [String] source_sid Only show the Recordings with the given source Sid
-          #   (you can use this to filter Recordings by `TrackSid` for Video Room Recordings.
-          # @param [String] grouping_sid Only show Recordings that have this GroupingSid,
-          #   which may include a ParticipantSid and/or a RoomSid.
-          # @param [Time] date_created_after Only show Recordings that started on or after
-          #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
-          # @param [Time] date_created_before Only show Recordings that started before this
-          #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+          # @param [recording.Status] status Read only the recordings that have this status.
+          #   Can be: `processing`, `completed`, or `deleted`.
+          # @param [String] source_sid Read only the recordings that have this `source_sid`.
+          # @param [Array[String]] grouping_sid Read only recordings with this
+          #   `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
+          # @param [Time] date_created_after Read only recordings that started on or after
+          #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
+          #   zone.
+          # @param [Time] date_created_before Read only recordings that started before this
+          #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time zone,
+          #   given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.
+          # @param [recording.Type] media_type Read only recordings that have this media
+          #   type. Can be either `audio` or `video`.
           # @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(status: :unset, source_sid: :unset, grouping_sid: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
+          def stream(status: :unset, source_sid: :unset, grouping_sid: :unset, date_created_after: :unset, date_created_before: :unset, media_type: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
             page = self.page(
@@ -84,6 +93,7 @@ module Twilio
                 grouping_sid: grouping_sid,
                 date_created_after: date_created_after,
                 date_created_before: date_created_before,
+                media_type: media_type,
                 page_size: limits[:page_size],
             )
 
@@ -107,35 +117,38 @@ module Twilio
           ##
           # Retrieve a single page of RecordingInstance records from the API.
           # Request is executed immediately.
-          # @param [recording.Status] status Only show Recordings with the given status.
-          # @param [String] source_sid Only show the Recordings with the given source Sid
-          #   (you can use this to filter Recordings by `TrackSid` for Video Room Recordings.
-          # @param [String] grouping_sid Only show Recordings that have this GroupingSid,
-          #   which may include a ParticipantSid and/or a RoomSid.
-          # @param [Time] date_created_after Only show Recordings that started on or after
-          #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
-          # @param [Time] date_created_before Only show Recordings that started before this
-          #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+          # @param [recording.Status] status Read only the recordings that have this status.
+          #   Can be: `processing`, `completed`, or `deleted`.
+          # @param [String] source_sid Read only the recordings that have this `source_sid`.
+          # @param [Array[String]] grouping_sid Read only recordings with this
+          #   `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
+          # @param [Time] date_created_after Read only recordings that started on or after
+          #   this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
+          #   zone.
+          # @param [Time] date_created_before Read only recordings that started before this
+          #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time zone,
+          #   given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.
+          # @param [recording.Type] media_type Read only recordings that have this media
+          #   type. Can be either `audio` or `video`.
           # @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(status: :unset, source_sid: :unset, grouping_sid: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+          def page(status: :unset, source_sid: :unset, grouping_sid: :unset, date_created_after: :unset, date_created_before: :unset, media_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
                 'Status' => status,
                 'SourceSid' => source_sid,
                 'GroupingSid' => Twilio.serialize_list(grouping_sid) { |e| e },
                 'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
                 'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
+                'MediaType' => media_type,
                 '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
 
@@ -192,8 +205,7 @@ module Twilio
           ##
           # Initialize the RecordingContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The Recording Sid that uniquely identifies the Recording to
-          #   fetch.
+          # @param [String] sid The SID of the Recording resource to fetch.
           # @return [RecordingContext] RecordingContext
           def initialize(version, sid)
             super(version)
@@ -204,25 +216,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, 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
 
           ##
@@ -231,6 +237,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Video.V1.RecordingContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Video.V1.RecordingContext #{context}>"
+          end
         end
 
         class RecordingInstance < InstanceResource
@@ -238,8 +251,7 @@ module Twilio
           # Initialize the RecordingInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The Recording Sid that uniquely identifies the Recording to
-          #   fetch.
+          # @param [String] sid The SID of the Recording resource to fetch.
           # @return [RecordingInstance] RecordingInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -280,105 +292,105 @@ module Twilio
           end
 
           ##
-          # @return [String] Twilio Account SID.
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [recording.Status] The status of the Recording.
+          # @return [recording.Status] The status of the recording
           def status
             @properties['status']
           end
 
           ##
-          # @return [Time] Date when the media recording began writing.
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [String] A 34-character string that uniquely identifies this Recording.
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] A 34-character string that uniquely identifies the source of this Recording.
+          # @return [String] The SID of the recording source
           def source_sid
             @properties['source_sid']
           end
 
           ##
-          # @return [String] Size of the recorded track, in bytes.
+          # @return [String] The size of the recorded track, in bytes
           def size
             @properties['size']
           end
 
           ##
-          # @return [String] The absolute URL for this resource.
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [recording.Type] Indicates the media type for this recording.
+          # @return [recording.Type] The recording's media type
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] Duration of the Recording in seconds.
+          # @return [String] The duration of the recording in seconds
           def duration
             @properties['duration']
           end
 
           ##
-          # @return [recording.Format] The file format for this Recording.
+          # @return [recording.Format] The file format for the recording
           def container_format
             @properties['container_format']
           end
 
           ##
-          # @return [recording.Codec] The codec used to encode the track.
+          # @return [recording.Codec] The codec used to encode the track
           def codec
             @properties['codec']
           end
 
           ##
-          # @return [Hash] A list of Sids related to this Recording.
+          # @return [Hash] A list of SIDs related to the recording
           def grouping_sids
             @properties['grouping_sids']
           end
 
           ##
-          # @return [String] The name that was given to the source track of this recording.
+          # @return [String] The name that was given to the source track of the recording
           def track_name
             @properties['track_name']
           end
 
           ##
-          # @return [String] Offset in miliseconds for this track.
+          # @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 links
+          # @return [String] The URLs of related resources
           def links
             @properties['links']
           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