[DO NOT MERGE] Add Watch Data endpoints to OpenAPI spec

apivideo · Jul 23, 2024 · 85be5c0 · 85be5c0
1 parent ae3a0c4
commit 85be5c0
Show file tree

Hide file tree

Showing 125 changed files with 1,640 additions and 1,505 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -7,8 +7,17 @@ build.sh
 docs/AccessToken.md
 docs/AdditionalBadRequestErrors.md
 docs/AdvancedAuthenticationApi.md
+docs/AnalyticsAggregatedMetricsResponse.md
+docs/AnalyticsAggregatedMetricsResponseContext.md
+docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md
 docs/AnalyticsApi.md
 docs/AnalyticsData.md
+docs/AnalyticsMetricsBreakdownResponse.md
+docs/AnalyticsMetricsBreakdownResponseContext.md
+docs/AnalyticsMetricsBreakdownResponseData.md
+docs/AnalyticsMetricsOverTimeResponse.md
+docs/AnalyticsMetricsOverTimeResponseContext.md
+docs/AnalyticsMetricsOverTimeResponseData.md
 docs/AnalyticsPlays400Error.md
 docs/AnalyticsPlaysResponse.md
 docs/AuthenticatePayload.md
@@ -26,12 +35,6 @@ docs/LiveStream.md
 docs/LiveStreamAssets.md
 docs/LiveStreamCreationPayload.md
 docs/LiveStreamListResponse.md
-docs/LiveStreamSession.md
-docs/LiveStreamSessionClient.md
-docs/LiveStreamSessionDevice.md
-docs/LiveStreamSessionLocation.md
-docs/LiveStreamSessionReferrer.md
-docs/LiveStreamSessionSession.md
 docs/LiveStreamUpdatePayload.md
 docs/LiveStreamsApi.md
 docs/Metadata.md
@@ -54,19 +57,13 @@ docs/RestreamsResponseObject.md
 docs/TokenCreationPayload.md
 docs/TokenListResponse.md
 docs/TooManyRequests.md
+docs/UnrecognizedRequestUrl.md
 docs/UploadToken.md
 docs/UploadTokensApi.md
 docs/Video.md
 docs/VideoAssets.md
 docs/VideoClip.md
 docs/VideoCreationPayload.md
-docs/VideoSession.md
-docs/VideoSessionClient.md
-docs/VideoSessionDevice.md
-docs/VideoSessionLocation.md
-docs/VideoSessionOs.md
-docs/VideoSessionReferrer.md
-docs/VideoSessionSession.md
 docs/VideoSource.md
 docs/VideoSourceLiveStream.md
 docs/VideoSourceLiveStreamLink.md
@@ -103,7 +100,16 @@ src/ApiVideo.Test/Api/WebhooksApiTests.cs
 src/ApiVideo.Test/ApiVideo.Test.csproj
 src/ApiVideo.Test/Model/AccessTokenTests.cs
 src/ApiVideo.Test/Model/AdditionalBadRequestErrorsTests.cs
+src/ApiVideo.Test/Model/AnalyticsAggregatedMetricsResponseContextTests.cs
+src/ApiVideo.Test/Model/AnalyticsAggregatedMetricsResponseContextTimeframeTests.cs
+src/ApiVideo.Test/Model/AnalyticsAggregatedMetricsResponseTests.cs
 src/ApiVideo.Test/Model/AnalyticsDataTests.cs
+src/ApiVideo.Test/Model/AnalyticsMetricsBreakdownResponseContextTests.cs
+src/ApiVideo.Test/Model/AnalyticsMetricsBreakdownResponseDataTests.cs
+src/ApiVideo.Test/Model/AnalyticsMetricsBreakdownResponseTests.cs
+src/ApiVideo.Test/Model/AnalyticsMetricsOverTimeResponseContextTests.cs
+src/ApiVideo.Test/Model/AnalyticsMetricsOverTimeResponseDataTests.cs
+src/ApiVideo.Test/Model/AnalyticsMetricsOverTimeResponseTests.cs
 src/ApiVideo.Test/Model/AnalyticsPlays400ErrorTests.cs
 src/ApiVideo.Test/Model/AnalyticsPlaysResponseTests.cs
 src/ApiVideo.Test/Model/AuthenticatePayloadTests.cs
