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

apivideo · Jun 4, 2024 · 692e588 · 692e588
1 parent d530d2f
commit 692e588
Show file tree

Hide file tree

Showing 35 changed files with 25 additions and 1,086 deletions.
diff --git a/README.md b/README.md
@@ -108,8 +108,8 @@ const ApiVideoClient = require('@api.video/nodejs-client');
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays
-[**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays
+**(deprecated)** [**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays
+**(deprecated)** [**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays
 
 
 #### CaptionsApi
@@ -209,8 +209,6 @@ Method | Description | HTTP request
 
  - [AccessToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AccessToken.md)
  - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AdditionalBadRequestErrors.md)
- - [AnalyticsData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsData.md)
- - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlays400Error.md)
  - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlaysResponse.md)
  - [AuthenticatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AuthenticatePayload.md)
  - [BadRequest](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/BadRequest.md)
@@ -225,12 +223,6 @@ Method | Description | HTTP request
  - [LiveStreamAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamAssets.md)
  - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamCreationPayload.md)
  - [LiveStreamListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamListResponse.md)
- - [LiveStreamSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSession.md)
- - [LiveStreamSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionClient.md)
- - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionDevice.md)
- - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionLocation.md)
- - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionReferrer.md)
- - [LiveStreamSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionSession.md)
  - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamUpdatePayload.md)
  - [Metadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Metadata.md)
  - [Model403ErrorSchema](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Model403ErrorSchema.md)
@@ -250,18 +242,12 @@ Method | Description | HTTP request
  - [TokenCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenCreationPayload.md)
  - [TokenListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenListResponse.md)
  - [TooManyRequests](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TooManyRequests.md)
+ - [UnrecognizedRequestUrl](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UnrecognizedRequestUrl.md)
  - [UploadToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UploadToken.md)
  - [Video](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Video.md)
  - [VideoAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoAssets.md)
  - [VideoClip](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoClip.md)
  - [VideoCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoCreationPayload.md)
- - [VideoSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSession.md)
- - [VideoSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionClient.md)
- - [VideoSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionDevice.md)
- - [VideoSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionLocation.md)
- - [VideoSessionOs](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionOs.md)
- - [VideoSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionReferrer.md)
- - [VideoSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionSession.md)
  - [VideoSource](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSource.md)
  - [VideoSourceLiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStream.md)
  - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStreamLink.md)

diff --git a/docs/api/AnalyticsApi.md b/docs/api/AnalyticsApi.md
@@ -14,6 +14,12 @@ All URIs are relative to *https://ws.api.video*
 
 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.
+
+
+
 ### Parameters
 
 | Name | Type | Required | Description |
@@ -41,6 +47,12 @@ Promise<[**AnalyticsPlaysResponse**](../model/AnalyticsPlaysResponse.md)>.
 
 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.
+
+
+
 ### Parameters
 
 | Name | Type | Required | Description |

diff --git a/docs/model/AnalyticsData.md b/docs/model/AnalyticsData.md
diff --git a/docs/model/AnalyticsPlaysResponse.md b/docs/model/AnalyticsPlaysResponse.md
@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**Array&lt;AnalyticsData&gt;**](AnalyticsData.md) |  | 
+**data** | **Array&lt;AnalyticsData&gt;** |  | 
 **pagination** | [**Pagination**](Pagination.md) |  | 
 
 

diff --git a/docs/model/LiveStreamSession.md b/docs/model/LiveStreamSession.md
diff --git a/docs/model/LiveStreamSessionClient.md b/docs/model/LiveStreamSessionClient.md
diff --git a/docs/model/LiveStreamSessionDevice.md b/docs/model/LiveStreamSessionDevice.md
diff --git a/docs/model/LiveStreamSessionLocation.md b/docs/model/LiveStreamSessionLocation.md
diff --git a/docs/model/LiveStreamSessionReferrer.md b/docs/model/LiveStreamSessionReferrer.md
diff --git a/docs/model/LiveStreamSessionSession.md b/docs/model/LiveStreamSessionSession.md
diff --git a/docs/model/AnalyticsPlays400Error.md → docs/model/UnrecognizedRequestUrl.md b/docs/model/AnalyticsPlays400Error.md → docs/model/UnrecognizedRequestUrl.md
@@ -1,5 +1,5 @@
 
-# AnalyticsPlays400Error
+# UnrecognizedRequestUrl
 
 ## Properties
 
@@ -8,8 +8,6 @@ Name | Type | Description | Notes
 **type** | **string** | A link to the error documentation. |  [optional]
 **title** | **string** | A description of the error that occurred. |  [optional]
 **status** | **number** | The HTTP status code. |  [optional]
-**detail** | **string** | A solution for the error. |  [optional]
-**name** | **string** | The name of the parameter that caused the error. |  [optional]
 
 
 
diff --git a/docs/model/VideoSession.md b/docs/model/VideoSession.md
diff --git a/docs/model/VideoSessionClient.md b/docs/model/VideoSessionClient.md
diff --git a/docs/model/VideoSessionDevice.md b/docs/model/VideoSessionDevice.md
diff --git a/docs/model/VideoSessionLocation.md b/docs/model/VideoSessionLocation.md
diff --git a/docs/model/VideoSessionOs.md b/docs/model/VideoSessionOs.md
diff --git a/docs/model/VideoSessionReferrer.md b/docs/model/VideoSessionReferrer.md
diff --git a/docs/model/VideoSessionSession.md b/docs/model/VideoSessionSession.md
diff --git a/src/ObjectSerializer.ts b/src/ObjectSerializer.ts
@@ -12,8 +12,6 @@
 
 import AccessToken from './model/AccessToken';
 import AdditionalBadRequestErrors from './model/AdditionalBadRequestErrors';
