docs(java): add async and withHttpInfo methods

apivideo · Apr 22, 2024 · 8792a1a · 8792a1a
1 parent baf734a
commit 8792a1a
Show file tree

Hide file tree

Showing 10 changed files with 106 additions and 48 deletions.
diff --git a/docs/AdvancedAuthenticationApi.md b/docs/AdvancedAuthenticationApi.md
@@ -11,7 +11,8 @@ Method | HTTP request | Description
 <a name="authenticate"></a>
 # **authenticate**
 > AccessToken authenticate(authenticatePayload)
-
+> okhttp3.Call authenticateAsync(authenticatePayload, callback)
+> ApiResponse<AccessToken> authenticateWithHttpInfo(authenticatePayload)
 Get Bearer Token
 
 Returns a bearer token that can be used to authenticate other endpoint.  You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).
@@ -80,7 +81,8 @@ No authorization required
 <a name="refresh"></a>
 # **refresh**
 > AccessToken refresh(refreshTokenPayload)
-
+> okhttp3.Call refreshAsync(refreshTokenPayload, callback)
+> ApiResponse<AccessToken> refreshWithHttpInfo(refreshTokenPayload)
 Refresh Bearer Token
 
 Accepts the old bearer token and returns a new bearer token that can be used to authenticate other endpoint.  You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).

diff --git a/docs/AnalyticsApi.md b/docs/AnalyticsApi.md
@@ -10,7 +10,9 @@ Method | HTTP request | Description
 
 <a name="getLiveStreamsPlays"></a>
 # **getLiveStreamsPlays**
-> AnalyticsPlaysResponse getLiveStreamsPlays(from, dimension).to(to).filter(filter).currentPage(currentPage).pageSize(pageSize).execute();
+> AnalyticsPlaysResponse getLiveStreamsPlays(from, dimension).to(to).filter(filter).currentPage(currentPage).pageSize(pageSize).execute()
+> ApiResponse<AnalyticsPlaysResponse> executeWithHttpInfo()
+> okhttp3.Call executeAsync(callback) 
 
 Get play events for live stream
 
@@ -95,7 +97,9 @@ Name | Type | Description  | Notes
 
 <a name="getVideosPlays"></a>
 # **getVideosPlays**
-> AnalyticsPlaysResponse getVideosPlays(from, dimension).to(to).filter(filter).currentPage(currentPage).pageSize(pageSize).execute();
+> AnalyticsPlaysResponse getVideosPlays(from, dimension).to(to).filter(filter).currentPage(currentPage).pageSize(pageSize).execute()
+> ApiResponse<AnalyticsPlaysResponse> executeWithHttpInfo()
+> okhttp3.Call executeAsync(callback) 
 
 Get play events for video
 

diff --git a/docs/CaptionsApi.md b/docs/CaptionsApi.md
@@ -14,7 +14,8 @@ Method | HTTP request | Description
 <a name="upload"></a>
 # **upload**
 > Caption upload(videoId, language, file)
-
+> okhttp3.Call uploadAsync(videoId, language, file, callback)
+> ApiResponse<Caption> uploadWithHttpInfo(videoId, language, file)
 Upload a caption
 
 Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/vod/add-captions)
@@ -87,7 +88,8 @@ Name | Type | Description  | Notes
 <a name="get"></a>
 # **get**
 > Caption get(videoId, language)
-
+> okhttp3.Call getAsync(videoId, language, callback)
+> ApiResponse<Caption> getWithHttpInfo(videoId, language)
 Retrieve a caption
 
 Retrieve a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a error indicating the caption was not found.
@@ -160,7 +162,8 @@ Name | Type | Description  | Notes
 <a name="update"></a>
 # **update**
 > Caption update(videoId, language, captionsUpdatePayload)
-
+> okhttp3.Call updateAsync(videoId, language, captionsUpdatePayload, callback)
+> ApiResponse<Caption> updateWithHttpInfo(videoId, language, captionsUpdatePayload)
 Update a caption
 
 To have the captions on automatically, use this method to set default: true.
@@ -235,7 +238,8 @@ Name | Type | Description  | Notes
 <a name="delete"></a>
 # **delete**
 > delete(videoId, language)
-
+> okhttp3.Call deleteAsync(videoId, language, callback)
+> ApiResponse<Void> deleteWithHttpInfo(videoId, language)
 Delete a caption
 
 Delete a caption in a specific language by by video id.
@@ -304,7 +308,9 @@ null (empty response body)
 
 <a name="list"></a>
 # **list**
-> CaptionsListResponse list(videoId).currentPage(currentPage).pageSize(pageSize).execute();
+> CaptionsListResponse list(videoId).currentPage(currentPage).pageSize(pageSize).execute()
+> ApiResponse<CaptionsListResponse> executeWithHttpInfo()
+> okhttp3.Call executeAsync(callback) 
 
 List video captions
 

diff --git a/docs/ChaptersApi.md b/docs/ChaptersApi.md
@@ -13,7 +13,8 @@ Method | HTTP request | Description
 <a name="upload"></a>
 # **upload**
 > Chapter upload(videoId, language, file)
