Add summary feature

apivideo · Oct 18, 2024 · 0c55a8c · 0c55a8c
1 parent 8271979
commit 0c55a8c
Show file tree

Hide file tree

Showing 32 changed files with 1,746 additions and 15 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -30,10 +30,13 @@ docs/CaptionsUpdatePayload.md
 docs/Chapter.md
 docs/ChaptersApi.md
 docs/ChaptersListResponse.md
+docs/ConflictError.md
 docs/DiscardedVideoUpdatePayload.md
 docs/FilterBy.md
 docs/FilterBy1.md
 docs/FilterBy2.md
+docs/GetSummaries.md
+docs/InlineObject.md
 docs/Link.md
 docs/ListTagsResponse.md
 docs/ListTagsResponseData.md
@@ -60,11 +63,15 @@ docs/Quality.md
 docs/RefreshTokenPayload.md
 docs/RestreamsRequestObject.md
 docs/RestreamsResponseObject.md
+docs/SummariesApi.md
+docs/SummaryObject.md
+docs/SummarySource.md
 docs/TagsApi.md
 docs/TokenCreationPayload.md
 docs/TokenListResponse.md
 docs/TooManyRequests.md
 docs/UnrecognizedRequestUrl.md
+docs/UpdateSummaryRequest.md
 docs/UploadToken.md
 docs/UploadTokensApi.md
 docs/Video.md
@@ -100,6 +107,7 @@ src/ApiVideo.Test/Api/CaptionsApiTests.cs
 src/ApiVideo.Test/Api/ChaptersApiTests.cs
 src/ApiVideo.Test/Api/LiveStreamsApiTests.cs
 src/ApiVideo.Test/Api/PlayerThemesApiTests.cs
+src/ApiVideo.Test/Api/SummariesApiTests.cs
 src/ApiVideo.Test/Api/TagsApiTests.cs
 src/ApiVideo.Test/Api/UploadTokensApiTests.cs
 src/ApiVideo.Test/Api/VideosApiTests.cs
@@ -128,10 +136,13 @@ src/ApiVideo.Test/Model/CaptionsListResponseTests.cs
 src/ApiVideo.Test/Model/CaptionsUpdatePayloadTests.cs
 src/ApiVideo.Test/Model/ChapterTests.cs
 src/ApiVideo.Test/Model/ChaptersListResponseTests.cs
+src/ApiVideo.Test/Model/ConflictErrorTests.cs
 src/ApiVideo.Test/Model/DiscardedVideoUpdatePayloadTests.cs
 src/ApiVideo.Test/Model/FilterBy1Tests.cs
 src/ApiVideo.Test/Model/FilterBy2Tests.cs
 src/ApiVideo.Test/Model/FilterByTests.cs
+src/ApiVideo.Test/Model/GetSummariesTests.cs
+src/ApiVideo.Test/Model/InlineObjectTests.cs
 src/ApiVideo.Test/Model/LinkTests.cs
 src/ApiVideo.Test/Model/ListTagsResponseDataTests.cs
 src/ApiVideo.Test/Model/ListTagsResponseTests.cs
@@ -155,10 +166,13 @@ src/ApiVideo.Test/Model/QualityTests.cs
 src/ApiVideo.Test/Model/RefreshTokenPayloadTests.cs
 src/ApiVideo.Test/Model/RestreamsRequestObjectTests.cs
 src/ApiVideo.Test/Model/RestreamsResponseObjectTests.cs
+src/ApiVideo.Test/Model/SummaryObjectTests.cs
+src/ApiVideo.Test/Model/SummarySourceTests.cs
 src/ApiVideo.Test/Model/TokenCreationPayloadTests.cs
 src/ApiVideo.Test/Model/TokenListResponseTests.cs
 src/ApiVideo.Test/Model/TooManyRequestsTests.cs
 src/ApiVideo.Test/Model/UnrecognizedRequestUrlTests.cs