-import AnalyticsData from './model/AnalyticsData';
-import AnalyticsPlays400Error from './model/AnalyticsPlays400Error';
 import AnalyticsPlaysResponse from './model/AnalyticsPlaysResponse';
 import AuthenticatePayload from './model/AuthenticatePayload';
 import BadRequest from './model/BadRequest';
@@ -28,12 +26,6 @@ import LiveStream from './model/LiveStream';
 import LiveStreamAssets from './model/LiveStreamAssets';
 import LiveStreamCreationPayload from './model/LiveStreamCreationPayload';
 import LiveStreamListResponse from './model/LiveStreamListResponse';
-import LiveStreamSession from './model/LiveStreamSession';
-import LiveStreamSessionClient from './model/LiveStreamSessionClient';
-import LiveStreamSessionDevice from './model/LiveStreamSessionDevice';
-import LiveStreamSessionLocation from './model/LiveStreamSessionLocation';
-import LiveStreamSessionReferrer from './model/LiveStreamSessionReferrer';
-import LiveStreamSessionSession from './model/LiveStreamSessionSession';
 import LiveStreamUpdatePayload from './model/LiveStreamUpdatePayload';
 import Metadata from './model/Metadata';
 import Model403ErrorSchema from './model/Model403ErrorSchema';
@@ -53,18 +45,12 @@ import RestreamsResponseObject from './model/RestreamsResponseObject';
 import TokenCreationPayload from './model/TokenCreationPayload';
 import TokenListResponse from './model/TokenListResponse';
 import TooManyRequests from './model/TooManyRequests';
+import UnrecognizedRequestUrl from './model/UnrecognizedRequestUrl';
 import UploadToken from './model/UploadToken';
 import Video from './model/Video';
 import VideoAssets from './model/VideoAssets';
 import VideoClip from './model/VideoClip';
 import VideoCreationPayload from './model/VideoCreationPayload';
-import VideoSession from './model/VideoSession';
-import VideoSessionClient from './model/VideoSessionClient';
-import VideoSessionDevice from './model/VideoSessionDevice';
-import VideoSessionLocation from './model/VideoSessionLocation';
-import VideoSessionOs from './model/VideoSessionOs';
-import VideoSessionReferrer from './model/VideoSessionReferrer';
-import VideoSessionSession from './model/VideoSessionSession';
 import VideoSource from './model/VideoSource';
 import VideoSourceLiveStream from './model/VideoSourceLiveStream';
 import VideoSourceLiveStreamLink from './model/VideoSourceLiveStreamLink';
@@ -110,8 +96,6 @@ const enumsMap: Set<string> = new Set<string>([
 const typeMap: { [index: string]: any } = {
   AccessToken: AccessToken,
   AdditionalBadRequestErrors: AdditionalBadRequestErrors,
-  AnalyticsData: AnalyticsData,
-  AnalyticsPlays400Error: AnalyticsPlays400Error,
   AnalyticsPlaysResponse: AnalyticsPlaysResponse,
   AuthenticatePayload: AuthenticatePayload,
   BadRequest: BadRequest,
@@ -126,12 +110,6 @@ const typeMap: { [index: string]: any } = {
   LiveStreamAssets: LiveStreamAssets,
   LiveStreamCreationPayload: LiveStreamCreationPayload,
   LiveStreamListResponse: LiveStreamListResponse,
-  LiveStreamSession: LiveStreamSession,
-  LiveStreamSessionClient: LiveStreamSessionClient,
-  LiveStreamSessionDevice: LiveStreamSessionDevice,
-  LiveStreamSessionLocation: LiveStreamSessionLocation,
-  LiveStreamSessionReferrer: LiveStreamSessionReferrer,
-  LiveStreamSessionSession: LiveStreamSessionSession,
   LiveStreamUpdatePayload: LiveStreamUpdatePayload,
   Metadata: Metadata,
   Model403ErrorSchema: Model403ErrorSchema,
@@ -151,18 +129,12 @@ const typeMap: { [index: string]: any } = {
   TokenCreationPayload: TokenCreationPayload,
   TokenListResponse: TokenListResponse,
   TooManyRequests: TooManyRequests,
+  UnrecognizedRequestUrl: UnrecognizedRequestUrl,
   UploadToken: UploadToken,
   Video: Video,
   VideoAssets: VideoAssets,
   VideoClip: VideoClip,
   VideoCreationPayload: VideoCreationPayload,
-  VideoSession: VideoSession,
-  VideoSessionClient: VideoSessionClient,
-  VideoSessionDevice: VideoSessionDevice,
-  VideoSessionLocation: VideoSessionLocation,
-  VideoSessionOs: VideoSessionOs,
-  VideoSessionReferrer: VideoSessionReferrer,
-  VideoSessionSession: VideoSessionSession,
   VideoSource: VideoSource,
   VideoSourceLiveStream: VideoSourceLiveStream,
   VideoSourceLiveStreamLink: VideoSourceLiveStreamLink,