-
+> okhttp3.Call uploadAsync(videoId, language, file, callback)
+> ApiResponse<Chapter> uploadWithHttpInfo(videoId, language, file)
 Upload a chapter
 
 Upload a VTT file to add chapters to your video. Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos/) for more details.
@@ -86,7 +87,8 @@ Name | Type | Description  | Notes
 <a name="get"></a>
 # **get**
 > Chapter get(videoId, language)
-
+> okhttp3.Call getAsync(videoId, language, callback)
+> ApiResponse<Chapter> getWithHttpInfo(videoId, language)
 Retrieve a chapter
 
 Retrieve a chapter for by video id in a specific language. 
@@ -156,7 +158,8 @@ Name | Type | Description  | Notes
 <a name="delete"></a>
 # **delete**
 > delete(videoId, language)
-
+> okhttp3.Call deleteAsync(videoId, language, callback)
+> ApiResponse<Void> deleteWithHttpInfo(videoId, language)
 Delete a chapter
 
 Delete a chapter in a specific language by providing the video ID for the video you want to delete the chapter from and the language the chapter is in.
@@ -224,7 +227,9 @@ null (empty response body)
 
 <a name="list"></a>
 # **list**
-> ChaptersListResponse list(videoId).currentPage(currentPage).pageSize(pageSize).execute();
+> ChaptersListResponse list(videoId).currentPage(currentPage).pageSize(pageSize).execute()
+> ApiResponse<ChaptersListResponse> executeWithHttpInfo()
+> okhttp3.Call executeAsync(callback) 
 
 List video chapters
 

diff --git a/docs/LiveStreamsApi.md b/docs/LiveStreamsApi.md
@@ -16,7 +16,8 @@ Method | HTTP request | Description
 <a name="create"></a>
 # **create**
 > LiveStream create(liveStreamCreationPayload)
-
+> okhttp3.Call createAsync(liveStreamCreationPayload, callback)
+> ApiResponse<LiveStream> createWithHttpInfo(liveStreamCreationPayload)
 Create live stream
 
 Creates a livestream object.
@@ -89,7 +90,8 @@ Name | Type | Description  | Notes
 <a name="get"></a>
 # **get**
 > LiveStream get(liveStreamId)
-
+> okhttp3.Call getAsync(liveStreamId, callback)
+> ApiResponse<LiveStream> getWithHttpInfo(liveStreamId)
 Retrieve live stream
 
 Get a livestream by id.
@@ -156,7 +158,8 @@ Name | Type | Description  | Notes
 <a name="update"></a>
 # **update**
 > LiveStream update(liveStreamId, liveStreamUpdatePayload)
-
+> okhttp3.Call updateAsync(liveStreamId, liveStreamUpdatePayload, callback)
+> ApiResponse<LiveStream> updateWithHttpInfo(liveStreamId, liveStreamUpdatePayload)
 Update a live stream
 
 Updates the livestream object.
@@ -231,7 +234,8 @@ Name | Type | Description  | Notes
 <a name="delete"></a>
 # **delete**
 > delete(liveStreamId)
-
+> okhttp3.Call deleteAsync(liveStreamId, callback)
+> ApiResponse<Void> deleteWithHttpInfo(liveStreamId)
 Delete a live stream
 
 If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.
@@ -296,7 +300,9 @@ null (empty response body)
 
 <a name="list"></a>
 # **list**
-> LiveStreamListResponse list().streamKey(streamKey).name(name).sortBy(sortBy).sortOrder(sortOrder).currentPage(currentPage).pageSize(pageSize).execute();
+> LiveStreamListResponse list().streamKey(streamKey).name(name).sortBy(sortBy).sortOrder(sortOrder).currentPage(currentPage).pageSize(pageSize).execute()
+> ApiResponse<LiveStreamListResponse> executeWithHttpInfo()
+> okhttp3.Call executeAsync(callback) 
 
 List all live streams
 
@@ -381,7 +387,8 @@ Name | Type | Description  | Notes
 <a name="uploadThumbnail"></a>
 # **uploadThumbnail**
 > LiveStream uploadThumbnail(liveStreamId, file)
-
+> okhttp3.Call uploadThumbnailAsync(liveStreamId, file, callback)
+> ApiResponse<LiveStream> uploadThumbnailWithHttpInfo(liveStreamId, file)
 Upload a thumbnail
 
 Upload the thumbnail for the livestream.
@@ -452,7 +459,8 @@ Name | Type | Description  | Notes
 <a name="deleteThumbnail"></a>
 # **deleteThumbnail**
 > LiveStream deleteThumbnail(liveStreamId)
-
+> okhttp3.Call deleteThumbnailAsync(liveStreamId, callback)
+> ApiResponse<LiveStream> deleteThumbnailWithHttpInfo(liveStreamId)
 Delete a thumbnail
 
 Send the unique identifier for a live stream to delete its thumbnail.

diff --git a/docs/PlayerThemesApi.md b/docs/PlayerThemesApi.md
@@ -16,7 +16,8 @@ Method | HTTP request | Description
 <a name="create"></a>
 # **create**
 > PlayerTheme create(playerThemeCreationPayload)
