Merge pull request #141 from apivideo/add-summary-feature-docs

Add summary feature
apivideo · Oct 23, 2024 · 6d8984f · 6d8984f
2 parents a1e8c33 + 44d9973
commit 6d8984f
Show file tree

Hide file tree

Showing 35 changed files with 1,983 additions and 17 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -30,6 +30,7 @@ docs/CaptionsUpdatePayload.md
 docs/Chapter.md
 docs/ChaptersApi.md
 docs/ChaptersListResponse.md
+docs/ConflictError.md
 docs/DiscardedVideoUpdatePayload.md
 docs/FilterBy.md
 docs/FilterBy1.md
@@ -60,6 +61,12 @@ docs/Quality.md
 docs/RefreshTokenPayload.md
 docs/RestreamsRequestObject.md
 docs/RestreamsResponseObject.md
+docs/SummariesApi.md
+docs/SummariesListResponse.md
+docs/Summary.md
+docs/SummaryCreationPayload.md
+docs/SummarySource.md
+docs/SummaryUpdatePayload.md
 docs/TagsApi.md
 docs/TokenCreationPayload.md
 docs/TokenListResponse.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,6 +136,7 @@ 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
@@ -155,6 +164,11 @@ 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/SummariesListResponseTests.cs
+src/ApiVideo.Test/Model/SummaryCreationPayloadTests.cs
+src/ApiVideo.Test/Model/SummarySourceTests.cs
+src/ApiVideo.Test/Model/SummaryTests.cs
+src/ApiVideo.Test/Model/SummaryUpdatePayloadTests.cs
 src/ApiVideo.Test/Model/TokenCreationPayloadTests.cs
 src/ApiVideo.Test/Model/TokenListResponseTests.cs
 src/ApiVideo.Test/Model/TooManyRequestsTests.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,6 +239,7 @@ 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
@@ -255,6 +271,11 @@ src/ApiVideo/Model/Quality.cs
 src/ApiVideo/Model/RefreshTokenPayload.cs
 src/ApiVideo/Model/RestreamsRequestObject.cs
 src/ApiVideo/Model/RestreamsResponseObject.cs
+src/ApiVideo/Model/SummariesListResponse.cs
+src/ApiVideo/Model/Summary.cs
+src/ApiVideo/Model/SummaryCreationPayload.cs
+src/ApiVideo/Model/SummarySource.cs
+src/ApiVideo/Model/SummaryUpdatePayload.cs
 src/ApiVideo/Model/TokenCreationPayload.cs
 src/ApiVideo/Model/TokenListResponse.cs
 src/ApiVideo/Model/TooManyRequests.cs

diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
@@ -1 +1 @@
-6f374764cf476ad001123c84953d1980aaf6bc352573020d111594ab74058bf6
+fa7f7f8c606b69d3dd31980ebbed0f1f0e18756b7544288b3b919f35d99b61bd
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.6.5] - 2024-10-21
+- Add summary feature
+
 ## [1.6.4] - 2024-10-08
 - Add transcript feature
 

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
+[**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
+[**getSummarySource**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummariesApi.md#getSummarySource) | **GET** `/summaries/{summaryId}/source` | Get summary details
+
+
 #### TagsApi
 
 
@@ -384,6 +405,7 @@ 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)
@@ -411,6 +433,11 @@ 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)
+ - [SummariesListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummariesListResponse.md)
+ - [Summary](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Summary.md)
+ - [SummaryCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummaryCreationPayload.md)
+ - [SummarySource](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummarySource.md)
+ - [SummaryUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/SummaryUpdatePayload.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)

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/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)
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		6f374764cf476ad001123c84953d1980aaf6bc352573020d111594ab74058bf6
		fa7f7f8c606b69d3dd31980ebbed0f1f0e18756b7544288b3b919f35d99b61bd