twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/video/v1/recording_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 RecordingSettingsList < ListResource
+          ##
+          # Initialize the RecordingSettingsList
+          # @param [Version] version Version that contains the resource
+          # @return [RecordingSettingsList] RecordingSettingsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Video.V1.RecordingSettingsList>'
+          end
+        end
+
+        class RecordingSettingsPage < Page
+          ##
+          # Initialize the RecordingSettingsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [RecordingSettingsPage] RecordingSettingsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of RecordingSettingsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [RecordingSettingsInstance] RecordingSettingsInstance
+          def get_instance(payload)
+            RecordingSettingsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Video.V1.RecordingSettingsPage>'
+          end
+        end
+
+        class RecordingSettingsContext < InstanceContext
+          ##
+          # Initialize the RecordingSettingsContext
+          # @param [Version] version Version that contains the resource
+          # @return [RecordingSettingsContext] RecordingSettingsContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/RecordingSettings/Default"
+          end
+
+          ##
+          # Fetch the RecordingSettingsInstance
+          # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            RecordingSettingsInstance.new(@version, payload, )
+          end
+
+          ##
+          # 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,
+                '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)
+
+            RecordingSettingsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            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
+
+        class RecordingSettingsInstance < InstanceResource
+          ##
+          # Initialize the RecordingSettingsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [RecordingSettingsInstance] RecordingSettingsInstance
+          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 [RecordingSettingsContext] RecordingSettingsContext for this RecordingSettingsInstance
+          def context
+            unless @instance_context
+              @instance_context = RecordingSettingsContext.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 recordings are stored
+          def aws_s3_url
+            @properties['aws_s3_url']
+          end
+
+          ##
+          # @return [Boolean] Whether all recordings 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 recordings 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 RecordingSettingsInstance
+          # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # 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,
+                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.RecordingSettingsInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Video.V1.RecordingSettingsInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,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)
@@ -27,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
@@ -53,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
@@ -85,7 +94,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],
@@ -95,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
@@ -113,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
 
@@ -160,7 +170,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [RoomRecordingInstance] RoomRecordingInstance
             def get_instance(payload)
-              RoomRecordingInstance.new(@version, payload, room_sid: @solution[:room_sid])
+              RoomRecordingInstance.new(@version, payload, room_sid: @solution[:room_sid], )
             end
 
             ##
@@ -174,30 +184,32 @@ 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)
 
               # Path Solution
-              @solution = {room_sid: room_sid, sid: sid}
+              @solution = {room_sid: room_sid, sid: sid, }
               @uri = "/Rooms/#{@solution[:room_sid]}/Recordings/#{@solution[:sid]}"
             end
 
             ##
-            # Fetch a RoomRecordingInstance
+            # Fetch the RoomRecordingInstance
             # @return [RoomRecordingInstance] Fetched RoomRecordingInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              RoomRecordingInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid], )
+            end
 
-              RoomRecordingInstance.new(@version, payload, room_sid: @solution[:room_sid], sid: @solution[:sid])
+            ##
+            # Delete the RoomRecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -206,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
@@ -213,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)
@@ -226,20 +246,22 @@ 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,
                   'room_sid' => payload['room_sid'],
-                  'url' => payload['url'],
                   'links' => payload['links'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'room_sid' => room_sid, 'sid' => sid || @properties['sid']}
+              @params = {'room_sid' => room_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -248,102 +270,121 @@ module Twilio
             # @return [RoomRecordingContext] RoomRecordingContext for this RoomRecordingInstance
             def context
               unless @instance_context
-                @instance_context = RoomRecordingContext.new(@version, @params['room_sid'], @params['sid'])
+                @instance_context = RoomRecordingContext.new(@version, @params['room_sid'], @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 [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 [room_recording.Type] The type
+            # @return [String] The absolute URL of the resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # @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 room_sid
-            def room_sid
-              @properties['room_sid']
+            # @return [String] The name that was given to the source track of the recording
+            def track_name
+              @properties['track_name']
             end
 
             ##
-            # @return [String] The url
-            def url
-              @properties['url']
+            # @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 SID of the Room resource the recording is associated with
+            def room_sid
+              @properties['room_sid']
+            end
+
+            ##
+            # @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
 
+            ##
+            # Delete the RoomRecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
             ##
             # Provide a user friendly representation
             def to_s