twilio-ruby 5.5.1 → 5.58.3

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

@@ -0,0 +1,269 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Video < Domain
+      class V1 < Version
+        class CompositionSettingsList < ListResource
+          ##
+          # Initialize the CompositionSettingsList
+          # @param [Version] version Version that contains the resource
+          # @return [CompositionSettingsList] CompositionSettingsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Video.V1.CompositionSettingsList>'
+          end
+        end
+
+        class CompositionSettingsPage < Page
+          ##
+          # Initialize the CompositionSettingsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [CompositionSettingsPage] CompositionSettingsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of CompositionSettingsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [CompositionSettingsInstance] CompositionSettingsInstance
+          def get_instance(payload)
+            CompositionSettingsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Video.V1.CompositionSettingsPage>'
+          end
+        end
+
+        class CompositionSettingsContext < InstanceContext
+          ##
+          # Initialize the CompositionSettingsContext
+          # @param [Version] version Version that contains the resource
+          # @return [CompositionSettingsContext] CompositionSettingsContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/CompositionSettings/Default"
+          end
+
+          ##
+          # Fetch the CompositionSettingsInstance
+          # @return [CompositionSettingsInstance] Fetched CompositionSettingsInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            CompositionSettingsInstance.new(@version, payload, )
+          end
+
+          ##
+          # 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,
+                'AwsCredentialsSid' => aws_credentials_sid,
+                'EncryptionKeySid' => encryption_key_sid,
+                'AwsS3Url' => aws_s3_url,
+                'AwsStorageEnabled' => aws_storage_enabled,
+                'EncryptionEnabled' => encryption_enabled,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            CompositionSettingsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            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
+
+        class CompositionSettingsInstance < InstanceResource
+          ##
+          # Initialize the CompositionSettingsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [CompositionSettingsInstance] CompositionSettingsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'aws_credentials_sid' => payload['aws_credentials_sid'],
+                'aws_s3_url' => payload['aws_s3_url'],
+                'aws_storage_enabled' => payload['aws_storage_enabled'],
+                'encryption_key_sid' => payload['encryption_key_sid'],
+                'encryption_enabled' => payload['encryption_enabled'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [CompositionSettingsContext] CompositionSettingsContext for this CompositionSettingsInstance
+          def context
+            unless @instance_context
+              @instance_context = CompositionSettingsContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the resource
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] The SID of the stored Credential resource
+          def aws_credentials_sid
+            @properties['aws_credentials_sid']
+          end
+
+          ##
+          # @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] Whether all compositions are written to the aws_s3_url
+          def aws_storage_enabled
+            @properties['aws_storage_enabled']
+          end
+
+          ##
+          # @return [String] The SID of the Public Key resource used for encryption
+          def encryption_key_sid
+            @properties['encryption_key_sid']
+          end
+
+          ##
+          # @return [Boolean] Whether all compositions are stored in an encrypted form
+          def encryption_enabled
+            @properties['encryption_enabled']
+          end
+
+          ##
+          # @return [String] The absolute URL of the resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the CompositionSettingsInstance
+          # @return [CompositionSettingsInstance] Fetched CompositionSettingsInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # 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,
+                aws_credentials_sid: aws_credentials_sid,
+                encryption_key_sid: encryption_key_sid,
+                aws_s3_url: aws_s3_url,
+                aws_storage_enabled: aws_storage_enabled,
+                encryption_enabled: encryption_enabled,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Video.V1.CompositionSettingsInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Video.V1.CompositionSettingsInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -25,11 +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 The status
-          # @param [String] source_sid The source_sid
-          # @param [String] grouping_sid The grouping_sid
-          # @param [Time] date_created_after The date_created_after
-          # @param [Time] date_created_before The date_created_before
+          # @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
@@ -37,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
@@ -53,11 +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 The status
-          # @param [String] source_sid The source_sid
-          # @param [String] grouping_sid The grouping_sid
-          # @param [Time] date_created_after The date_created_after
-          # @param [Time] date_created_before The date_created_before
+          # @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
@@ -65,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(
@@ -74,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],
             )
 
@@ -87,7 +107,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -97,31 +117,38 @@ module Twilio
           ##
           # Retrieve a single page of RecordingInstance records from the API.
           # Request is executed immediately.
-          # @param [recording.Status] status The status
-          # @param [String] source_sid The source_sid
-          # @param [String] grouping_sid The grouping_sid
-          # @param [Time] date_created_after The date_created_after
-          # @param [Time] date_created_before The date_created_before
+          # @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
 
@@ -164,7 +191,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [RecordingInstance] RecordingInstance
           def get_instance(payload)
-            RecordingInstance.new(@version, payload)
+            RecordingInstance.new(@version, payload, )
           end
 
           ##
@@ -178,36 +205,30 @@ module Twilio
           ##
           # Initialize the RecordingContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Recording resource to fetch.
           # @return [RecordingContext] RecordingContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Recordings/#{@solution[:sid]}"
           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])
+            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
 
           ##
@@ -216,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
@@ -223,7 +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 sid
+          # @param [String] sid The SID of the Recording resource to fetch.
           # @return [RecordingInstance] RecordingInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -235,19 +263,21 @@ module Twilio
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'sid' => payload['sid'],
                 'source_sid' => payload['source_sid'],
-                'size' => payload['size'] == nil ? payload['size'] : payload['size'].to_i,
+                'size' => payload['size'].to_i,
                 'url' => payload['url'],
                 'type' => payload['type'],
                 'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
                 'container_format' => payload['container_format'],
                 'codec' => payload['codec'],
                 'grouping_sids' => payload['grouping_sids'],
+                'track_name' => payload['track_name'],
+                'offset' => payload['offset'].to_i,
                 'links' => payload['links'],
             }
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -256,99 +286,111 @@ module Twilio
           # @return [RecordingContext] RecordingContext for this RecordingInstance
           def context
             unless @instance_context
-              @instance_context = RecordingContext.new(@version, @params['sid'])
+              @instance_context = RecordingContext.new(@version, @params['sid'], )
             end
             @instance_context
           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 [recording.Status] The status
+          # @return [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 [recording.Type] The type
+          # @return [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 [recording.Format] The container_format
+          # @return [recording.Format] The file format for the recording
           def container_format
             @properties['container_format']
           end
 
           ##
-          # @return [recording.Codec] The codec
+          # @return [recording.Codec] The codec used to encode the track
           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 links
+          # @return [String] The name that was given to the source track of the recording
+          def track_name
+            @properties['track_name']
+          end
+
+          ##
+          # @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 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