twilio-ruby 6.12.1 → 7.0.0

data/lib/twilio-ruby/rest/media/v1/media_recording.rb

@@ -1,407 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Twilio - Media
-#    This is the public Twilio REST API.
-#
-#    NOTE: This class is auto generated by OpenAPI Generator.
-#    https://openapi-generator.tech
-#    Do not edit the class manually.
-#
-
-
-module Twilio
-    module REST
-        class Media < MediaBase
-            class V1 < Version
-                class MediaRecordingList < ListResource
-                
-                    ##
-                    # Initialize the MediaRecordingList
-                    # @param [Version] version Version that contains the resource
-                    # @return [MediaRecordingList] MediaRecordingList
-                    def initialize(version)
-                        super(version)
-                        # Path Solution
-                        @solution = {  }
-                        @uri = "/MediaRecordings"
-                        
-                    end
-                
-                    ##
-                    # Lists MediaRecordingInstance records from the API as a list.
-                    # Unlike stream(), this operation is eager and will load `limit` records into
-                    # memory before returning.
-                    # @param [Order] order The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.
-                    # @param [Status] status Status to filter by, with possible values `processing`, `completed`, `deleted`, or `failed`.
-                    # @param [String] processor_sid SID of a MediaProcessor to filter by.
-                    # @param [String] source_sid SID of a MediaRecording source to filter by.
-                    # @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(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil)
-                        self.stream(
-                            order: order,
-                            status: status,
-                            processor_sid: processor_sid,
-                            source_sid: source_sid,
-                            limit: limit,
-                            page_size: page_size
-                        ).entries
-                    end
-
-                    ##
-                    # Streams Instance records from the API as an Enumerable.
-                    # This operation lazily loads records as efficiently as possible until the limit
-                    # is reached.
-                    # @param [Order] order The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.
-                    # @param [Status] status Status to filter by, with possible values `processing`, `completed`, `deleted`, or `failed`.
-                    # @param [String] processor_sid SID of a MediaProcessor to filter by.
-                    # @param [String] source_sid SID of a MediaRecording source to filter by.
-                    # @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 [Enumerable] Enumerable that will yield up to limit results
-                    def stream(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil)
-                        limits = @version.read_limits(limit, page_size)
-
-                        page = self.page(
-                            order: order,
-                            status: status,
-                            processor_sid: processor_sid,
-                            source_sid: source_sid,
-                            page_size: limits[:page_size], )
-
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-                    end
-
-                    ##
-                    # When passed a block, yields MediaRecordingInstance records from the API.
-                    # This operation lazily loads records as efficiently as possible until the limit
-                    # is reached.
-                    def each
-                        limits = @version.read_limits
-
-                        page = self.page(page_size: limits[:page_size], )
-
-                        @version.stream(page,
-                            limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
-                    end
-
-                    ##
-                    # Retrieve a single page of MediaRecordingInstance records from the API.
-                    # Request is executed immediately.
-                    # @param [Order] order The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.
-                    # @param [Status] status Status to filter by, with possible values `processing`, `completed`, `deleted`, or `failed`.
-                    # @param [String] processor_sid SID of a MediaProcessor to filter by.
-                    # @param [String] source_sid SID of a MediaRecording source to filter by.
-                    # @param [String] page_token PageToken provided by the API
-                    # @param [Integer] page_number Page Number, this value is simply for client state
-                    # @param [Integer] page_size Number of records to return, defaults to 50
-                    # @return [Page] Page of MediaRecordingInstance
-                    def page(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
-                        params = Twilio::Values.of({
-                            'Order' => order,
-                            'Status' => status,
-                            'ProcessorSid' => processor_sid,
-                            'SourceSid' => source_sid,
-                            'PageToken' => page_token,
-                            'Page' => page_number,
-                            'PageSize' => page_size,
-                        })
-
-                        response = @version.page('GET', @uri, params: params)
-
-                        MediaRecordingPage.new(@version, response, @solution)
-                    end
-
-                    ##
-                    # Retrieve a single page of MediaRecordingInstance records from the API.
-                    # Request is executed immediately.
-                    # @param [String] target_url API-generated URL for the requested results page
-                    # @return [Page] Page of MediaRecordingInstance
-                    def get_page(target_url)
-                        response = @version.domain.request(
-                            'GET',
-                            target_url
-                        )
-                    MediaRecordingPage.new(@version, response, @solution)
-                    end
-                    
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.Media.V1.MediaRecordingList>'
-                    end
-                end
-
-
-                ##
-                #PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-                class MediaRecordingContext < InstanceContext
-                    ##
-                    # Initialize the MediaRecordingContext
-                    # @param [Version] version Version that contains the resource
-                    # @param [String] sid The SID of the MediaRecording resource to fetch.
-                    # @return [MediaRecordingContext] MediaRecordingContext
-                    def initialize(version, sid)
-                        super(version)
-
-                        # Path Solution
-                        @solution = { sid: sid,  }
-                        @uri = "/MediaRecordings/#{@solution[:sid]}"
-
-                        
-                    end
-                    ##
-                    # Delete the MediaRecordingInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
-
-                        
-                        @version.delete('DELETE', @uri)
-                    end
-
-                    ##
-                    # Fetch the MediaRecordingInstance
-                    # @return [MediaRecordingInstance] Fetched MediaRecordingInstance
-                    def fetch
-
-                        
-                        payload = @version.fetch('GET', @uri)
-                        MediaRecordingInstance.new(
-                            @version,
-                            payload,
-                            sid: @solution[:sid],
-                        )
-                    end
-
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Media.V1.MediaRecordingContext #{context}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Media.V1.MediaRecordingContext #{context}>"
-                    end
-                end
-
-                class MediaRecordingPage < Page
-                    ##
-                    # Initialize the MediaRecordingPage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [MediaRecordingPage] MediaRecordingPage
-                    def initialize(version, response, solution)
-                        super(version, response)
-
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    ##
-                    # Build an instance of MediaRecordingInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [MediaRecordingInstance] MediaRecordingInstance
-                    def get_instance(payload)
-                        MediaRecordingInstance.new(@version, payload)
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        '<Twilio.Media.V1.MediaRecordingPage>'
-                    end
-                end
-                class MediaRecordingInstance < InstanceResource
-                    ##
-                    # Initialize the MediaRecordingInstance
-                    # @param [Version] version Version that contains the resource
-                    # @param [Hash] payload payload that contains response from Twilio
-                    # @param [String] account_sid The SID of the
-                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this MediaRecording
-                    #   resource.
-                    # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [MediaRecordingInstance] MediaRecordingInstance
-                    def initialize(version, payload , sid: nil)
-                        super(version)
-                        
-                        # Marshaled Properties
-                        @properties = { 
-                            'account_sid' => payload['account_sid'],
-                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                            'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
-                            'format' => payload['format'],
-                            'links' => payload['links'],
-                            'processor_sid' => payload['processor_sid'],
-                            'resolution' => payload['resolution'],
-                            'source_sid' => payload['source_sid'],
-                            'sid' => payload['sid'],
-                            'media_size' => payload['media_size'],
-                            'status' => payload['status'],
-                            'status_callback' => payload['status_callback'],
-                            'status_callback_method' => payload['status_callback_method'],
-                            'url' => payload['url'],
-                        }
-
-                        # Context
-                        @instance_context = nil
-                        @params = { 'sid' => sid  || @properties['sid']  , }
-                    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 [MediaRecordingContext] CallContext for this CallInstance
-                    def context
-                        unless @instance_context
-                            @instance_context = MediaRecordingContext.new(@version , @params['sid'])
-                        end
-                        @instance_context
-                    end
-                    
-                    ##
-                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MediaRecording resource.
-                    def account_sid
-                        @properties['account_sid']
-                    end
-                    
-                    ##
-                    # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-                    def date_created
-                        @properties['date_created']
-                    end
-                    
-                    ##
-                    # @return [Time] The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-                    def date_updated
-                        @properties['date_updated']
-                    end
-                    
-                    ##
-                    # @return [String] The duration of the MediaRecording in seconds.
-                    def duration
-                        @properties['duration']
-                    end
-                    
-                    ##
-                    # @return [Format] 
-                    def format
-                        @properties['format']
-                    end
-                    
-                    ##
-                    # @return [Hash] The URLs of related resources.
-                    def links
-                        @properties['links']
-                    end
-                    
-                    ##
-                    # @return [String] The SID of the MediaProcessor resource which produced the MediaRecording.
-                    def processor_sid
-                        @properties['processor_sid']
-                    end
-                    
-                    ##
-                    # @return [String] The dimensions of the video image in pixels expressed as columns (width) and rows (height).
-                    def resolution
-                        @properties['resolution']
-                    end
-                    
-                    ##
-                    # @return [String] The SID of the resource that generated the original media track(s) of the MediaRecording.
-                    def source_sid
-                        @properties['source_sid']
-                    end
-                    
-                    ##
-                    # @return [String] The unique string generated to identify the MediaRecording resource.
-                    def sid
-                        @properties['sid']
-                    end
-                    
-                    ##
-                    # @return [String] The size of the recording media in bytes.
-                    def media_size
-                        @properties['media_size']
-                    end
-                    
-                    ##
-                    # @return [Status] 
-                    def status
-                        @properties['status']
-                    end
-                    
-                    ##
-                    # @return [String] The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
-                    def status_callback
-                        @properties['status_callback']
-                    end
-                    
-                    ##
-                    # @return [String] The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
-                    def status_callback_method
-                        @properties['status_callback_method']
-                    end
-                    
-                    ##
-                    # @return [String] The absolute URL of the resource.
-                    def url
-                        @properties['url']
-                    end
-                    
-                    ##
-                    # Delete the MediaRecordingInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
-
-                        context.delete
-                    end
-
-                    ##
-                    # Fetch the MediaRecordingInstance
-                    # @return [MediaRecordingInstance] Fetched MediaRecordingInstance
-                    def fetch
-
-                        context.fetch
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Media.V1.MediaRecordingInstance #{values}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Media.V1.MediaRecordingInstance #{values}>"
-                    end
-                end
-
-            end
-        end
-    end
-end

data/lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb

@@ -1,255 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Twilio - Media
-#    This is the public Twilio REST API.
-#
-#    NOTE: This class is auto generated by OpenAPI Generator.
-#    https://openapi-generator.tech
-#    Do not edit the class manually.
-#
-
-
-module Twilio
-    module REST
-        class Media < MediaBase
-            class V1 < Version
-                class PlayerStreamerContext < InstanceContext
-
-                     class PlaybackGrantList < ListResource
-                
-                    ##
-                    # Initialize the PlaybackGrantList
-                    # @param [Version] version Version that contains the resource
-                    # @return [PlaybackGrantList] PlaybackGrantList
-                    def initialize(version, sid: nil)
-                        super(version)
-                        # Path Solution
-                        @solution = { sid: sid }
-                        
-                        
-                    end
-                
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.Media.V1.PlaybackGrantList>'
-                    end
-                end
-
-
-                class PlaybackGrantContext < InstanceContext
-                    ##
-                    # Initialize the PlaybackGrantContext
-                    # @param [Version] version Version that contains the resource
-                    # @param [String] sid The SID of the PlayerStreamer resource to fetch.
-                    # @return [PlaybackGrantContext] PlaybackGrantContext
-                    def initialize(version, sid)
-                        super(version)
-
-                        # Path Solution
-                        @solution = { sid: sid,  }
-                        @uri = "/PlayerStreamers/#{@solution[:sid]}/PlaybackGrant"
-
-                        
-                    end
-                    ##
-                    # Create the PlaybackGrantInstance
-                    # @param [String] ttl The time to live of the PlaybackGrant. Default value is 15 seconds. Maximum value is 60 seconds.
-                    # @param [String] access_control_allow_origin The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain.
-                    # @return [PlaybackGrantInstance] Created PlaybackGrantInstance
-                    def create(
-                        ttl: :unset, 
-                        access_control_allow_origin: :unset
-                    )
-
-                        data = Twilio::Values.of({
-                            'Ttl' => ttl,
-                            'AccessControlAllowOrigin' => access_control_allow_origin,
-                        })
-
-                        
-                        payload = @version.create('POST', @uri, data: data)
-                        PlaybackGrantInstance.new(
-                            @version,
-                            payload,
-                            sid: @solution[:sid],
-                        )
-                    end
-
-                    ##
-                    # Fetch the PlaybackGrantInstance
-                    # @return [PlaybackGrantInstance] Fetched PlaybackGrantInstance
-                    def fetch
-
-                        
-                        payload = @version.fetch('GET', @uri)
-                        PlaybackGrantInstance.new(
-                            @version,
-                            payload,
-                            sid: @solution[:sid],
-                        )
-                    end
-
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Media.V1.PlaybackGrantContext #{context}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Media.V1.PlaybackGrantContext #{context}>"
-                    end
-                end
-
-                class PlaybackGrantPage < Page
-                    ##
-                    # Initialize the PlaybackGrantPage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [PlaybackGrantPage] PlaybackGrantPage
-                    def initialize(version, response, solution)
-                        super(version, response)
-
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    ##
-                    # Build an instance of PlaybackGrantInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [PlaybackGrantInstance] PlaybackGrantInstance
-                    def get_instance(payload)
-                        PlaybackGrantInstance.new(@version, payload, sid: @solution[:sid])
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        '<Twilio.Media.V1.PlaybackGrantPage>'
-                    end
-                end
-                class PlaybackGrantInstance < InstanceResource
-                    ##
-                    # Initialize the PlaybackGrantInstance
-                    # @param [Version] version Version that contains the resource
-                    # @param [Hash] payload payload that contains response from Twilio
-                    # @param [String] account_sid The SID of the
-                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this PlaybackGrant
-                    #   resource.
-                    # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [PlaybackGrantInstance] PlaybackGrantInstance
-                    def initialize(version, payload , sid: nil)
-                        super(version)
-                        
-                        # Marshaled Properties
-                        @properties = { 
-                            'sid' => payload['sid'],
-                            'url' => payload['url'],
-                            'account_sid' => payload['account_sid'],
-                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                            'grant' => payload['grant'],
-                        }
-
-                        # Context
-                        @instance_context = nil
-                        @params = { 'sid' => sid  || @properties['sid']  , }
-                    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 [PlaybackGrantContext] CallContext for this CallInstance
-                    def context
-                        unless @instance_context
-                            @instance_context = PlaybackGrantContext.new(@version , @params['sid'])
-                        end
-                        @instance_context
-                    end
-                    
-                    ##
-                    # @return [String] The unique string generated to identify the PlayerStreamer resource that this PlaybackGrant authorizes views for.
-                    def sid
-                        @properties['sid']
-                    end
-                    
-                    ##
-                    # @return [String] The absolute URL of the resource.
-                    def url
-                        @properties['url']
-                    end
-                    
-                    ##
-                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this resource.
-                    def account_sid
-                        @properties['account_sid']
-                    end
-                    
-                    ##
-                    # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-                    def date_created
-                        @properties['date_created']
-                    end
-                    
-                    ##
-                    # @return [Hash] The grant that authorizes the player sdk to connect to the livestream
-                    def grant
-                        @properties['grant']
-                    end
-                    
-                    ##
-                    # Create the PlaybackGrantInstance
-                    # @param [String] ttl The time to live of the PlaybackGrant. Default value is 15 seconds. Maximum value is 60 seconds.
-                    # @param [String] access_control_allow_origin The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain.
-                    # @return [PlaybackGrantInstance] Created PlaybackGrantInstance
-                    def create(
-                        ttl: :unset, 
-                        access_control_allow_origin: :unset
-                    )
-
-                        context.create(
-                            ttl: ttl, 
-                            access_control_allow_origin: access_control_allow_origin, 
-                        )
-                    end
-
-                    ##
-                    # Fetch the PlaybackGrantInstance
-                    # @return [PlaybackGrantInstance] Fetched PlaybackGrantInstance
-                    def fetch
-
-                        context.fetch
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Media.V1.PlaybackGrantInstance #{values}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Media.V1.PlaybackGrantInstance #{values}>"
-                    end
-                end
-
-             end
-            end
-        end
-    end
-end
-
-