|
| 1 | +# Go API client for muxvideosdk |
| 2 | + |
| 3 | +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) |
| 4 | + |
| 5 | +## Overview |
| 6 | +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. |
| 7 | + |
| 8 | +- API version: v1 |
| 9 | +- Package version: 1.0.0 |
| 10 | +- Build package: org.openapitools.codegen.languages.GoClientCodegen |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +Install the following dependencies: |
| 15 | +``` |
| 16 | +go get github.com/stretchr/testify/assert |
| 17 | +go get golang.org/x/oauth2 |
| 18 | +go get golang.org/x/net/context |
| 19 | +go get github.com/antihax/optional |
| 20 | +``` |
| 21 | + |
| 22 | +Put the package under your project folder and add the following in import: |
| 23 | +```golang |
| 24 | +import "./muxvideosdk" |
| 25 | +``` |
| 26 | + |
| 27 | +## Documentation for API Endpoints |
| 28 | + |
| 29 | +All URIs are relative to *https://api.mux.com* |
| 30 | + |
| 31 | +Class | Method | HTTP request | Description |
| 32 | +------------ | ------------- | ------------- | ------------- |
| 33 | +*AssetsApi* | [**CreateAsset**](docs/AssetsApi.md#createasset) | **Post** /video/v1/assets | Create an asset |
| 34 | +*AssetsApi* | [**CreateAssetPlaybackId**](docs/AssetsApi.md#createassetplaybackid) | **Post** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID |
| 35 | +*AssetsApi* | [**DeleteAsset**](docs/AssetsApi.md#deleteasset) | **Delete** /video/v1/assets/{ASSET_ID} | Delete an asset |
| 36 | +*AssetsApi* | [**DeleteAssetPlaybackId**](docs/AssetsApi.md#deleteassetplaybackid) | **Delete** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID |
| 37 | +*AssetsApi* | [**GetAsset**](docs/AssetsApi.md#getasset) | **Get** /video/v1/assets/{ASSET_ID} | Retrieve an asset |
| 38 | +*AssetsApi* | [**GetAssetInputInfo**](docs/AssetsApi.md#getassetinputinfo) | **Get** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info |
| 39 | +*AssetsApi* | [**GetAssetPlaybackId**](docs/AssetsApi.md#getassetplaybackid) | **Get** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID |
| 40 | +*AssetsApi* | [**ListAssets**](docs/AssetsApi.md#listassets) | **Get** /video/v1/assets | List assets |
| 41 | +*AssetsApi* | [**UpdateAssetMp4Support**](docs/AssetsApi.md#updateassetmp4support) | **Put** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support |
| 42 | +*DirectUploadsApi* | [**CancelDirectUpload**](docs/DirectUploadsApi.md#canceldirectupload) | **Put** /video/v1/uploads/{UPLOAD_ID}/cancel | Cancel a direct upload |
| 43 | +*DirectUploadsApi* | [**CreateDirectUpload**](docs/DirectUploadsApi.md#createdirectupload) | **Post** /video/v1/uploads | Create a new direct upload URL |
| 44 | +*DirectUploadsApi* | [**GetDirectUpload**](docs/DirectUploadsApi.md#getdirectupload) | **Get** /video/v1/uploads/{UPLOAD_ID} | Retrieve a single direct upload's info |
| 45 | +*DirectUploadsApi* | [**ListDirectUploads**](docs/DirectUploadsApi.md#listdirectuploads) | **Get** /video/v1/uploads | List direct uploads |
| 46 | +*ErrorsApi* | [**ListErrors**](docs/ErrorsApi.md#listerrors) | **Get** /data/v1/errors | List Errors |
| 47 | +*ExportsApi* | [**ListExports**](docs/ExportsApi.md#listexports) | **Get** /data/v1/exports | List property video view export links |
| 48 | +*FiltersApi* | [**ListFilterValues**](docs/FiltersApi.md#listfiltervalues) | **Get** /data/v1/filters/{FILTER_ID} | Lists values for a specific filter |
| 49 | +*FiltersApi* | [**ListFilters**](docs/FiltersApi.md#listfilters) | **Get** /data/v1/filters | List Filters |
| 50 | +*LiveStreamsApi* | [**CreateLiveStream**](docs/LiveStreamsApi.md#createlivestream) | **Post** /video/v1/live-streams | Create a live stream |
| 51 | +*LiveStreamsApi* | [**CreateLiveStreamPlaybackId**](docs/LiveStreamsApi.md#createlivestreamplaybackid) | **Post** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids | Create a live stream playback ID |
| 52 | +*LiveStreamsApi* | [**DeleteLiveStream**](docs/LiveStreamsApi.md#deletelivestream) | **Delete** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream |
| 53 | +*LiveStreamsApi* | [**DeleteLiveStreamPlaybackId**](docs/LiveStreamsApi.md#deletelivestreamplaybackid) | **Delete** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID |
| 54 | +*LiveStreamsApi* | [**GetLiveStream**](docs/LiveStreamsApi.md#getlivestream) | **Get** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream |
| 55 | +*LiveStreamsApi* | [**ListLiveStreams**](docs/LiveStreamsApi.md#listlivestreams) | **Get** /video/v1/live-streams | List live streams |
| 56 | +*LiveStreamsApi* | [**ResetStreamKey**](docs/LiveStreamsApi.md#resetstreamkey) | **Post** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key |
| 57 | +*LiveStreamsApi* | [**SignalLiveStreamComplete**](docs/LiveStreamsApi.md#signallivestreamcomplete) | **Put** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished |
| 58 | +*MetricsApi* | [**GetMetricTimeseriesData**](docs/MetricsApi.md#getmetrictimeseriesdata) | **Get** /data/v1/metrics/{METRIC_ID}/timeseries | Get metric timeseries data |
| 59 | +*MetricsApi* | [**GetOverallValues**](docs/MetricsApi.md#getoverallvalues) | **Get** /data/v1/metrics/{METRIC_ID}/overall | Get Overall values |
| 60 | +*MetricsApi* | [**ListAllMetricValues**](docs/MetricsApi.md#listallmetricvalues) | **Get** /data/v1/metrics/comparison | List all metric values |
| 61 | +*MetricsApi* | [**ListBreakdownValues**](docs/MetricsApi.md#listbreakdownvalues) | **Get** /data/v1/metrics/{METRIC_ID}/breakdown | List breakdown values |
| 62 | +*MetricsApi* | [**ListInsights**](docs/MetricsApi.md#listinsights) | **Get** /data/v1/metrics/{METRIC_ID}/insights | List Insights |
| 63 | +*URLSigningKeysApi* | [**CreateUrlSigningKey**](docs/URLSigningKeysApi.md#createurlsigningkey) | **Post** /video/v1/signing-keys | Create a URL signing key |
| 64 | +*URLSigningKeysApi* | [**DeleteUrlSigningKey**](docs/URLSigningKeysApi.md#deleteurlsigningkey) | **Delete** /video/v1/signing-keys/{SIGNING_KEY_ID} | Delete a URL signing key |
| 65 | +*URLSigningKeysApi* | [**GetUrlSigningKey**](docs/URLSigningKeysApi.md#geturlsigningkey) | **Get** /video/v1/signing-keys/{SIGNING_KEY_ID} | Retrieve a URL signing key |
| 66 | +*URLSigningKeysApi* | [**ListUrlSigningKeys**](docs/URLSigningKeysApi.md#listurlsigningkeys) | **Get** /video/v1/signing-keys | List URL signing keys |
| 67 | +*VideoViewsApi* | [**GetVideoView**](docs/VideoViewsApi.md#getvideoview) | **Get** /data/v1/video-views/{VIDEO_VIEW_ID} | Get a Video View |
| 68 | +*VideoViewsApi* | [**ListVideoViews**](docs/VideoViewsApi.md#listvideoviews) | **Get** /data/v1/video-views | List Video Views |
| 69 | + |
| 70 | + |
| 71 | +## Documentation For Models |
| 72 | + |
| 73 | + - [AbridgedVideoView](docs/AbridgedVideoView.md) |
| 74 | + - [Asset](docs/Asset.md) |
| 75 | + - [AssetErrors](docs/AssetErrors.md) |
| 76 | + - [AssetMaster](docs/AssetMaster.md) |
| 77 | + - [AssetResponse](docs/AssetResponse.md) |
| 78 | + - [AssetStaticRenditions](docs/AssetStaticRenditions.md) |
| 79 | + - [AssetStaticRenditionsFiles](docs/AssetStaticRenditionsFiles.md) |
| 80 | + - [BreakdownValue](docs/BreakdownValue.md) |
| 81 | + - [CreateAssetRequest](docs/CreateAssetRequest.md) |
| 82 | + - [CreateLiveStreamRequest](docs/CreateLiveStreamRequest.md) |
| 83 | + - [CreatePlaybackIdRequest](docs/CreatePlaybackIdRequest.md) |
| 84 | + - [CreatePlaybackIdResponse](docs/CreatePlaybackIdResponse.md) |
| 85 | + - [CreateUploadRequest](docs/CreateUploadRequest.md) |
| 86 | + - [Error](docs/Error.md) |
| 87 | + - [FilterValue](docs/FilterValue.md) |
| 88 | + - [GetAssetInputInfoResponse](docs/GetAssetInputInfoResponse.md) |
| 89 | + - [GetAssetPlaybackIdResponse](docs/GetAssetPlaybackIdResponse.md) |
| 90 | + - [GetMetricTimeseriesDataResponse](docs/GetMetricTimeseriesDataResponse.md) |
| 91 | + - [GetOverallValuesResponse](docs/GetOverallValuesResponse.md) |
| 92 | + - [InputFile](docs/InputFile.md) |
| 93 | + - [InputInfo](docs/InputInfo.md) |
| 94 | + - [InputSettings](docs/InputSettings.md) |
| 95 | + - [InputSettingsOverlaySettings](docs/InputSettingsOverlaySettings.md) |
| 96 | + - [InputTrack](docs/InputTrack.md) |
| 97 | + - [Insight](docs/Insight.md) |
| 98 | + - [ListAllMetricValuesResponse](docs/ListAllMetricValuesResponse.md) |
| 99 | + - [ListAssetsResponse](docs/ListAssetsResponse.md) |
| 100 | + - [ListBreakdownValuesResponse](docs/ListBreakdownValuesResponse.md) |
| 101 | + - [ListErrorsResponse](docs/ListErrorsResponse.md) |
| 102 | + - [ListExportsResponse](docs/ListExportsResponse.md) |
| 103 | + - [ListFilterValuesResponse](docs/ListFilterValuesResponse.md) |
| 104 | + - [ListFiltersResponse](docs/ListFiltersResponse.md) |
| 105 | + - [ListFiltersResponseData](docs/ListFiltersResponseData.md) |
| 106 | + - [ListInsightsResponse](docs/ListInsightsResponse.md) |
| 107 | + - [ListLiveStreamsResponse](docs/ListLiveStreamsResponse.md) |
| 108 | + - [ListSigningKeysResponse](docs/ListSigningKeysResponse.md) |
| 109 | + - [ListUploadsResponse](docs/ListUploadsResponse.md) |
| 110 | + - [ListVideoViewsResponse](docs/ListVideoViewsResponse.md) |
| 111 | + - [LiveStream](docs/LiveStream.md) |
| 112 | + - [LiveStreamResponse](docs/LiveStreamResponse.md) |
| 113 | + - [Metric](docs/Metric.md) |
| 114 | + - [OverallValues](docs/OverallValues.md) |
| 115 | + - [PlaybackId](docs/PlaybackId.md) |
| 116 | + - [PlaybackPolicy](docs/PlaybackPolicy.md) |
| 117 | + - [Score](docs/Score.md) |
| 118 | + - [SignalLiveStreamCompleteResponse](docs/SignalLiveStreamCompleteResponse.md) |
| 119 | + - [SigningKey](docs/SigningKey.md) |
| 120 | + - [SigningKeyResponse](docs/SigningKeyResponse.md) |
| 121 | + - [Track](docs/Track.md) |
| 122 | + - [UpdateAssetMp4SupportRequest](docs/UpdateAssetMp4SupportRequest.md) |
| 123 | + - [Upload](docs/Upload.md) |
| 124 | + - [UploadError](docs/UploadError.md) |
| 125 | + - [UploadResponse](docs/UploadResponse.md) |
| 126 | + - [VideoView](docs/VideoView.md) |
| 127 | + - [VideoViewEvent](docs/VideoViewEvent.md) |
| 128 | + - [VideoViewResponse](docs/VideoViewResponse.md) |
| 129 | + |
| 130 | + |
| 131 | +## Documentation For Authorization |
| 132 | + |
| 133 | +## accessToken |
| 134 | +- **Type**: HTTP basic authentication |
| 135 | + |
| 136 | +Example |
| 137 | +```golang |
| 138 | +auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ |
| 139 | + UserName: "username", |
| 140 | + Password: "password", |
| 141 | +}) |
| 142 | +r, err := client.Service.Operation(auth, args) |
| 143 | +``` |
| 144 | + |
| 145 | +## Author |
| 146 | + |
| 147 | + |
| 148 | + |
0 commit comments