twilio-ruby 7.9.1 → 7.10.0

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [RecordingList] RecordingList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Recordings"
@@ -93,6 +94,41 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists RecordingPageMetadata records from the API as a list.
+                      # @param [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 [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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    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_with_metadata(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)
+                        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,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RecordingPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields RecordingInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -120,7 +156,7 @@ module Twilio
                     # @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, media_type: :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,
@@ -172,6 +208,7 @@ module Twilio
                     # @return [RecordingContext] RecordingContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -188,9 +225,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the RecordingInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          recording_instance = RecordingInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          RecordingInstanceMetadata.new(@version, recording_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the RecordingInstance
                     # @return [RecordingInstance] Fetched RecordingInstance
@@ -210,6 +267,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RecordingInstanceMetadata
+                    # @return [RecordingInstance] Fetched RecordingInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        recording_instance = RecordingInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        RecordingInstanceMetadata.new(
+                            @version,
+                            recording_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -226,6 +308,53 @@ module Twilio
                     end
                 end
 
+                class RecordingInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new RecordingInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}RecordingInstance] recording_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [RecordingInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, recording_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @recording_instance = recording_instance
+                    end
+
+                    def recording
+                        @recording_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.RecordingInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class RecordingListResponse < InstanceListResource
+                    # @param [Array<RecordingInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @recording_instance = payload.body[key].map do |data|
+                        RecordingInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def recording_instance
+                          @instance
+                      end
+                  end
+
                 class RecordingPage < Page
                     ##
                     # Initialize the RecordingPage
@@ -235,6 +364,7 @@ module Twilio
                     # @return [RecordingPage] RecordingPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -254,6 +384,66 @@ module Twilio
                         '<Twilio.Video.V1.RecordingPage>'
                     end
                 end
+
+                class RecordingPageMetadata < PageMetadata
+                    attr_reader :recording_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @recording_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @recording_page << RecordingListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @recording_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Video::V1PageMetadata>';
+                    end
+                end
+                class RecordingListResponse < InstanceListResource
+
+                    # @param [Array<RecordingInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @recording = data_list.map do |data|
+                        RecordingInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def recording
+                        @recording
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RecordingInstance < InstanceResource
                     ##
                     # Initialize the RecordingInstance
@@ -267,6 +457,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [RecordingSettingsList] RecordingSettingsList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -47,6 +48,7 @@ module Twilio
                     # @return [RecordingSettingsContext] RecordingSettingsContext
                     def initialize(version)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = {  }
@@ -94,6 +96,52 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the RecordingSettingsInstanceMetadata
+                    # @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 [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
+                    # @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_with_metadata(
+                      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,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        recording_settings_instance = RecordingSettingsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        RecordingSettingsInstanceMetadata.new(
+                            @version,
+                            recording_settings_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Fetch the RecordingSettingsInstance
                     # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
@@ -112,6 +160,30 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RecordingSettingsInstanceMetadata
+                    # @return [RecordingSettingsInstance] Fetched RecordingSettingsInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        recording_settings_instance = RecordingSettingsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        RecordingSettingsInstanceMetadata.new(
+                            @version,
+                            recording_settings_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -128,6 +200,53 @@ module Twilio
                     end
                 end
 
+                class RecordingSettingsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new RecordingSettingsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}RecordingSettingsInstance] recording_settings_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [RecordingSettingsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, recording_settings_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @recording_settings_instance = recording_settings_instance
+                    end
+
+                    def recording_settings
+                        @recording_settings_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.RecordingSettingsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class RecordingSettingsListResponse < InstanceListResource
+                    # @param [Array<RecordingSettingsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @recording_settings_instance = payload.body[key].map do |data|
+                        RecordingSettingsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def recording_settings_instance
+                          @instance
+                      end
+                  end
+
                 class RecordingSettingsPage < Page
                     ##
                     # Initialize the RecordingSettingsPage
@@ -137,6 +256,7 @@ module Twilio
                     # @return [RecordingSettingsPage] RecordingSettingsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -156,6 +276,66 @@ module Twilio
                         '<Twilio.Video.V1.RecordingSettingsPage>'
                     end
                 end
+
+                class RecordingSettingsPageMetadata < PageMetadata
+                    attr_reader :recording_settings_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @recording_settings_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @recording_settings_page << RecordingSettingsListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @recording_settings_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Video::V1PageMetadata>';
+                    end
+                end
+                class RecordingSettingsListResponse < InstanceListResource
+
+                    # @param [Array<RecordingSettingsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @recording_settings = data_list.map do |data|
+                        RecordingSettingsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def recording_settings
+                        @recording_settings
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RecordingSettingsInstance < InstanceResource
                     ##
                     # Initialize the RecordingSettingsInstance
@@ -169,6 +349,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [AnonymizeList] AnonymizeList
                     def initialize(version, room_sid: nil, sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { room_sid: room_sid, sid: sid }
                         
@@ -52,6 +53,7 @@ module Twilio
                     # @return [AnonymizeContext] AnonymizeContext
                     def initialize(version, room_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { room_sid: room_sid, sid: sid,  }
@@ -79,6 +81,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the AnonymizeInstanceMetadata
+                    # @return [AnonymizeInstance] Updated AnonymizeInstance
+                    def update_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, headers: headers)
+                        anonymize_instance = AnonymizeInstance.new(
+                            @version,
+                            response.body,
+                            room_sid: @solution[:room_sid],
+                            sid: @solution[:sid],
+                        )
+                        AnonymizeInstanceMetadata.new(
+                            @version,
+                            anonymize_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -95,6 +123,53 @@ module Twilio
                     end
                 end
 
+                class AnonymizeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new AnonymizeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}AnonymizeInstance] anonymize_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [AnonymizeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, anonymize_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @anonymize_instance = anonymize_instance
+                    end
+
+                    def anonymize
+                        @anonymize_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.AnonymizeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class AnonymizeListResponse < InstanceListResource
+                    # @param [Array<AnonymizeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @anonymize_instance = payload.body[key].map do |data|
+                        AnonymizeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def anonymize_instance
+                          @instance
+                      end
+                  end
+
                 class AnonymizePage < Page
                     ##
                     # Initialize the AnonymizePage
@@ -104,6 +179,7 @@ module Twilio
                     # @return [AnonymizePage] AnonymizePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -123,6 +199,66 @@ module Twilio
                         '<Twilio.Video.V1.AnonymizePage>'
                     end
                 end
+
+                class AnonymizePageMetadata < PageMetadata
+                    attr_reader :anonymize_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @anonymize_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @anonymize_page << AnonymizeListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @anonymize_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Video::V1PageMetadata>';
+                    end
+                end
+                class AnonymizeListResponse < InstanceListResource
+
+                    # @param [Array<AnonymizeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @anonymize = data_list.map do |data|
+                        AnonymizeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def anonymize
+                        @anonymize
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class AnonymizeInstance < InstanceResource
                     ##
                     # Initialize the AnonymizeInstance
@@ -136,6 +272,7 @@ module Twilio
                     def initialize(version, payload , room_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],