Prep for 5.1.0 (#51)

* Regen from latest openapi spec * Remember to bump version
muxinc · Dec 4, 2023 · 541c182 · 541c182
1 parent 29b3ddf
commit 541c182
Show file tree

Hide file tree

Showing 76 changed files with 1,200 additions and 72 deletions.
diff --git a/api_web_inputs.go b/api_web_inputs.go
diff --git a/client.go b/client.go
@@ -56,6 +56,7 @@ type APIClient struct {
 	TranscriptionVocabulariesApi *TranscriptionVocabulariesApiService
 	URLSigningKeysApi            *URLSigningKeysApiService
 	VideoViewsApi                *VideoViewsApiService
+	WebInputsApi                 *WebInputsApiService
 }
 
 type service struct {
@@ -91,6 +92,7 @@ func NewAPIClient(cfg *Configuration) *APIClient {
 	c.TranscriptionVocabulariesApi = (*TranscriptionVocabulariesApiService)(&c.common)
 	c.URLSigningKeysApi = (*URLSigningKeysApiService)(&c.common)
 	c.VideoViewsApi = (*VideoViewsApiService)(&c.common)
+	c.WebInputsApi = (*WebInputsApiService)(&c.common)
 
 	return c
 }

diff --git a/configuration.go b/configuration.go
@@ -22,7 +22,7 @@ type ConfigurationOption func(*Configuration)
 func NewConfiguration(opts ...ConfigurationOption) *Configuration {
 	cfg := &Configuration{
 		basePath:  "https://api.mux.com",
-		userAgent: "Mux Go | 5.0.2",
+		userAgent: "Mux Go | 5.1.0",
 	}
 	for _, opt := range opts {
 		opt(cfg)

diff --git a/docs/Asset.md b/docs/Asset.md
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 **MaxStoredResolution** | **string** | This field is deprecated. Please use &#x60;resolution_tier&#x60; 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. | [optional] 
 **ResolutionTier** | **string** | The resolution tier that the asset was ingested at, affecting billing for ingest &amp; 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. | [optional] 
 **MaxResolutionTier** | **string** | Max resolution tier can be used to control the maximum &#x60;resolution_tier&#x60; your asset is encoded, stored, and streamed at. If not set, this defaults to &#x60;1080p&#x60;. | [optional] 
-**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the &#x60;smart&#x60; encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/video/use-encoding-tiers) | [optional] 
+**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the &#x60;smart&#x60; encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] 
 **MaxStoredFrameRate** | **float64** | 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. | [optional] 
 **AspectRatio** | **string** | The aspect ratio of the asset in the form of &#x60;width:height&#x60;, for example &#x60;16:9&#x60;. | [optional] 
-**PlaybackIds** | [**[]PlaybackId**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] 
+**PlaybackIds** | [**[]PlaybackId**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details. | [optional] 
 **Tracks** | [**[]Track**](Track.md) | The individual media tracks that make up an asset. | [optional] 
 **Errors** | [**AssetErrors**](Asset_errors.md) |  | [optional] 
 **PerTitleEncode** | **bool** |  | [optional] 

diff --git a/docs/BreakdownValue.md b/docs/BreakdownValue.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **Views** | **int64** |  | [optional] 
 **Value** | **float64** |  | [optional] 
 **TotalWatchTime** | **int64** |  | [optional] 
+**TotalPlayingTime** | **int64** |  | [optional] 
 **NegativeImpact** | **int32** |  | [optional] 
 **Field** | **string** |  | [optional] 
 

diff --git a/docs/CreateAssetRequest.md b/docs/CreateAssetRequest.md
@@ -7,12 +7,12 @@ Name | Type | Description | Notes
 **PlaybackPolicy** | [**[]PlaybackPolicy**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through &#x60;playback_ids&#x60;. Options include: &#x60;\&quot;public\&quot;&#x60; (anyone with the playback URL can stream the asset). And &#x60;\&quot;signed\&quot;&#x60; (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] 
 **PerTitleEncode** | **bool** |  | [optional] 
 **Passthrough** | **string** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] 
-**Mp4Support** | **string** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers&#39; connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] 
+**Mp4Support** | **string** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers&#39; connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] 
 **NormalizeAudio** | **bool** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
-**MasterAccess** | **string** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] 
+**MasterAccess** | **string** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] 
 **Test** | **bool** | Marks the asset as a test asset when the value is set to true. 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 asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional] 
 **MaxResolutionTier** | **string** | Max resolution tier can be used to control the maximum &#x60;resolution_tier&#x60; your asset is encoded, stored, and streamed at. If not set, this defaults to &#x60;1080p&#x60;. | [optional] 
-**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the &#x60;smart&#x60; encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/video/use-encoding-tiers) | [optional] 
+**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the &#x60;smart&#x60; encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/CreateLiveStreamRequest.md b/docs/CreateLiveStreamRequest.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **GeneratedSubtitles** | [**[]LiveStreamGeneratedSubtitleSettings**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with &#x60;generated_subtitles&#x60; configured will automatically receive two text tracks. The first of these will have a &#x60;text_source&#x60; value of &#x60;generated_live&#x60;, and will be available with &#x60;ready&#x60; status as soon as the stream is live. The second text track will have a &#x60;text_source&#x60; value of &#x60;generated_live_final&#x60; and will contain subtitles with improved accuracy, timing, and formatting. However, &#x60;generated_live_final&#x60; tracks will not be available in &#x60;ready&#x60; status until the live stream ends. If an Asset has both &#x60;generated_live&#x60; and &#x60;generated_live_final&#x60; tracks that are &#x60;ready&#x60;, then only the &#x60;generated_live_final&#x60; track will be included during playback. | [optional] 
 **ReducedLatency** | **bool** | This field is deprecated. Please use &#x60;latency_mode&#x60; instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] 
 **LowLatency** | **bool** | This field is deprecated. Please use &#x60;latency_mode&#x60; instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] 
-**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] 
+**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. | [optional] 
 **Test** | **bool** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] 
 **SimulcastTargets** | [**[]CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md) |  | [optional] 
 **MaxContinuousDuration** | **int32** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200]