-
+> okhttp3.Call createAsync(playerThemeCreationPayload, callback)
+> ApiResponse<PlayerTheme> createWithHttpInfo(playerThemeCreationPayload)
 Create a player
 
 Create a player for your video, and customise it.
@@ -100,7 +101,8 @@ Name | Type | Description  | Notes
 <a name="get"></a>
 # **get**
 > PlayerTheme get(playerId)
-
+> okhttp3.Call getAsync(playerId, callback)
+> ApiResponse<PlayerTheme> getWithHttpInfo(playerId)
 Retrieve a player
 
 Retreive a player theme by player id.
@@ -168,7 +170,8 @@ Name | Type | Description  | Notes
 <a name="update"></a>
 # **update**
 > PlayerTheme update(playerId, playerThemeUpdatePayload)
-
+> okhttp3.Call updateAsync(playerId, playerThemeUpdatePayload, callback)
+> ApiResponse<PlayerTheme> updateWithHttpInfo(playerId, playerThemeUpdatePayload)
 Update a player
 
 Use a player ID to update specific details for a player.  NOTE: It may take up to 10 min before the new player configuration is available from our CDN.
@@ -255,7 +258,8 @@ Name | Type | Description  | Notes
 <a name="delete"></a>
 # **delete**
 > delete(playerId)
-
+> okhttp3.Call deleteAsync(playerId, callback)
+> ApiResponse<Void> deleteWithHttpInfo(playerId)
 Delete a player
 
 Delete a player if you no longer need it. You can delete any player that you have the player ID for.
@@ -321,7 +325,9 @@ null (empty response body)
 
 <a name="list"></a>
 # **list**
-> PlayerThemesListResponse list().sortBy(sortBy).sortOrder(sortOrder).currentPage(currentPage).pageSize(pageSize).execute();
+> PlayerThemesListResponse list().sortBy(sortBy).sortOrder(sortOrder).currentPage(currentPage).pageSize(pageSize).execute()
+> ApiResponse<PlayerThemesListResponse> executeWithHttpInfo()
+> okhttp3.Call executeAsync(callback) 
 
 List all player themes
 
@@ -401,7 +407,8 @@ Name | Type | Description  | Notes
 <a name="uploadLogo"></a>
 # **uploadLogo**
 > PlayerTheme uploadLogo(playerId, file, link)
-
+> okhttp3.Call uploadLogoAsync(playerId, file, link, callback)
+> ApiResponse<PlayerTheme> uploadLogoWithHttpInfo(playerId, file, link)
 Upload a logo
 
 Upload an image file as a logo for your player. The image should fit within these constraints: - The image mime type must be `image/jpeg` or `image/png`. api.video recommends using `png` images with transparent background. - The image size should be a maximum of 200px width x 100px. - The file size should be a maximum of 100 KiB. 
@@ -474,7 +481,8 @@ Name | Type | Description  | Notes
 <a name="deleteLogo"></a>
 # **deleteLogo**
 > deleteLogo(playerId)
-
+> okhttp3.Call deleteLogoAsync(playerId, callback)
+> ApiResponse<Void> deleteLogoWithHttpInfo(playerId)
 Delete logo
 
 Delete the logo associated to a player.

diff --git a/docs/UploadTokensApi.md b/docs/UploadTokensApi.md
@@ -13,7 +13,8 @@ Method | HTTP request | Description
 <a name="createToken"></a>
 # **createToken**
 > UploadToken createToken(tokenCreationPayload)
-
+> okhttp3.Call createTokenAsync(tokenCreationPayload, callback)
+> ApiResponse<UploadToken> createTokenWithHttpInfo(tokenCreationPayload)
 Generate an upload token
 
 Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/vod/delegated-upload-tokens)
@@ -83,7 +84,8 @@ Name | Type | Description  | Notes
 <a name="getToken"></a>
 # **getToken**
 > UploadToken getToken(uploadToken)
-
+> okhttp3.Call getTokenAsync(uploadToken, callback)
+> ApiResponse<UploadToken> getTokenWithHttpInfo(uploadToken)
 Retrieve upload token
 
 Retrieve details about a specific upload token by id.
@@ -151,7 +153,8 @@ Name | Type | Description  | Notes
 <a name="deleteToken"></a>
 # **deleteToken**
 > deleteToken(uploadToken)
-
+> okhttp3.Call deleteTokenAsync(uploadToken, callback)
+> ApiResponse<Void> deleteTokenWithHttpInfo(uploadToken)
 Delete an upload token
 
 Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.
@@ -217,7 +220,9 @@ null (empty response body)
 
 <a name="list"></a>
 # **list**
-> TokenListResponse list().sortBy(sortBy).sortOrder(sortOrder).currentPage(currentPage).pageSize(pageSize).execute();
+> TokenListResponse list().sortBy(sortBy).sortOrder(sortOrder).currentPage(currentPage).pageSize(pageSize).execute()
+> ApiResponse<TokenListResponse> executeWithHttpInfo()
+> okhttp3.Call executeAsync(callback) 
 
 List all active upload tokens