Skip to content

Commit

Permalink
Regen from latest OpenAPI spec (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
philcluff committed Mar 14, 2024
1 parent 09fb891 commit 34a1bfd
Show file tree
Hide file tree
Showing 33 changed files with 955 additions and 62 deletions.
4 changes: 4 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ docs/ExportFile.md
docs/ExportsApi.md
docs/FilterValue.md
docs/FiltersApi.md
docs/GenerateTrackSubtitlesRequest.md
docs/GenerateTrackSubtitlesResponse.md
docs/GetAssetInputInfoResponse.md
docs/GetAssetOrLiveStreamIdResponse.md
docs/GetAssetOrLiveStreamIdResponseData.md
Expand Down Expand Up @@ -257,6 +259,8 @@ src/main/java/com/mux/sdk/models/Error.java
src/main/java/com/mux/sdk/models/ExportDate.java
src/main/java/com/mux/sdk/models/ExportFile.java
src/main/java/com/mux/sdk/models/FilterValue.java
src/main/java/com/mux/sdk/models/GenerateTrackSubtitlesRequest.java
src/main/java/com/mux/sdk/models/GenerateTrackSubtitlesResponse.java
src/main/java/com/mux/sdk/models/GetAssetInputInfoResponse.java
src/main/java/com/mux/sdk/models/GetAssetOrLiveStreamIdResponse.java
src/main/java/com/mux/sdk/models/GetAssetOrLiveStreamIdResponseData.java
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.mux</groupId>
<artifactId>mux-sdk-java</artifactId>
<version>0.9.0</version>
<version>0.10.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -58,7 +58,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
compile "com.mux:mux-sdk-java:0.9.0"
compile "com.mux:mux-sdk-java:0.10.0"
```

### Others
Expand All @@ -71,7 +71,7 @@ mvn clean package

Then manually install the following JARs:

* `target/mux-sdk-java-0.9.0.jar`
* `target/mux-sdk-java-0.10.0.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down Expand Up @@ -99,7 +99,7 @@ public class Example {
accessToken.setPassword("YOUR PASSWORD");

AssetsApi apiInstance = new AssetsApi(defaultClient);
CreateAssetRequest createAssetRequest = {"input":[{"url":"https://muxed.s3.amazonaws.com/leds.mp4"}],"playback_policy":["public"]}; // CreateAssetRequest |
CreateAssetRequest createAssetRequest = {"input":[{"url":"https://muxed.s3.amazonaws.com/leds.mp4"}],"playback_policy":["public"],"encoding_tier":"baseline"}; // CreateAssetRequest |
try {
AssetResponse result = apiInstance.createAsset(createAssetRequest)
.execute();
Expand Down Expand Up @@ -128,11 +128,12 @@ Class | Method | HTTP request | Description
*AssetsApi* | [**deleteAsset**](docs/AssetsApi.md#deleteAsset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
*AssetsApi* | [**deleteAssetPlaybackId**](docs/AssetsApi.md#deleteAssetPlaybackId) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
*AssetsApi* | [**deleteAssetTrack**](docs/AssetsApi.md#deleteAssetTrack) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
*AssetsApi* | [**generateAssetTrackSubtitles**](docs/AssetsApi.md#generateAssetTrackSubtitles) | **POST** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles | Generate track subtitles
*AssetsApi* | [**getAsset**](docs/AssetsApi.md#getAsset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
*AssetsApi* | [**getAssetInputInfo**](docs/AssetsApi.md#getAssetInputInfo) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
*AssetsApi* | [**getAssetPlaybackId**](docs/AssetsApi.md#getAssetPlaybackId) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
*AssetsApi* | [**listAssets**](docs/AssetsApi.md#listAssets) | **GET** /video/v1/assets | List assets
*AssetsApi* | [**updateAsset**](docs/AssetsApi.md#updateAsset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an Asset
*AssetsApi* | [**updateAsset**](docs/AssetsApi.md#updateAsset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an asset
*AssetsApi* | [**updateAssetMasterAccess**](docs/AssetsApi.md#updateAssetMasterAccess) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
*AssetsApi* | [**updateAssetMp4Support**](docs/AssetsApi.md#updateAssetMp4Support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
*DeliveryUsageApi* | [**listDeliveryUsage**](docs/DeliveryUsageApi.md#listDeliveryUsage) | **GET** /video/v1/delivery-usage | List Usage
Expand All @@ -155,12 +156,12 @@ Class | Method | HTTP request | Description
*LiveStreamsApi* | [**createLiveStreamSimulcastTarget**](docs/LiveStreamsApi.md#createLiveStreamSimulcastTarget) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target
*LiveStreamsApi* | [**deleteLiveStream**](docs/LiveStreamsApi.md#deleteLiveStream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream
*LiveStreamsApi* | [**deleteLiveStreamPlaybackId**](docs/LiveStreamsApi.md#deleteLiveStreamPlaybackId) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID
*LiveStreamsApi* | [**deleteLiveStreamSimulcastTarget**](docs/LiveStreamsApi.md#deleteLiveStreamSimulcastTarget) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target
*LiveStreamsApi* | [**deleteLiveStreamSimulcastTarget**](docs/LiveStreamsApi.md#deleteLiveStreamSimulcastTarget) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a live stream simulcast target
*LiveStreamsApi* | [**disableLiveStream**](docs/LiveStreamsApi.md#disableLiveStream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream
*LiveStreamsApi* | [**enableLiveStream**](docs/LiveStreamsApi.md#enableLiveStream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream
*LiveStreamsApi* | [**getLiveStream**](docs/LiveStreamsApi.md#getLiveStream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
*LiveStreamsApi* | [**getLiveStreamPlaybackId**](docs/LiveStreamsApi.md#getLiveStreamPlaybackId) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID
*LiveStreamsApi* | [**getLiveStreamSimulcastTarget**](docs/LiveStreamsApi.md#getLiveStreamSimulcastTarget) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target
*LiveStreamsApi* | [**getLiveStreamSimulcastTarget**](docs/LiveStreamsApi.md#getLiveStreamSimulcastTarget) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a live stream simulcast target
*LiveStreamsApi* | [**listLiveStreams**](docs/LiveStreamsApi.md#listLiveStreams) | **GET** /video/v1/live-streams | List live streams
*LiveStreamsApi* | [**resetStreamKey**](docs/LiveStreamsApi.md#resetStreamKey) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream&#39;s stream key
*LiveStreamsApi* | [**signalLiveStreamComplete**](docs/LiveStreamsApi.md#signalLiveStreamComplete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished
Expand All @@ -178,7 +179,7 @@ Class | Method | HTTP request | Description
*MonitoringApi* | [**getMonitoringTimeseries**](docs/MonitoringApi.md#getMonitoringTimeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries | Get Monitoring Timeseries
*MonitoringApi* | [**listMonitoringDimensions**](docs/MonitoringApi.md#listMonitoringDimensions) | **GET** /data/v1/monitoring/dimensions | List Monitoring Dimensions
*MonitoringApi* | [**listMonitoringMetrics**](docs/MonitoringApi.md#listMonitoringMetrics) | **GET** /data/v1/monitoring/metrics | List Monitoring Metrics
*PlaybackIdApi* | [**getAssetOrLivestreamId**](docs/PlaybackIdApi.md#getAssetOrLivestreamId) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an Asset or Live Stream ID
*PlaybackIdApi* | [**getAssetOrLivestreamId**](docs/PlaybackIdApi.md#getAssetOrLivestreamId) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an asset or live stream ID
*PlaybackRestrictionsApi* | [**createPlaybackRestriction**](docs/PlaybackRestrictionsApi.md#createPlaybackRestriction) | **POST** /video/v1/playback-restrictions | Create a Playback Restriction
*PlaybackRestrictionsApi* | [**deletePlaybackRestriction**](docs/PlaybackRestrictionsApi.md#deletePlaybackRestriction) | **DELETE** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Delete a Playback Restriction
*PlaybackRestrictionsApi* | [**getPlaybackRestriction**](docs/PlaybackRestrictionsApi.md#getPlaybackRestriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction
Expand Down Expand Up @@ -263,6 +264,8 @@ Class | Method | HTTP request | Description
- [ExportDate](docs/ExportDate.md)
- [ExportFile](docs/ExportFile.md)
- [FilterValue](docs/FilterValue.md)
- [GenerateTrackSubtitlesRequest](docs/GenerateTrackSubtitlesRequest.md)
- [GenerateTrackSubtitlesResponse](docs/GenerateTrackSubtitlesResponse.md)
- [GetAssetInputInfoResponse](docs/GetAssetInputInfoResponse.md)
- [GetAssetOrLiveStreamIdResponse](docs/GetAssetOrLiveStreamIdResponse.md)
- [GetAssetOrLiveStreamIdResponseData](docs/GetAssetOrLiveStreamIdResponseData.md)
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ plugins {
}

group = 'com.mux'
version = '0.9.0'
version = '0.10.0'

repositories {
mavenCentral()
Expand Down
13 changes: 13 additions & 0 deletions docs/Asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Name | Type | Description | Notes
**recordingTimes** | [**java.util.List&lt;AssetRecordingTimes&gt;**](AssetRecordingTimes.md) | An array of individual live stream recording sessions. A recording session is created on each encoder connection during the live stream. Additionally any time slate media is inserted during brief interruptions in the live stream media or times when the live streaming software disconnects, a recording session representing the slate media will be added with a \&quot;slate\&quot; type. | [optional]
**nonStandardInputReasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional]
**test** | **Boolean** | True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. | [optional]
**ingestType** | [**IngestTypeEnum**](#IngestTypeEnum) | The type of ingest used to create the asset. | [optional]



Expand Down Expand Up @@ -107,3 +108,15 @@ NONE | &quot;none&quot;



## Enum: IngestTypeEnum

Name | Value
---- | -----
ON_DEMAND_URL | &quot;on_demand_url&quot;
ON_DEMAND_DIRECT_UPLOAD | &quot;on_demand_direct_upload&quot;
ON_DEMAND_CLIP | &quot;on_demand_clip&quot;
LIVE_RTMP | &quot;live_rtmp&quot;
LIVE_SRT | &quot;live_srt&quot;



80 changes: 77 additions & 3 deletions docs/AssetsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ Method | HTTP request | Description
[**deleteAsset**](AssetsApi.md#deleteAsset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
[**deleteAssetPlaybackId**](AssetsApi.md#deleteAssetPlaybackId) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
[**deleteAssetTrack**](AssetsApi.md#deleteAssetTrack) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
[**generateAssetTrackSubtitles**](AssetsApi.md#generateAssetTrackSubtitles) | **POST** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles | Generate track subtitles
[**getAsset**](AssetsApi.md#getAsset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
[**getAssetInputInfo**](AssetsApi.md#getAssetInputInfo) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
[**getAssetPlaybackId**](AssetsApi.md#getAssetPlaybackId) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
[**listAssets**](AssetsApi.md#listAssets) | **GET** /video/v1/assets | List assets
[**updateAsset**](AssetsApi.md#updateAsset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an Asset
[**updateAsset**](AssetsApi.md#updateAsset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an asset
[**updateAssetMasterAccess**](AssetsApi.md#updateAssetMasterAccess) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
[**updateAssetMp4Support**](AssetsApi.md#updateAssetMp4Support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support

Expand Down Expand Up @@ -48,7 +49,7 @@ public class Example {
accessToken.setPassword("YOUR PASSWORD");

AssetsApi apiInstance = new AssetsApi(defaultClient);
CreateAssetRequest createAssetRequest = {"input":[{"url":"https://muxed.s3.amazonaws.com/leds.mp4"}],"playback_policy":["public"]}; // CreateAssetRequest |
CreateAssetRequest createAssetRequest = {"input":[{"url":"https://muxed.s3.amazonaws.com/leds.mp4"}],"playback_policy":["public"],"encoding_tier":"baseline"}; // CreateAssetRequest |
try {
AssetResponse result = apiInstance.createAsset(createAssetRequest)
.execute();
Expand Down Expand Up @@ -438,6 +439,79 @@ null (empty response body)
|-------------|-------------|------------------|
**204** | No Content | - |

<a name="generateAssetTrackSubtitles"></a>
# **generateAssetTrackSubtitles**
> GenerateTrackSubtitlesResponse generateAssetTrackSubtitles(ASSET_ID, TRACK_ID, generateTrackSubtitlesRequest).execute();
Generate track subtitles

Generates subtitles (captions) for a given audio track. This API can be used for up to 7 days after an asset is created.

### Example
```java
// Import classes:
import com.mux.ApiClient;
import com.mux.ApiException;
import com.mux.Configuration;
import com.mux.auth.*;
import com.mux.models.*;
import com.mux.sdk.AssetsApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mux.com");

// Configure HTTP basic authorization: accessToken
HttpBasicAuth accessToken = (HttpBasicAuth) defaultClient.getAuthentication("accessToken");
accessToken.setUsername("YOUR USERNAME");
accessToken.setPassword("YOUR PASSWORD");

AssetsApi apiInstance = new AssetsApi(defaultClient);
String ASSET_ID = "ASSET_ID_example"; // String | The asset ID.
String TRACK_ID = "TRACK_ID_example"; // String | The track ID.
GenerateTrackSubtitlesRequest generateTrackSubtitlesRequest = {"generated_subtitles":[{"language_code":"en","name":"English (generated)","passthrough":"English (generated)"}]}; // GenerateTrackSubtitlesRequest |
try {
GenerateTrackSubtitlesResponse result = apiInstance.generateAssetTrackSubtitles(ASSET_ID, TRACK_ID, generateTrackSubtitlesRequest)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AssetsApi#generateAssetTrackSubtitles");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ASSET_ID** | **String**| The asset ID. |
**TRACK_ID** | **String**| The track ID. |
**generateTrackSubtitlesRequest** | [**GenerateTrackSubtitlesRequest**](GenerateTrackSubtitlesRequest.md)| |

### Return type

[**GenerateTrackSubtitlesResponse**](GenerateTrackSubtitlesResponse.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Created | - |

<a name="getAsset"></a>
# **getAsset**
> AssetResponse getAsset(ASSET_ID).execute();
Expand Down Expand Up @@ -730,7 +804,7 @@ Name | Type | Description | Notes
# **updateAsset**
> AssetResponse updateAsset(ASSET_ID, updateAssetRequest).execute();
Update an Asset
Update an asset

Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the &#x60;passthrough&#x60; field.

Expand Down
4 changes: 2 additions & 2 deletions docs/CreateSimulcastTargetRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**passthrough** | **String** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional]
**streamKey** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional]
**url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: &#x60;rtmp://live.example.com/app&#x60;. | [optional]
**streamKey** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations. | [optional]
**url** | **String** | The RTMP(s) or SRT endpoint for a simulcast destination. * For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: &#x60;rtmp://live.example.com/app&#x60;. * For SRT destinations, this should be a fully formed SRT connection string, for example: &#x60;srt://srt-live.example.com:1234?streamid&#x3D;{stream_key}&amp;passphrase&#x3D;{srt_passphrase}&#x60;. Note: SRT simulcast targets can only be used when an source is connected over SRT. | [optional]



2 changes: 1 addition & 1 deletion docs/DirectUploadsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public class Example {
accessToken.setPassword("YOUR PASSWORD");

DirectUploadsApi apiInstance = new DirectUploadsApi(defaultClient);
CreateUploadRequest createUploadRequest = {"cors_origin":"https://example.com/","new_asset_settings":{"playback_policy":["public"],"mp4_support":"standard"}}; // CreateUploadRequest |
CreateUploadRequest createUploadRequest = {"cors_origin":"https://example.com/","new_asset_settings":{"playback_policy":["public"]}}; // CreateUploadRequest |
try {
UploadResponse result = apiInstance.createDirectUpload(createUploadRequest)
.execute();
Expand Down
1 change: 1 addition & 0 deletions docs/Error.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**description** | **String** | Description of the error. | [optional]
**count** | **Long** | The total number of views that experienced this error. | [optional]
**code** | **Long** | The error code | [optional]
**playerErrorCode** | **String** | The string version of the error code | [optional]



12 changes: 12 additions & 0 deletions docs/GenerateTrackSubtitlesRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@


# GenerateTrackSubtitlesRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**generatedSubtitles** | [**java.util.List&lt;AssetGeneratedSubtitleSettings&gt;**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition with this configuration. | [optional]



12 changes: 12 additions & 0 deletions docs/GenerateTrackSubtitlesResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@


# GenerateTrackSubtitlesResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**Track**](Track.md) | | [optional]



Loading

0 comments on commit 34a1bfd

Please sign in to comment.