twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class Video < VideoBase
             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 = {  }
                         
@@ -46,6 +48,7 @@ module Twilio
                     # @return [CompositionSettingsContext] CompositionSettingsContext
                     def initialize(version)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = {  }
@@ -58,17 +61,17 @@ module Twilio
                     # @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 [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 [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
                     # @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
+                      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({
@@ -80,25 +83,107 @@ module Twilio
                             'EncryptionEnabled' => encryption_enabled,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         CompositionSettingsInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the CompositionSettingsInstanceMetadata
+                    # @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 [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
+                    # @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_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)
+                        composition_settings_instance = CompositionSettingsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        CompositionSettingsInstanceMetadata.new(
+                            @version,
+                            composition_settings_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Fetch the CompositionSettingsInstance
                     # @return [CompositionSettingsInstance] Fetched CompositionSettingsInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         CompositionSettingsInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Fetch the CompositionSettingsInstanceMetadata
+                    # @return [CompositionSettingsInstance] Fetched CompositionSettingsInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        composition_settings_instance = CompositionSettingsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        CompositionSettingsInstanceMetadata.new(
+                            @version,
+                            composition_settings_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -115,6 +200,53 @@ module Twilio
                     end
                 end
 
+                class CompositionSettingsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new CompositionSettingsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}CompositionSettingsInstance] composition_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 [CompositionSettingsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, composition_settings_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @composition_settings_instance = composition_settings_instance
+                    end
+
+                    def composition_settings
+                        @composition_settings_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.CompositionSettingsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class CompositionSettingsListResponse < InstanceListResource
+                    # @param [Array<CompositionSettingsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @composition_settings_instance = payload.body[key].map do |data|
+                        CompositionSettingsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def composition_settings_instance
+                          @instance
+                      end
+                  end
+
                 class CompositionSettingsPage < Page
                     ##
                     # Initialize the CompositionSettingsPage
@@ -124,6 +256,7 @@ module Twilio
                     # @return [CompositionSettingsPage] CompositionSettingsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -143,6 +276,66 @@ module Twilio
                         '<Twilio.Video.V1.CompositionSettingsPage>'
                     end
                 end
+
+                class CompositionSettingsPageMetadata < PageMetadata
+                    attr_reader :composition_settings_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @composition_settings_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @composition_settings_page << CompositionSettingsListResponse.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
+                        @composition_settings_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Video::V1PageMetadata>';
+                    end
+                end
+                class CompositionSettingsListResponse < InstanceListResource
+
+                    # @param [Array<CompositionSettingsInstance>] 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
+                      @composition_settings = data_list.map do |data|
+                        CompositionSettingsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def composition_settings
+                        @composition_settings
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class CompositionSettingsInstance < InstanceResource
                     ##
                     # Initialize the CompositionSettingsInstance
@@ -156,6 +349,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -203,7 +397,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The URL of the AWS S3 bucket where the compositions are 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>.
+                    # @return [String] The URL of the AWS S3 bucket where the compositions are 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 [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
                     def aws_s3_url
                         @properties['aws_s3_url']
                     end
@@ -237,17 +431,17 @@ module Twilio
                     # @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 [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 [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
                     # @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
+                      friendly_name: nil, 
+                      aws_credentials_sid: :unset, 
+                      encryption_key_sid: :unset, 
+                      aws_s3_url: :unset, 
+                      aws_storage_enabled: :unset, 
+                      encryption_enabled: :unset
                     )
 
                         context.create(

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

@@ -18,12 +18,14 @@ module Twilio
         class Video < VideoBase
             class V1 < Version
                 class RecordingList < ListResource
+                
                     ##
                     # Initialize the RecordingList
                     # @param [Version] version Version that contains the resource
                     # @return [RecordingList] RecordingList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Recordings"
@@ -89,7 +91,46 @@ module Twilio
                             media_type: media_type,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    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
 
                     ##
@@ -101,9 +142,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -119,7 +164,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,
@@ -132,8 +177,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         RecordingPage.new(@version, response, @solution)
                     end
@@ -168,6 +216,7 @@ module Twilio
                     # @return [RecordingContext] RecordingContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -180,7 +229,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @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
 
                     ##
@@ -188,7 +261,13 @@ module Twilio
                     # @return [RecordingInstance] Fetched RecordingInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         RecordingInstance.new(
                             @version,
                             payload,
@@ -196,6 +275,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
@@ -212,6 +316,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
@@ -221,6 +372,7 @@ module Twilio
                     # @return [RecordingPage] RecordingPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -240,6 +392,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
@@ -253,6 +465,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],