mux_ruby 3.9.0 → 3.11.0

data/lib/mux_ruby/api/signing_keys_api.rb

@@ -0,0 +1,266 @@
+=begin
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'cgi'
+
+module MuxRuby
+  class SigningKeysApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a signing key
+    # Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
+    # @param [Hash] opts the optional parameters
+    # @return [SigningKeyResponse]
+    def create_signing_key(opts = {})
+      data, _status_code, _headers = create_signing_key_with_http_info(opts)
+      data
+    end
+
+    # Create a signing key
+    # Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SigningKeyResponse, Integer, Hash)>] SigningKeyResponse data, response status code and response headers
+    def create_signing_key_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SigningKeysApi.create_signing_key ...'
+      end
+      # resource path
+      local_var_path = '/system/v1/signing-keys'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SigningKeyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['accessToken']
+
+      new_options = opts.merge(
+        :operation => :"SigningKeysApi.create_signing_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SigningKeysApi#create_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a signing key
+    # Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again.
+    # @param signing_key_id [String] The ID of the signing key.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_signing_key(signing_key_id, opts = {})
+      delete_signing_key_with_http_info(signing_key_id, opts)
+      nil
+    end
+
+    # Delete a signing key
+    # Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again.
+    # @param signing_key_id [String] The ID of the signing key.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_signing_key_with_http_info(signing_key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SigningKeysApi.delete_signing_key ...'
+      end
+      # verify the required parameter 'signing_key_id' is set
+      if @api_client.config.client_side_validation && signing_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'signing_key_id' when calling SigningKeysApi.delete_signing_key"
+      end
+      # resource path
+      local_var_path = '/system/v1/signing-keys/{SIGNING_KEY_ID}'.sub('{' + 'SIGNING_KEY_ID' + '}', CGI.escape(signing_key_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['accessToken']
+
+      new_options = opts.merge(
+        :operation => :"SigningKeysApi.delete_signing_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SigningKeysApi#delete_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve a signing key
+    # Retrieves the details of a signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** 
+    # @param signing_key_id [String] The ID of the signing key.
+    # @param [Hash] opts the optional parameters
+    # @return [SigningKeyResponse]
+    def get_signing_key(signing_key_id, opts = {})
+      data, _status_code, _headers = get_signing_key_with_http_info(signing_key_id, opts)
+      data
+    end
+
+    # Retrieve a signing key
+    # Retrieves the details of a signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** 
+    # @param signing_key_id [String] The ID of the signing key.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SigningKeyResponse, Integer, Hash)>] SigningKeyResponse data, response status code and response headers
+    def get_signing_key_with_http_info(signing_key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SigningKeysApi.get_signing_key ...'
+      end
+      # verify the required parameter 'signing_key_id' is set
+      if @api_client.config.client_side_validation && signing_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'signing_key_id' when calling SigningKeysApi.get_signing_key"
+      end
+      # resource path
+      local_var_path = '/system/v1/signing-keys/{SIGNING_KEY_ID}'.sub('{' + 'SIGNING_KEY_ID' + '}', CGI.escape(signing_key_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SigningKeyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['accessToken']
+
+      new_options = opts.merge(
+        :operation => :"SigningKeysApi.get_signing_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SigningKeysApi#get_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List signing keys
+    # Returns a list of signing keys.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response (default to 25)
+    # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
+    # @return [ListSigningKeysResponse]
+    def list_signing_keys(opts = {})
+      data, _status_code, _headers = list_signing_keys_with_http_info(opts)
+      data
+    end
+
+    # List signing keys
+    # Returns a list of signing keys.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response
+    # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
+    # @return [Array<(ListSigningKeysResponse, Integer, Hash)>] ListSigningKeysResponse data, response status code and response headers
+    def list_signing_keys_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SigningKeysApi.list_signing_keys ...'
+      end
+      # resource path
+      local_var_path = '/system/v1/signing-keys'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListSigningKeysResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['accessToken']
+
+      new_options = opts.merge(
+        :operation => :"SigningKeysApi.list_signing_keys",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SigningKeysApi#list_signing_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/mux_ruby/api/url_signing_keys_api.rb

@@ -20,7 +20,7 @@ module MuxRuby
       @api_client = api_client
     end
     # Create a URL signing key
-    # Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
+    # This route is now deprecated, please use the `Signing Keys` API. Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.  Note: Any new access tokens authenticating this route will be required to have `System` level permissions. 
     # @param [Hash] opts the optional parameters
     # @return [SigningKeyResponse]
     def create_url_signing_key(opts = {})
@@ -29,7 +29,7 @@ module MuxRuby
     end
 
     # Create a URL signing key
-    # Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
+    # This route is now deprecated, please use the `Signing Keys` API. Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.  Note: Any new access tokens authenticating this route will be required to have `System` level permissions. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SigningKeyResponse, Integer, Hash)>] SigningKeyResponse data, response status code and response headers
     def create_url_signing_key_with_http_info(opts = {})
@@ -77,7 +77,7 @@ module MuxRuby
     end
 
     # Delete a URL signing key
-    # Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
+    # This route is now deprecated, please use the `Signing Keys` API. Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.  Note: Any new access tokens authenticating this route will be required to have `System` level permissions. 
     # @param signing_key_id [String] The ID of the signing key.
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -87,7 +87,7 @@ module MuxRuby
     end
 
     # Delete a URL signing key
-    # Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
+    # This route is now deprecated, please use the &#x60;Signing Keys&#x60; API. Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.  Note: Any new access tokens authenticating this route will be required to have &#x60;System&#x60; level permissions. 
     # @param signing_key_id [String] The ID of the signing key.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -138,7 +138,7 @@ module MuxRuby
     end
 
     # Retrieve a URL signing key
-    # Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** 
+    # This route is now deprecated, please use the `Signing Keys` API. Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**  Note: Any new access tokens authenticating this route will be required to have `System` level permissions. 
     # @param signing_key_id [String] The ID of the signing key.
     # @param [Hash] opts the optional parameters
     # @return [SigningKeyResponse]
@@ -148,7 +148,7 @@ module MuxRuby
     end
 
     # Retrieve a URL signing key
-    # Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** 
+    # This route is now deprecated, please use the &#x60;Signing Keys&#x60; API. Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**  Note: Any new access tokens authenticating this route will be required to have &#x60;System&#x60; level permissions. 
     # @param signing_key_id [String] The ID of the signing key.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SigningKeyResponse, Integer, Hash)>] SigningKeyResponse data, response status code and response headers
@@ -201,7 +201,7 @@ module MuxRuby
     end
 
     # List URL signing keys
-    # Returns a list of URL signing keys.
+    # This route is now deprecated, please use the `Signing Keys` API. Returns a list of URL signing keys.  Note: Any new access tokens authenticating this route will be required to have `System` level permissions. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of items to include in the response (default to 25)
     # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
@@ -212,7 +212,7 @@ module MuxRuby
     end
 
     # List URL signing keys
-    # Returns a list of URL signing keys.
+    # This route is now deprecated, please use the &#x60;Signing Keys&#x60; API. Returns a list of URL signing keys.  Note: Any new access tokens authenticating this route will be required to have &#x60;System&#x60; level permissions. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of items to include in the response
     # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;

data/lib/mux_ruby/models/asset.rb

@@ -27,9 +27,18 @@ module MuxRuby
     # The duration of the asset in seconds (max duration for a single asset is 12 hours).
     attr_accessor :duration
 
-    # The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored.
+    # This field is deprecated. Please use `resolution_tier` instead. The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored.
     attr_accessor :max_stored_resolution
 
+    # The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.
+    attr_accessor :resolution_tier
+
+    # Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`.
+    attr_accessor :max_resolution_tier
+
+    # The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used.
+    attr_accessor :encoding_tier
+
     # The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
     attr_accessor :max_stored_frame_rate
 
@@ -110,6 +119,9 @@ module MuxRuby
         :'status' => :'status',
         :'duration' => :'duration',
         :'max_stored_resolution' => :'max_stored_resolution',
+        :'resolution_tier' => :'resolution_tier',
+        :'max_resolution_tier' => :'max_resolution_tier',
+        :'encoding_tier' => :'encoding_tier',
         :'max_stored_frame_rate' => :'max_stored_frame_rate',
         :'aspect_ratio' => :'aspect_ratio',
         :'playback_ids' => :'playback_ids',
@@ -145,6 +157,9 @@ module MuxRuby
         :'status' => :'String',
         :'duration' => :'Float',
         :'max_stored_resolution' => :'String',
+        :'resolution_tier' => :'String',
+        :'max_resolution_tier' => :'String',
+        :'encoding_tier' => :'String',
         :'max_stored_frame_rate' => :'Float',
         :'aspect_ratio' => :'String',
         :'playback_ids' => :'Array<PlaybackID>',
@@ -208,6 +223,18 @@ module MuxRuby
         self.max_stored_resolution = attributes[:'max_stored_resolution']
       end
 
+      if attributes.key?(:'resolution_tier')
+        self.resolution_tier = attributes[:'resolution_tier']
+      end
+
+      if attributes.key?(:'max_resolution_tier')
+        self.max_resolution_tier = attributes[:'max_resolution_tier']
+      end
+
+      if attributes.key?(:'encoding_tier')
+        self.encoding_tier = attributes[:'encoding_tier']
+      end
+
       if attributes.key?(:'max_stored_frame_rate')
         self.max_stored_frame_rate = attributes[:'max_stored_frame_rate']
       end
@@ -311,6 +338,12 @@ module MuxRuby
       return false unless status_validator.valid?(@status)
       max_stored_resolution_validator = EnumAttributeValidator.new('String', ["Audio only", "SD", "HD", "FHD", "UHD"])
       return false unless max_stored_resolution_validator.valid?(@max_stored_resolution)
+      resolution_tier_validator = EnumAttributeValidator.new('String', ["audio-only", "720p", "1080p", "1440p", "2160p"])
+      return false unless resolution_tier_validator.valid?(@resolution_tier)
+      max_resolution_tier_validator = EnumAttributeValidator.new('String', ["1080p", "1440p", "2160p"])
+      return false unless max_resolution_tier_validator.valid?(@max_resolution_tier)
+      encoding_tier_validator = EnumAttributeValidator.new('String', ["smart", "baseline"])
+      return false unless encoding_tier_validator.valid?(@encoding_tier)
       master_access_validator = EnumAttributeValidator.new('String', ["temporary", "none"])
       return false unless master_access_validator.valid?(@master_access)
       mp4_support_validator = EnumAttributeValidator.new('String', ["standard", "none"])
@@ -338,6 +371,36 @@ module MuxRuby
       @max_stored_resolution = max_stored_resolution
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] resolution_tier Object to be assigned
+    def resolution_tier=(resolution_tier)
+      validator = EnumAttributeValidator.new('String', ["audio-only", "720p", "1080p", "1440p", "2160p"])
+      unless validator.valid?(resolution_tier)
+        fail ArgumentError, "invalid value for \"resolution_tier\", must be one of #{validator.allowable_values}."
+      end
+      @resolution_tier = resolution_tier
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] max_resolution_tier Object to be assigned
+    def max_resolution_tier=(max_resolution_tier)
+      validator = EnumAttributeValidator.new('String', ["1080p", "1440p", "2160p"])
+      unless validator.valid?(max_resolution_tier)
+        fail ArgumentError, "invalid value for \"max_resolution_tier\", must be one of #{validator.allowable_values}."
+      end
+      @max_resolution_tier = max_resolution_tier
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] encoding_tier Object to be assigned
+    def encoding_tier=(encoding_tier)
+      validator = EnumAttributeValidator.new('String', ["smart", "baseline"])
+      unless validator.valid?(encoding_tier)
+        fail ArgumentError, "invalid value for \"encoding_tier\", must be one of #{validator.allowable_values}."
+      end
+      @encoding_tier = encoding_tier
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] master_access Object to be assigned
     def master_access=(master_access)
@@ -368,6 +431,9 @@ module MuxRuby
           status == o.status &&
           duration == o.duration &&
           max_stored_resolution == o.max_stored_resolution &&
+          resolution_tier == o.resolution_tier &&
+          max_resolution_tier == o.max_resolution_tier &&
+          encoding_tier == o.encoding_tier &&
           max_stored_frame_rate == o.max_stored_frame_rate &&
           aspect_ratio == o.aspect_ratio &&
           playback_ids == o.playback_ids &&
@@ -398,7 +464,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, status, duration, max_stored_resolution, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, upload_id, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test].hash
+      [id, created_at, status, duration, max_stored_resolution, resolution_tier, max_resolution_tier, encoding_tier, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, upload_id, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test].hash
     end
 
     # Builds the object from hash