Skip to content

Commit

Permalink
4.0.0 (#88)
Browse files Browse the repository at this point in the history
 - add support for `static-renditions` APIs
 - add `passthrough` to each `static_rendition` object
 - add support for additional standard dimensions in Mux Data
 - allow updating `video_quality` on live streams
 - [breaking] It is very unlikely that you were using the `AssetStaticRenditionsFiles` type directly, but just in case this has been replaced with `StaticRendition` for the object, and `CreateStaticRenditionRequest` for the request with the new `static-renditions` APIs
 - [breaking] Deprecate `mp4_support` and associated APIs. [Utilize the new Static Rendition APIs instead.](https://www.mux.com/docs/changelog/static-renditions-api-for-creating-mp4-and-m4a-renditions-now-available)
 - [breaking] Remove Spaces APIs and routes
  • Loading branch information
jsanford8 authored Feb 21, 2025
1 parent f17ce1c commit f228959
Show file tree
Hide file tree
Showing 61 changed files with 1,349 additions and 3,447 deletions.
40 changes: 8 additions & 32 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,16 @@ docs/AssetNonStandardInputReasons.md
docs/AssetRecordingTimes.md
docs/AssetResponse.md
docs/AssetStaticRenditions.md
docs/AssetStaticRenditionsFiles.md
docs/AssetsApi.md
docs/BreakdownValue.md
docs/Broadcast.md
docs/BroadcastLayout.md
docs/BroadcastResolution.md
docs/BroadcastResponse.md
docs/BroadcastStatus.md
docs/CreateAssetRequest.md
docs/CreateBroadcastRequest.md
docs/CreateLiveStreamRequest.md
docs/CreatePlaybackIDRequest.md
docs/CreatePlaybackIDResponse.md
docs/CreatePlaybackRestrictionRequest.md
docs/CreateSimulcastTargetRequest.md
docs/CreateSpaceRequest.md
docs/CreateStaticRenditionRequest.md
docs/CreateStaticRenditionResponse.md
docs/CreateTrackRequest.md
docs/CreateTrackResponse.md
docs/CreateTranscriptionVocabularyRequest.md
Expand Down Expand Up @@ -108,7 +102,6 @@ docs/ListRealTimeDimensionsResponse.md
docs/ListRealTimeMetricsResponse.md
docs/ListRelatedIncidentsResponse.md
docs/ListSigningKeysResponse.md
docs/ListSpacesResponse.md
docs/ListTranscriptionVocabulariesResponse.md
docs/ListUploadsResponse.md
docs/ListVideoViewExportsResponse.md
Expand Down Expand Up @@ -154,13 +147,7 @@ docs/SigningKeyResponse.md
docs/SigningKeysApi.md
docs/SimulcastTarget.md
docs/SimulcastTargetResponse.md
docs/Space.md
docs/SpaceResponse.md
docs/SpaceStatus.md
docs/SpaceType.md
docs/SpacesApi.md
docs/StartSpaceBroadcastResponse.md
docs/StopSpaceBroadcastResponse.md
docs/StaticRendition.md
docs/Track.md
docs/TranscriptionVocabulariesApi.md
docs/TranscriptionVocabulary.md
Expand All @@ -172,6 +159,7 @@ docs/UpdateAssetRequest.md
docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
docs/UpdateLiveStreamGeneratedSubtitlesRequest.md
docs/UpdateLiveStreamNewAssetSettings.md
docs/UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.md
docs/UpdateLiveStreamRequest.md
docs/UpdateReferrerDomainRestrictionRequest.md
docs/UpdateTranscriptionVocabularyRequest.md
Expand Down Expand Up @@ -206,7 +194,6 @@ lib/mux_ruby/api/playback_id_api.rb
lib/mux_ruby/api/playback_restrictions_api.rb
lib/mux_ruby/api/real_time_api.rb
lib/mux_ruby/api/signing_keys_api.rb
lib/mux_ruby/api/spaces_api.rb
lib/mux_ruby/api/transcription_vocabularies_api.rb
lib/mux_ruby/api/url_signing_keys_api.rb
lib/mux_ruby/api/video_views_api.rb
Expand All @@ -224,21 +211,15 @@ lib/mux_ruby/models/asset_non_standard_input_reasons.rb
lib/mux_ruby/models/asset_recording_times.rb
lib/mux_ruby/models/asset_response.rb
lib/mux_ruby/models/asset_static_renditions.rb
lib/mux_ruby/models/asset_static_renditions_files.rb
lib/mux_ruby/models/breakdown_value.rb
lib/mux_ruby/models/broadcast.rb
lib/mux_ruby/models/broadcast_layout.rb
lib/mux_ruby/models/broadcast_resolution.rb
lib/mux_ruby/models/broadcast_response.rb
lib/mux_ruby/models/broadcast_status.rb
lib/mux_ruby/models/create_asset_request.rb
lib/mux_ruby/models/create_broadcast_request.rb
lib/mux_ruby/models/create_live_stream_request.rb
lib/mux_ruby/models/create_playback_id_request.rb
lib/mux_ruby/models/create_playback_id_response.rb
lib/mux_ruby/models/create_playback_restriction_request.rb
lib/mux_ruby/models/create_simulcast_target_request.rb
lib/mux_ruby/models/create_space_request.rb
lib/mux_ruby/models/create_static_rendition_request.rb
lib/mux_ruby/models/create_static_rendition_response.rb
lib/mux_ruby/models/create_track_request.rb
lib/mux_ruby/models/create_track_response.rb
lib/mux_ruby/models/create_transcription_vocabulary_request.rb
Expand Down Expand Up @@ -310,7 +291,6 @@ lib/mux_ruby/models/list_real_time_dimensions_response.rb
lib/mux_ruby/models/list_real_time_metrics_response.rb
lib/mux_ruby/models/list_related_incidents_response.rb
lib/mux_ruby/models/list_signing_keys_response.rb
lib/mux_ruby/models/list_spaces_response.rb
lib/mux_ruby/models/list_transcription_vocabularies_response.rb
lib/mux_ruby/models/list_uploads_response.rb
lib/mux_ruby/models/list_video_view_exports_response.rb
Expand Down Expand Up @@ -349,12 +329,7 @@ lib/mux_ruby/models/signing_key.rb
lib/mux_ruby/models/signing_key_response.rb
lib/mux_ruby/models/simulcast_target.rb
lib/mux_ruby/models/simulcast_target_response.rb
lib/mux_ruby/models/space.rb
lib/mux_ruby/models/space_response.rb
lib/mux_ruby/models/space_status.rb
lib/mux_ruby/models/space_type.rb
lib/mux_ruby/models/start_space_broadcast_response.rb
lib/mux_ruby/models/stop_space_broadcast_response.rb
lib/mux_ruby/models/static_rendition.rb
lib/mux_ruby/models/track.rb
lib/mux_ruby/models/transcription_vocabulary.rb
lib/mux_ruby/models/transcription_vocabulary_response.rb
Expand All @@ -364,6 +339,7 @@ lib/mux_ruby/models/update_asset_request.rb
lib/mux_ruby/models/update_live_stream_embedded_subtitles_request.rb
lib/mux_ruby/models/update_live_stream_generated_subtitles_request.rb
lib/mux_ruby/models/update_live_stream_new_asset_settings.rb
lib/mux_ruby/models/update_live_stream_new_asset_settings_static_renditions_request.rb
lib/mux_ruby/models/update_live_stream_request.rb
lib/mux_ruby/models/update_referrer_domain_restriction_request.rb
lib/mux_ruby/models/update_transcription_vocabulary_request.rb
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
mux_ruby (3.20.0)
mux_ruby (4.0.0)
typhoeus (~> 1.0, >= 1.0.1)

GEM
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 3.20.0
- Package version: 4.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
For more information, please visit [https://docs.mux.com](https://docs.mux.com)

Expand All @@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
Then either install the gem locally:

```shell
gem install ./mux_ruby-3.20.0.gem
gem install ./mux_ruby-4.0.0.gem
```

(for development, run `gem install --dev ./mux_ruby-3.20.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./mux_ruby-4.0.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

gem 'mux_ruby', '~> 3.20.0'
gem 'mux_ruby', '~> 4.0.0'

### Install from Git

Expand Down
4 changes: 2 additions & 2 deletions docs/AssetStaticRenditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | Indicates the status of downloadable MP4 versions of this asset. | [optional][default to 'disabled'] |
| **files** | [**Array<AssetStaticRenditionsFiles>**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional] |
| **status** | **String** | Indicates the status of downloadable MP4 versions of this asset. This field is only valid when `mp4_support` is enabled | [optional][default to 'disabled'] |
| **files** | [**Array<StaticRendition>**](StaticRendition.md) | Array of file objects. | [optional] |

## Example

Expand Down
28 changes: 0 additions & 28 deletions docs/AssetStaticRenditionsFiles.md

This file was deleted.

147 changes: 146 additions & 1 deletion docs/AssetsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ All URIs are relative to *https://api.mux.com*
| ------ | ------------ | ----------- |
| [**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset |
| [**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID |
| [**create_asset_static_rendition**](AssetsApi.md#create_asset_static_rendition) | **POST** /video/v1/assets/{ASSET_ID}/static-renditions | Create a static rendition for an asset |
| [**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track |
| [**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset |
| [**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID |
| [**delete_asset_static_rendition**](AssetsApi.md#delete_asset_static_rendition) | **DELETE** /video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID} | Delete a single static rendition for an asset |
| [**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track |
| [**generate_asset_track_subtitles**](AssetsApi.md#generate_asset_track_subtitles) | **POST** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles | Generate track subtitles |
| [**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset |
Expand Down Expand Up @@ -162,6 +164,78 @@ end
- **Accept**: application/json


## create_asset_static_rendition

> <CreateStaticRenditionResponse> create_asset_static_rendition(asset_id, create_static_rendition_request)
Create a static rendition for an asset

Creates a static rendition (i.e. MP4) for an asset

### Examples

```ruby
require 'time'
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
# Configure HTTP basic authorization: accessToken
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::AssetsApi.new
asset_id = 'asset_id_example' # String | The asset ID.
create_static_rendition_request = MuxRuby::CreateStaticRenditionRequest.new # CreateStaticRenditionRequest |

begin
# Create a static rendition for an asset
result = api_instance.create_asset_static_rendition(asset_id, create_static_rendition_request)
p result
rescue MuxRuby::ApiError => e
puts "Error when calling AssetsApi->create_asset_static_rendition: #{e}"
end
```

#### Using the create_asset_static_rendition_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<CreateStaticRenditionResponse>, Integer, Hash)> create_asset_static_rendition_with_http_info(asset_id, create_static_rendition_request)
```ruby
begin
# Create a static rendition for an asset
data, status_code, headers = api_instance.create_asset_static_rendition_with_http_info(asset_id, create_static_rendition_request)
p status_code # => 2xx
p headers # => { ... }
p data # => <CreateStaticRenditionResponse>
rescue MuxRuby::ApiError => e
puts "Error when calling AssetsApi->create_asset_static_rendition_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **asset_id** | **String** | The asset ID. | |
| **create_static_rendition_request** | [**CreateStaticRenditionRequest**](CreateStaticRenditionRequest.md) | | |

### Return type

[**CreateStaticRenditionResponse**](CreateStaticRenditionResponse.md)

### Authorization

[accessToken](../README.md#accessToken)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## create_asset_track

> <CreateTrackResponse> create_asset_track(asset_id, create_track_request)
Expand Down Expand Up @@ -374,6 +448,77 @@ nil (empty response body)
- **Accept**: Not defined


## delete_asset_static_rendition

> delete_asset_static_rendition(asset_id, static_rendition_id)
Delete a single static rendition for an asset

Deletes a single static rendition for an asset

### Examples

```ruby
require 'time'
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
# Configure HTTP basic authorization: accessToken
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::AssetsApi.new
asset_id = 'asset_id_example' # String | The asset ID.
static_rendition_id = 'static_rendition_id_example' # String | The static rendition ID.

begin
# Delete a single static rendition for an asset
api_instance.delete_asset_static_rendition(asset_id, static_rendition_id)
rescue MuxRuby::ApiError => e
puts "Error when calling AssetsApi->delete_asset_static_rendition: #{e}"
end
```

#### Using the delete_asset_static_rendition_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> delete_asset_static_rendition_with_http_info(asset_id, static_rendition_id)
```ruby
begin
# Delete a single static rendition for an asset
data, status_code, headers = api_instance.delete_asset_static_rendition_with_http_info(asset_id, static_rendition_id)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue MuxRuby::ApiError => e
puts "Error when calling AssetsApi->delete_asset_static_rendition_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **asset_id** | **String** | The asset ID. | |
| **static_rendition_id** | **String** | The static rendition ID. | |

### Return type

nil (empty response body)

### Authorization

[accessToken](../README.md#accessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined


## delete_asset_track

> delete_asset_track(asset_id, track_id)
Expand Down Expand Up @@ -959,7 +1104,7 @@ end
Update MP4 support

Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation). Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.

### Examples

Expand Down
Loading

0 comments on commit f228959

Please sign in to comment.