@@ -118,12 +124,6 @@ src/ApiVideo.Test/Model/LinkTests.cs
 src/ApiVideo.Test/Model/LiveStreamAssetsTests.cs
 src/ApiVideo.Test/Model/LiveStreamCreationPayloadTests.cs
 src/ApiVideo.Test/Model/LiveStreamListResponseTests.cs
-src/ApiVideo.Test/Model/LiveStreamSessionClientTests.cs
-src/ApiVideo.Test/Model/LiveStreamSessionDeviceTests.cs
-src/ApiVideo.Test/Model/LiveStreamSessionLocationTests.cs
-src/ApiVideo.Test/Model/LiveStreamSessionReferrerTests.cs
-src/ApiVideo.Test/Model/LiveStreamSessionSessionTests.cs
-src/ApiVideo.Test/Model/LiveStreamSessionTests.cs
 src/ApiVideo.Test/Model/LiveStreamTests.cs
 src/ApiVideo.Test/Model/LiveStreamUpdatePayloadTests.cs
 src/ApiVideo.Test/Model/MetadataTests.cs
@@ -144,17 +144,11 @@ src/ApiVideo.Test/Model/RestreamsResponseObjectTests.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/UploadTokenTests.cs
 src/ApiVideo.Test/Model/VideoAssetsTests.cs
 src/ApiVideo.Test/Model/VideoClipTests.cs
 src/ApiVideo.Test/Model/VideoCreationPayloadTests.cs
-src/ApiVideo.Test/Model/VideoSessionClientTests.cs
-src/ApiVideo.Test/Model/VideoSessionDeviceTests.cs
-src/ApiVideo.Test/Model/VideoSessionLocationTests.cs
-src/ApiVideo.Test/Model/VideoSessionOsTests.cs
-src/ApiVideo.Test/Model/VideoSessionReferrerTests.cs
-src/ApiVideo.Test/Model/VideoSessionSessionTests.cs
-src/ApiVideo.Test/Model/VideoSessionTests.cs
 src/ApiVideo.Test/Model/VideoSourceLiveStreamLinkTests.cs
 src/ApiVideo.Test/Model/VideoSourceLiveStreamTests.cs
 src/ApiVideo.Test/Model/VideoSourceTests.cs
@@ -195,7 +189,16 @@ src/ApiVideo/Client/EmptyArrayFixTypeConverter.cs
 src/ApiVideo/Client/NullableStringTypeConverter.cs
 src/ApiVideo/Model/AccessToken.cs
 src/ApiVideo/Model/AdditionalBadRequestErrors.cs
+src/ApiVideo/Model/AnalyticsAggregatedMetricsResponse.cs
+src/ApiVideo/Model/AnalyticsAggregatedMetricsResponseContext.cs
+src/ApiVideo/Model/AnalyticsAggregatedMetricsResponseContextTimeframe.cs
 src/ApiVideo/Model/AnalyticsData.cs
+src/ApiVideo/Model/AnalyticsMetricsBreakdownResponse.cs
+src/ApiVideo/Model/AnalyticsMetricsBreakdownResponseContext.cs
+src/ApiVideo/Model/AnalyticsMetricsBreakdownResponseData.cs
+src/ApiVideo/Model/AnalyticsMetricsOverTimeResponse.cs
+src/ApiVideo/Model/AnalyticsMetricsOverTimeResponseContext.cs
+src/ApiVideo/Model/AnalyticsMetricsOverTimeResponseData.cs
 src/ApiVideo/Model/AnalyticsPlays400Error.cs
 src/ApiVideo/Model/AnalyticsPlaysResponse.cs
 src/ApiVideo/Model/AuthenticatePayload.cs
