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

apivideo · May 29, 2024 · cd10e9a · cd10e9a
1 parent 09f8b68
commit cd10e9a
Show file tree

Hide file tree

Showing 43 changed files with 1,745 additions and 11 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -7,10 +7,20 @@ 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/AnalyticsV20BetaApi.md
 docs/AuthenticatePayload.md
 docs/BadRequest.md
 docs/BytesRange.md
@@ -54,6 +64,7 @@ docs/RestreamsResponseObject.md
 docs/TokenCreationPayload.md
 docs/TokenListResponse.md
 docs/TooManyRequests.md
+docs/UnrecognizedRequestUrl.md
 docs/UploadToken.md
 docs/UploadTokensApi.md
 docs/Video.md
@@ -92,6 +103,7 @@ mono_nunit_test.sh
 post-generate.sh
 src/ApiVideo.Test/Api/AdvancedAuthenticationApiTests.cs
 src/ApiVideo.Test/Api/AnalyticsApiTests.cs
+src/ApiVideo.Test/Api/AnalyticsV20BetaApiTests.cs
 src/ApiVideo.Test/Api/CaptionsApiTests.cs
 src/ApiVideo.Test/Api/ChaptersApiTests.cs
 src/ApiVideo.Test/Api/LiveStreamsApiTests.cs
@@ -103,7 +115,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
@@ -144,6 +165,7 @@ 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
@@ -176,6 +198,7 @@ src/ApiVideo.Test/Model/WebhooksListResponseTests.cs
 src/ApiVideo.Test/packages.config
 src/ApiVideo/Api/AdvancedAuthenticationApi.cs
 src/ApiVideo/Api/AnalyticsApi.cs
+src/ApiVideo/Api/AnalyticsV20BetaApi.cs
 src/ApiVideo/Api/CaptionsApi.cs
 src/ApiVideo/Api/ChaptersApi.cs
 src/ApiVideo/Api/LiveStreamsApi.cs
@@ -195,7 +218,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
@@ -240,6 +272,7 @@ 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

diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
@@ -1 +1 @@
-d7b342ceb1a4805da9e3d6355384e34c1a99e1300d01cac3ae3218c5738f11f1
+548f424dcead8e1cff88849a19d2f7339012ce69090abf66d12f7f30fa756e5d
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@
 - [Documentation](#documentation)
   - [API Endpoints](#api-endpoints)
     - [AnalyticsApi](#analyticsapi)
+    - [AnalyticsV20BetaApi](#analyticsv20betaapi)
     - [CaptionsApi](#captionsapi)
     - [ChaptersApi](#chaptersapi)
     - [LiveStreamsApi](#livestreamsapi)
@@ -170,8 +171,26 @@ 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
+**(deprecated)** [**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
+**(deprecated)** [**getVideosPlays**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsApi.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video
+
+
+#### AnalyticsV20BetaApi
+
+
+##### Retrieve an instance of AnalyticsV20BetaApi:
+```java
+ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
+AnalyticsV20BetaApi analyticsV20Beta = client.AnalyticsV20Beta()
+```
+
+##### Endpoints
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getAggregatedMetrics**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsV20BetaApi.md#getAggregatedMetrics) | **GET** /data/metrics/{metric}/{aggregation} | Retrieve aggregated metrics
+[**getMetricsBreakdown**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsV20BetaApi.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/AnalyticsV20BetaApi.md#getMetricsOverTime) | **GET** /data/timeseries/{metric} | Retrieve metrics over time
 
 
 #### CaptionsApi
@@ -343,7 +362,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)
@@ -384,6 +412,7 @@ 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)

diff --git a/docs/AnalyticsAggregatedMetricsResponse.md b/docs/AnalyticsAggregatedMetricsResponse.md
@@ -0,0 +1,11 @@
+# ApiVideo.Model.AnalyticsAggregatedMetricsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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)
+
diff --git a/docs/AnalyticsApi.md b/docs/AnalyticsApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 Get play events for live stream
 
-Retrieve filtered analytics about the number of plays for your live streams in a project.
+Retrieve filtered analytics about the number of plays for your live streams in a project.  This endpoint will be deprecated with the release of Analytics v2.0. 
 
 ### Example
 ```csharp
@@ -94,7 +94,7 @@ Name | Type | Description  | Notes
 
 Get play events for video
 
-Retrieve filtered analytics about the number of plays for your videos in a project.
+Retrieve filtered analytics about the number of plays for your videos in a project.  This endpoint will be deprecated with the release of Analytics v2.0. 
 
 ### Example
 ```csharp

diff --git a/docs/AnalyticsMetricsBreakdownResponse.md b/docs/AnalyticsMetricsBreakdownResponse.md
@@ -0,0 +1,12 @@
+# ApiVideo.Model.AnalyticsMetricsBreakdownResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Context** | [**AnalyticsMetricsBreakdownResponseContext**](AnalyticsMetricsBreakdownResponseContext.md) |  | 
+**Data** | [**List&lt;AnalyticsMetricsBreakdownResponseData&gt;**](AnalyticsMetricsBreakdownResponseData.md) | Returns an array of dimensions and their respective metrics. | 
+**Pagination** | [**Pagination**](Pagination.md) |  | 
+
+[[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/AnalyticsMetricsBreakdownResponseContext.md b/docs/AnalyticsMetricsBreakdownResponseContext.md
@@ -0,0 +1,12 @@
+# ApiVideo.Model.AnalyticsMetricsBreakdownResponseContext
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Metric** | **string** | Returns the metric you selected. | [optional] 
+**Breakdown** | **string** | Returns the dimension 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/AnalyticsMetricsBreakdownResponseData.md b/docs/AnalyticsMetricsBreakdownResponseData.md
@@ -0,0 +1,11 @@
+# ApiVideo.Model.AnalyticsMetricsBreakdownResponseData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**DimensionValue** | **string** | Returns a specific value for the dimension you selected, based on the data. For example if you select &#x60;continent&#x60; as a dimension, then &#x60;dimensionValue&#x60; returns values like &#x60;EU&#x60; or \&quot;AZ\&quot;. | [optional] 
+**MetricValue** | **float** | Returns the data for a specific dimension value. | [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/AnalyticsMetricsOverTimeResponse.md b/docs/AnalyticsMetricsOverTimeResponse.md
@@ -0,0 +1,12 @@
+# ApiVideo.Model.AnalyticsMetricsOverTimeResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) |  | 
+**Data** | [**List&lt;AnalyticsMetricsOverTimeResponseData&gt;**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . | 
+**Pagination** | [**Pagination**](Pagination.md) |  | 
+
+[[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/AnalyticsMetricsOverTimeResponseContext.md b/docs/AnalyticsMetricsOverTimeResponseContext.md
@@ -0,0 +1,12 @@
+# ApiVideo.Model.AnalyticsMetricsOverTimeResponseContext
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Metric** | **string** | Returns the metric you selected. | [optional] 
+**Interval** | **string** | Returns the interval 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/AnalyticsMetricsOverTimeResponseData.md b/docs/AnalyticsMetricsOverTimeResponseData.md
@@ -0,0 +1,11 @@
+# ApiVideo.Model.AnalyticsMetricsOverTimeResponseData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**EmittedAt** | **string** | Returns the timestamp of the event that belongs to a specific metric in ATOM date-time format. For example, if you set &#x60;play&#x60; with an &#x60;hour&#x60; interval in your request, then &#x60;emittedAt&#x60; returns the hourly timestamps of every play event within the timeframe you defined. | [optional] 
+**MetricValue** | **float** | Returns the data for a specific metric value. | [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 @@
		d7b342ceb1a4805da9e3d6355384e34c1a99e1300d01cac3ae3218c5738f11f1
		548f424dcead8e1cff88849a19d2f7339012ce69090abf66d12f7f30fa756e5d