diff --git a/docs/CreateSimulcastTargetRequest.md b/docs/CreateSimulcastTargetRequest.md
@@ -5,7 +5,7 @@ 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;. | 
+**Url** | **string** | RTMP hostname including application name for the third party live streaming service. Example: &#x60;rtmp://live.example.com/app&#x60;. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/CreateUploadRequest.md b/docs/CreateUploadRequest.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Timeout** | **int32** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked &#x60;timed_out&#x60; | [optional] [default to 3600]
 **CorsOrigin** | **string** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] 
-**NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | 
+**NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] 
 **Test** | **bool** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/CreateWebInputRequest.md b/docs/CreateWebInputRequest.md
@@ -0,0 +1,18 @@
+# CreateWebInputRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Id** | **string** | Unique identifier for the Web Input. | [optional] 
+**CreatedAt** | **string** | Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). | [optional] 
+**Url** | **string** | The URL for the Web Input to load. | [optional] 
+**AutoLaunch** | **bool** | When set to &#x60;true&#x60; the Web Input will automatically launch and start streaming immediately after creation | [optional] 
+**LiveStreamId** | **string** | The Live Stream ID to broadcast this Web Input to | [optional] 
+**Status** | **string** |  | [optional] 
+**Passthrough** | **string** | Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. **Max: 255 characters**. | [optional] 
+**Resolution** | **string** | The resolution of the viewport of the Web Input&#39;s browser instance. Defaults to 1920x1080 if not set. | [optional] [default to RESOLUTION__1920X1080]
+**Timeout** | **int32** | The number of seconds that the Web Input should stream for before automatically shutting down. | [optional] [default to 3600]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/Error.md b/docs/Error.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **Message** | **string** | The error message. | [optional] 
 **LastSeen** | **string** | The last time this error was seen (ISO 8601 timestamp). | [optional] 
 **Description** | **string** | Description of the error. | [optional] 
-**Count** | **int64** | The total number of views that experiend this error. | [optional] 
+**Count** | **int64** | The total number of views that experienced this error. | [optional] 
 **Code** | **int64** | The error code | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/GetMetricTimeseriesDataResponse.md b/docs/GetMetricTimeseriesDataResponse.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **Data** | [**[][]string**](array.md) |  | [optional] 
 **TotalRowCount** | **int64** |  | [optional] 
 **Timeframe** | **[]int64** |  | [optional] 
+**Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponse_meta.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/GetMonitoringHistogramTimeseriesResponseMeta.md b/docs/GetMonitoringHistogramTimeseriesResponseMeta.md
@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**BucketUnit** | **string** |  | [optional] 
 **Buckets** | [**[]MonitoringHistogramTimeseriesBucket**](MonitoringHistogramTimeseriesBucket.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/GetOverallValuesResponse.md b/docs/GetOverallValuesResponse.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **Data** | [**OverallValues**](OverallValues.md) |  | [optional] 
 **TotalRowCount** | **int64** |  | [optional] 
 **Timeframe** | **[]int64** |  | [optional] 
+**Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponse_meta.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/GetRealTimeHistogramTimeseriesResponseMeta.md b/docs/GetRealTimeHistogramTimeseriesResponseMeta.md
@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**BucketUnit** | **string** |  | [optional] 
 **Buckets** | [**[]RealTimeHistogramTimeseriesBucket**](RealTimeHistogramTimeseriesBucket.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/IncidentResponse.md b/docs/IncidentResponse.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [**Incident**](Incident.md) |  | [optional] 
+**TotalRowCount** | **int64** |  | [optional] 
 **Timeframe** | **[]int64** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)