@@ -213,12 +216,6 @@ src/ApiVideo/Model/LiveStream.cs
 src/ApiVideo/Model/LiveStreamAssets.cs
 src/ApiVideo/Model/LiveStreamCreationPayload.cs
 src/ApiVideo/Model/LiveStreamListResponse.cs
-src/ApiVideo/Model/LiveStreamSession.cs
-src/ApiVideo/Model/LiveStreamSessionClient.cs
-src/ApiVideo/Model/LiveStreamSessionDevice.cs
-src/ApiVideo/Model/LiveStreamSessionLocation.cs
-src/ApiVideo/Model/LiveStreamSessionReferrer.cs
-src/ApiVideo/Model/LiveStreamSessionSession.cs
 src/ApiVideo/Model/LiveStreamUpdatePayload.cs
 src/ApiVideo/Model/Metadata.cs
 src/ApiVideo/Model/Model403ErrorSchema.cs
@@ -240,18 +237,12 @@ src/ApiVideo/Model/RestreamsResponseObject.cs
 src/ApiVideo/Model/TokenCreationPayload.cs
 src/ApiVideo/Model/TokenListResponse.cs
 src/ApiVideo/Model/TooManyRequests.cs
+src/ApiVideo/Model/UnrecognizedRequestUrl.cs
 src/ApiVideo/Model/UploadToken.cs
 src/ApiVideo/Model/Video.cs
 src/ApiVideo/Model/VideoAssets.cs
 src/ApiVideo/Model/VideoClip.cs
 src/ApiVideo/Model/VideoCreationPayload.cs
-src/ApiVideo/Model/VideoSession.cs
-src/ApiVideo/Model/VideoSessionClient.cs
-src/ApiVideo/Model/VideoSessionDevice.cs
-src/ApiVideo/Model/VideoSessionLocation.cs
-src/ApiVideo/Model/VideoSessionOs.cs
-src/ApiVideo/Model/VideoSessionReferrer.cs
-src/ApiVideo/Model/VideoSessionSession.cs
 src/ApiVideo/Model/VideoSource.cs
 src/ApiVideo/Model/VideoSourceLiveStream.cs
 src/ApiVideo/Model/VideoSourceLiveStreamLink.cs

diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
@@ -1 +1 @@
-d7b342ceb1a4805da9e3d6355384e34c1a99e1300d01cac3ae3218c5738f11f1
+16c7ff294d3c9a1f33f41ce3edfa0dbfed5810ccdd2d92872179b6c87c5e9169
diff --git a/README.md b/README.md
@@ -169,8 +169,9 @@ AnalyticsApi analytics = client.Analytics()
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**getLiveStreamsPlays**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsApi.md#getLiveStreamsPlays) | **GET** `/analytics/live-streams/plays` | Get play events for live stream
-[**getVideosPlays**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsApi.md#getVideosPlays) | **GET** `/analytics/videos/plays` | Get play events for video
+[**getAggregatedMetrics**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsApi.md#getAggregatedMetrics) | **GET** `/data/metrics/{metric}/{aggregation}` | Retrieve aggregated metrics
+[**getMetricsBreakdown**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsApi.md#getMetricsBreakdown) | **GET** `/data/buckets/{metric}/{breakdown}` | Retrieve metrics in a breakdown of dimensions
+[**getMetricsOverTime**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsApi.md#getMetricsOverTime) | **GET** `/data/timeseries/{metric}` | Retrieve metrics over time
 
 
 #### CaptionsApi
@@ -232,6 +233,7 @@ Method | HTTP request | Description
 [**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#list) | **GET** `/live-streams` | List all live streams
 [**uploadThumbnail**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#uploadThumbnail) | **POST** `/live-streams/{liveStreamId}/thumbnail` | Upload a thumbnail
 [**deleteThumbnail**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#deleteThumbnail) | **DELETE** `/live-streams/{liveStreamId}/thumbnail` | Delete a thumbnail
+[**complete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#complete) | **PUT** `/live-streams/{liveStreamId}/complete` | Complete a live stream
 
 
 #### PlayerThemesApi
@@ -342,7 +344,16 @@ Method | HTTP request | Description
 
  - [AccessToken](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AccessToken.md)
  - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AdditionalBadRequestErrors.md)
+ - [AnalyticsAggregatedMetricsResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsAggregatedMetricsResponse.md)
+ - [AnalyticsAggregatedMetricsResponseContext](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsAggregatedMetricsResponseContext.md)
+ - [AnalyticsAggregatedMetricsResponseContextTimeframe](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md)
  - [AnalyticsData](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsData.md)
+ - [AnalyticsMetricsBreakdownResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsMetricsBreakdownResponse.md)
+ - [AnalyticsMetricsBreakdownResponseContext](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsMetricsBreakdownResponseContext.md)
+ - [AnalyticsMetricsBreakdownResponseData](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsMetricsBreakdownResponseData.md)
+ - [AnalyticsMetricsOverTimeResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsMetricsOverTimeResponse.md)
+ - [AnalyticsMetricsOverTimeResponseContext](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsMetricsOverTimeResponseContext.md)
+ - [AnalyticsMetricsOverTimeResponseData](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsMetricsOverTimeResponseData.md)
  - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsPlays400Error.md)
  - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsPlaysResponse.md)
  - [AuthenticatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AuthenticatePayload.md)
@@ -358,12 +369,6 @@ Method | HTTP request | Description
  - [LiveStreamAssets](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamAssets.md)
  - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamCreationPayload.md)
  - [LiveStreamListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamListResponse.md)
- - [LiveStreamSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSession.md)
- - [LiveStreamSessionClient](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionClient.md)
- - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionDevice.md)
- - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionLocation.md)
- - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionReferrer.md)
- - [LiveStreamSessionSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionSession.md)
  - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamUpdatePayload.md)
  - [Metadata](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Metadata.md)
  - [Model403ErrorSchema](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Model403ErrorSchema.md)