+src/ApiVideo.Test/Model/UpdateSummaryRequestTests.cs
 src/ApiVideo.Test/Model/UploadTokenTests.cs
 src/ApiVideo.Test/Model/VideoAssetsTests.cs
 src/ApiVideo.Test/Model/VideoClipTests.cs
@@ -188,6 +202,7 @@ src/ApiVideo/Api/CaptionsApi.cs
 src/ApiVideo/Api/ChaptersApi.cs
 src/ApiVideo/Api/LiveStreamsApi.cs
 src/ApiVideo/Api/PlayerThemesApi.cs
+src/ApiVideo/Api/SummariesApi.cs
 src/ApiVideo/Api/TagsApi.cs
 src/ApiVideo/Api/UploadTokensApi.cs
 src/ApiVideo/Api/VideosApi.cs
@@ -224,12 +239,15 @@ src/ApiVideo/Model/CaptionsListResponse.cs
 src/ApiVideo/Model/CaptionsUpdatePayload.cs
 src/ApiVideo/Model/Chapter.cs
 src/ApiVideo/Model/ChaptersListResponse.cs
+src/ApiVideo/Model/ConflictError.cs
 src/ApiVideo/Model/DiscardedVideoUpdatePayload.cs
 src/ApiVideo/Model/FilterBy.cs
 src/ApiVideo/Model/FilterBy1.cs
 src/ApiVideo/Model/FilterBy2.cs
+src/ApiVideo/Model/GetSummaries.cs
 src/ApiVideo/Model/IUploadPartProgressListener.cs
 src/ApiVideo/Model/IUploadProgressListener.cs
+src/ApiVideo/Model/InlineObject.cs
 src/ApiVideo/Model/Link.cs
 src/ApiVideo/Model/ListTagsResponse.cs
 src/ApiVideo/Model/ListTagsResponseData.cs
@@ -255,10 +273,13 @@ src/ApiVideo/Model/Quality.cs
 src/ApiVideo/Model/RefreshTokenPayload.cs
 src/ApiVideo/Model/RestreamsRequestObject.cs
 src/ApiVideo/Model/RestreamsResponseObject.cs
+src/ApiVideo/Model/SummaryObject.cs
+src/ApiVideo/Model/SummarySource.cs
 src/ApiVideo/Model/TokenCreationPayload.cs
 src/ApiVideo/Model/TokenListResponse.cs
 src/ApiVideo/Model/TooManyRequests.cs
 src/ApiVideo/Model/UnrecognizedRequestUrl.cs
+src/ApiVideo/Model/UpdateSummaryRequest.cs
 src/ApiVideo/Model/UploadToken.cs
 src/ApiVideo/Model/Video.cs
 src/ApiVideo/Model/VideoAssets.cs

diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
@@ -1 +1 @@
-9d05425d4fb2c3a73804ed5a27232eda6751260b0947f6b4c736cc96df300103
+92f534e12eeb57fda284e0323fdf986652b4cc901acefd85b8c0fdfa9d64fca3
diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@
  - [ChaptersApi](#chaptersapi)
  - [LiveStreamsApi](#livestreamsapi)
  - [PlayerThemesApi](#playerthemesapi)
+ - [SummariesApi](#summariesapi)
  - [TagsApi](#tagsapi)
  - [UploadTokensApi](#uploadtokensapi)
  - [VideosApi](#videosapi)
@@ -259,6 +260,26 @@ Method | HTTP request | Description
 [**deleteLogo**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#deleteLogo) | **DELETE** `/players/{playerId}/logo` | Delete logo
 
 
+#### SummariesApi
+
+
+##### Retrieve an instance of SummariesApi:
+```java
+ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
+SummariesApi summaries = client.Summaries()
+```
+
+##### Endpoints
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummariesApi.md#create) | **POST** `/summaries` | Generate video summary
+[**get**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummariesApi.md#get) | **GET** `/summaries/{summaryId}/source` | Get summary details
+[**update**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummariesApi.md#update) | **PATCH** `/summaries/{summaryId}/source` | Update summary details
+[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummariesApi.md#delete) | **DELETE** `/summaries/{summaryId}` | Delete video summary
+[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummariesApi.md#list) | **GET** `/summaries` | List summaries
+
+
 #### TagsApi
 
 
@@ -384,10 +405,13 @@ Method | HTTP request | Description
  - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsUpdatePayload.md)
  - [Chapter](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Chapter.md)
  - [ChaptersListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ChaptersListResponse.md)
+ - [ConflictError](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ConflictError.md)
  - [DiscardedVideoUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/DiscardedVideoUpdatePayload.md)
  - [FilterBy](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/FilterBy.md)
  - [FilterBy1](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/FilterBy1.md)
  - [FilterBy2](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/FilterBy2.md)
+ - [GetSummaries](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/GetSummaries.md)
+ - [InlineObject](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/InlineObject.md)
  - [Link](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Link.md)
  - [ListTagsResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ListTagsResponse.md)
  - [ListTagsResponseData](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ListTagsResponseData.md)
@@ -411,10 +435,13 @@ Method | HTTP request | Description
  - [RefreshTokenPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RefreshTokenPayload.md)
  - [RestreamsRequestObject](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RestreamsRequestObject.md)
  - [RestreamsResponseObject](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RestreamsResponseObject.md)
+ - [SummaryObject](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummaryObject.md)
+ - [SummarySource](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummarySource.md)
  - [TokenCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TokenCreationPayload.md)
  - [TokenListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TokenListResponse.md)
  - [TooManyRequests](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TooManyRequests.md)
  - [UnrecognizedRequestUrl](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UnrecognizedRequestUrl.md)
+ - [UpdateSummaryRequest](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UpdateSummaryRequest.md)
  - [UploadToken](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadToken.md)
  - [Video](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Video.md)
  - [VideoAssets](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoAssets.md)

diff --git a/docs/ConflictError.md b/docs/ConflictError.md
@@ -0,0 +1,14 @@
+# ApiVideo.Model.ConflictError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Type** | **string** | A link to the error documentation. | [optional] 
+**Title** | **string** | A description of the error that occurred. | [optional] 
+**Name** | **string** | The name of the parameter that caused the error. | [optional] 
+**Status** | **int** | The HTTP status code. | [optional] 
+**Detail** | **string** | A solution for the error. | [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/GetSummaries.md b/docs/GetSummaries.md
@@ -0,0 +1,10 @@
+# ApiVideo.Model.GetSummaries
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Data** | [**List&lt;SummaryObject&gt;**](SummaryObject.md) | An array of summary objects. | [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/InlineObject.md b/docs/InlineObject.md
@@ -0,0 +1,11 @@
+# ApiVideo.Model.InlineObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**VideoId** | **string** | Create a summary of a video using the video ID. | [optional] 
+**Origin** | **string** | Use this parameter to define how the API generates the summary. The only allowed value is &#x60;auto&#x60;, which means that the API generates a summary automatically. If you do not set this parameter, **the API will not generate a summary automatically**. In this case, &#x60;sourceStatus&#x60; will return &#x60;missing&#x60;, and you have to manually add a summary using the &#x60;PATCH /summaries/{summaryId}/source&#x60; endpoint operation. | [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/NotFound.md b/docs/NotFound.md
@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Type** | **string** | | [optional] 
-**Title** | **string** | | [optional] 
-**Name** | **string** | | [optional] 
-**Status** | **int** | | [optional] 
+**Type** | **string** | A link to the error documentation. | [optional] 
+**Title** | **string** | A description of the error that occurred. | [optional] 
+**Name** | **string** | The name of the parameter that caused the error. | [optional] 
+**Status** | **int** | The HTTP status 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)