@@ -383,18 +388,12 @@ Method | HTTP request | Description
  - [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)
  - [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)
  - [VideoClip](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoClip.md)
  - [VideoCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoCreationPayload.md)
- - [VideoSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSession.md)
- - [VideoSessionClient](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionClient.md)
- - [VideoSessionDevice](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionDevice.md)
- - [VideoSessionLocation](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionLocation.md)
- - [VideoSessionOs](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionOs.md)
- - [VideoSessionReferrer](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionReferrer.md)
- - [VideoSessionSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionSession.md)
  - [VideoSource](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSource.md)
  - [VideoSourceLiveStream](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSourceLiveStream.md)
  - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSourceLiveStreamLink.md)

diff --git a/docs/VideoSessionLocation.md → docs/AnalyticsAggregatedMetricsResponse.md b/docs/VideoSessionLocation.md → docs/AnalyticsAggregatedMetricsResponse.md
@@ -1,12 +1,11 @@
-# ApiVideo.Model.VideoSessionLocation
-The location of the viewer.
+# ApiVideo.Model.AnalyticsAggregatedMetricsResponse
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Country** | **string** | The country of the viewer. | [optional] 
-**City** | **string** | The city of the viewer. | [optional] 
+**Context** | [**AnalyticsAggregatedMetricsResponseContext**](AnalyticsAggregatedMetricsResponseContext.md) |  | 
+**Data** | **float** |  | 
 
 [[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/AnalyticsAggregatedMetricsResponseContext.md b/docs/AnalyticsAggregatedMetricsResponseContext.md
@@ -0,0 +1,12 @@
+# ApiVideo.Model.AnalyticsAggregatedMetricsResponseContext
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Metric** | **string** | Returns the metric you selected. | [optional] 
+**Aggregation** | **string** | Returns the aggregation you selected. | [optional] 
+**Timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.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/AnalyticsAggregatedMetricsResponseContextTimeframe.md b/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md
@@ -0,0 +1,12 @@
+# ApiVideo.Model.AnalyticsAggregatedMetricsResponseContextTimeframe
+Returns the starting and ending date-times of the period you want analytics for.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**From** | **DateTime** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. | [optional] 
+**To** | **DateTime** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. | [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)
+