Skip to content

Commit

Permalink
[DO NOT MERGE] Add Watch Data endpoints to OpenAPI spec
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierapivideo authored Jun 5, 2024
1 parent 9e11fa1 commit b6782c7
Show file tree
Hide file tree
Showing 36 changed files with 98 additions and 2,993 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ $client->videos()->upload(

Method | Description | HTTP request
------------- | ------------- | -------------
[**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-php-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-php-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-php-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-php-client/blob/main/docs/Api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** `/analytics/videos/plays`


#### CaptionsApi
Expand Down Expand Up @@ -249,12 +249,6 @@ Method | Description | HTTP request
- [LiveStreamAssets](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamAssets.md)
- [LiveStreamCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamCreationPayload.md)
- [LiveStreamListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamListResponse.md)
- [LiveStreamSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSession.md)
- [LiveStreamSessionClient](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionClient.md)
- [LiveStreamSessionDevice](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionDevice.md)
- [LiveStreamSessionLocation](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionLocation.md)
- [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionReferrer.md)
- [LiveStreamSessionSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionSession.md)
- [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamUpdatePayload.md)
- [Metadata](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Metadata.md)
- [Model403ErrorSchema](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Model403ErrorSchema.md)
Expand All @@ -274,18 +268,12 @@ Method | Description | HTTP request
- [TokenCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/TokenCreationPayload.md)
- [TokenListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/TokenListResponse.md)
- [TooManyRequests](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/TooManyRequests.md)
- [UnrecognizedRequestUrl](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/UnrecognizedRequestUrl.md)
- [UploadToken](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/UploadToken.md)
- [Video](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Video.md)
- [VideoAssets](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoAssets.md)
- [VideoClip](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoClip.md)
- [VideoCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoCreationPayload.md)
- [VideoSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSession.md)
- [VideoSessionClient](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionClient.md)
- [VideoSessionDevice](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionDevice.md)
- [VideoSessionLocation](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionLocation.md)
- [VideoSessionOs](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionOs.md)
- [VideoSessionReferrer](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionReferrer.md)
- [VideoSessionSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionSession.md)
- [VideoSource](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSource.md)
- [VideoSourceLiveStream](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSourceLiveStream.md)
- [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSourceLiveStreamLink.md)
Expand Down
16 changes: 14 additions & 2 deletions docs/Api/AnalyticsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**getLiveStreamsPlays()**](AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** `/analytics/live-streams/plays`
[**getVideosPlays()**](AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** `/analytics/videos/plays`
[**getLiveStreamsPlays()**](AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays
[**getVideosPlays()**](AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays


## **`getLiveStreamsPlays()` - Get play events for live stream**
Expand All @@ -14,6 +14,12 @@ Method | Description | HTTP request

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.



### Arguments


Expand Down Expand Up @@ -50,6 +56,12 @@ Name | Type | Description | Notes

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.



### Arguments


Expand Down
10 changes: 5 additions & 5 deletions docs/Api/CaptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**upload()**](CaptionsApi.md#upload) | Upload a caption | **POST** `/videos/{videoId}/captions/{language}`
[**get()**](CaptionsApi.md#get) | Retrieve a caption | **GET** `/videos/{videoId}/captions/{language}`
[**update()**](CaptionsApi.md#update) | Update a caption | **PATCH** `/videos/{videoId}/captions/{language}`
[**delete()**](CaptionsApi.md#delete) | Delete a caption | **DELETE** `/videos/{videoId}/captions/{language}`
[**list()**](CaptionsApi.md#list) | List video captions | **GET** `/videos/{videoId}/captions`
[**upload()**](CaptionsApi.md#upload) | Upload a caption | **POST** /videos/{videoId}/captions/{language}
[**get()**](CaptionsApi.md#get) | Retrieve a caption | **GET** /videos/{videoId}/captions/{language}
[**update()**](CaptionsApi.md#update) | Update a caption | **PATCH** /videos/{videoId}/captions/{language}
[**delete()**](CaptionsApi.md#delete) | Delete a caption | **DELETE** /videos/{videoId}/captions/{language}
[**list()**](CaptionsApi.md#list) | List video captions | **GET** /videos/{videoId}/captions


## **`upload()` - Upload a caption**
Expand Down
8 changes: 4 additions & 4 deletions docs/Api/ChaptersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**upload()**](ChaptersApi.md#upload) | Upload a chapter | **POST** `/videos/{videoId}/chapters/{language}`
[**get()**](ChaptersApi.md#get) | Retrieve a chapter | **GET** `/videos/{videoId}/chapters/{language}`
[**delete()**](ChaptersApi.md#delete) | Delete a chapter | **DELETE** `/videos/{videoId}/chapters/{language}`
[**list()**](ChaptersApi.md#list) | List video chapters | **GET** `/videos/{videoId}/chapters`
[**upload()**](ChaptersApi.md#upload) | Upload a chapter | **POST** /videos/{videoId}/chapters/{language}
[**get()**](ChaptersApi.md#get) | Retrieve a chapter | **GET** /videos/{videoId}/chapters/{language}
[**delete()**](ChaptersApi.md#delete) | Delete a chapter | **DELETE** /videos/{videoId}/chapters/{language}
[**list()**](ChaptersApi.md#list) | List video chapters | **GET** /videos/{videoId}/chapters


## **`upload()` - Upload a chapter**
Expand Down
14 changes: 7 additions & 7 deletions docs/Api/LiveStreamsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**create()**](LiveStreamsApi.md#create) | Create live stream | **POST** `/live-streams`
[**get()**](LiveStreamsApi.md#get) | Retrieve live stream | **GET** `/live-streams/{liveStreamId}`
[**update()**](LiveStreamsApi.md#update) | Update a live stream | **PATCH** `/live-streams/{liveStreamId}`
[**delete()**](LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** `/live-streams/{liveStreamId}`
[**list()**](LiveStreamsApi.md#list) | List all live streams | **GET** `/live-streams`
[**uploadThumbnail()**](LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/live-streams/{liveStreamId}/thumbnail`
[**deleteThumbnail()**](LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** `/live-streams/{liveStreamId}/thumbnail`
[**create()**](LiveStreamsApi.md#create) | Create live stream | **POST** /live-streams
[**get()**](LiveStreamsApi.md#get) | Retrieve live stream | **GET** /live-streams/{liveStreamId}
[**update()**](LiveStreamsApi.md#update) | Update a live stream | **PATCH** /live-streams/{liveStreamId}
[**delete()**](LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** /live-streams/{liveStreamId}
[**list()**](LiveStreamsApi.md#list) | List all live streams | **GET** /live-streams
[**uploadThumbnail()**](LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /live-streams/{liveStreamId}/thumbnail
[**deleteThumbnail()**](LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** /live-streams/{liveStreamId}/thumbnail


## **`create()` - Create live stream**
Expand Down
14 changes: 7 additions & 7 deletions docs/Api/PlayerThemesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**create()**](PlayerThemesApi.md#create) | Create a player | **POST** `/players`
[**get()**](PlayerThemesApi.md#get) | Retrieve a player | **GET** `/players/{playerId}`
[**update()**](PlayerThemesApi.md#update) | Update a player | **PATCH** `/players/{playerId}`
[**delete()**](PlayerThemesApi.md#delete) | Delete a player | **DELETE** `/players/{playerId}`
[**list()**](PlayerThemesApi.md#list) | List all player themes | **GET** `/players`
[**uploadLogo()**](PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** `/players/{playerId}/logo`
[**deleteLogo()**](PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** `/players/{playerId}/logo`
[**create()**](PlayerThemesApi.md#create) | Create a player | **POST** /players
[**get()**](PlayerThemesApi.md#get) | Retrieve a player | **GET** /players/{playerId}
[**update()**](PlayerThemesApi.md#update) | Update a player | **PATCH** /players/{playerId}
[**delete()**](PlayerThemesApi.md#delete) | Delete a player | **DELETE** /players/{playerId}
[**list()**](PlayerThemesApi.md#list) | List all player themes | **GET** /players
[**uploadLogo()**](PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** /players/{playerId}/logo
[**deleteLogo()**](PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** /players/{playerId}/logo


## **`create()` - Create a player**
Expand Down
8 changes: 4 additions & 4 deletions docs/Api/UploadTokensApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**createToken()**](UploadTokensApi.md#createToken) | Generate an upload token | **POST** `/upload-tokens`
[**getToken()**](UploadTokensApi.md#getToken) | Retrieve upload token | **GET** `/upload-tokens/{uploadToken}`
[**deleteToken()**](UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** `/upload-tokens/{uploadToken}`
[**list()**](UploadTokensApi.md#list) | List all active upload tokens | **GET** `/upload-tokens`
[**createToken()**](UploadTokensApi.md#createToken) | Generate an upload token | **POST** /upload-tokens
[**getToken()**](UploadTokensApi.md#getToken) | Retrieve upload token | **GET** /upload-tokens/{uploadToken}
[**deleteToken()**](UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** /upload-tokens/{uploadToken}
[**list()**](UploadTokensApi.md#list) | List all active upload tokens | **GET** /upload-tokens


## **`createToken()` - Generate an upload token**
Expand Down
20 changes: 10 additions & 10 deletions docs/Api/VideosApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**create()**](VideosApi.md#create) | Create a video object | **POST** `/videos`
[**upload()**](VideosApi.md#upload) | Upload a video | **POST** `/videos/{videoId}/source`
[**uploadWithUploadToken()**](VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** `/upload`
[**get()**](VideosApi.md#get) | Retrieve a video object | **GET** `/videos/{videoId}`
[**update()**](VideosApi.md#update) | Update a video object | **PATCH** `/videos/{videoId}`
[**delete()**](VideosApi.md#delete) | Delete a video object | **DELETE** `/videos/{videoId}`
[**list()**](VideosApi.md#list) | List all video objects | **GET** `/videos`
[**uploadThumbnail()**](VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/videos/{videoId}/thumbnail`
[**pickThumbnail()**](VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** `/videos/{videoId}/thumbnail`
[**getStatus()**](VideosApi.md#getStatus) | Retrieve video status and details | **GET** `/videos/{videoId}/status`
[**create()**](VideosApi.md#create) | Create a video object | **POST** /videos
[**upload()**](VideosApi.md#upload) | Upload a video | **POST** /videos/{videoId}/source
[**uploadWithUploadToken()**](VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** /upload
[**get()**](VideosApi.md#get) | Retrieve a video object | **GET** /videos/{videoId}
[**update()**](VideosApi.md#update) | Update a video object | **PATCH** /videos/{videoId}
[**delete()**](VideosApi.md#delete) | Delete a video object | **DELETE** /videos/{videoId}
[**list()**](VideosApi.md#list) | List all video objects | **GET** /videos
[**uploadThumbnail()**](VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /videos/{videoId}/thumbnail
[**pickThumbnail()**](VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** /videos/{videoId}/thumbnail
[**getStatus()**](VideosApi.md#getStatus) | Retrieve video status and details | **GET** /videos/{videoId}/status


## **`create()` - Create a video object**
Expand Down
6 changes: 3 additions & 3 deletions docs/Api/WatermarksApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**upload()**](WatermarksApi.md#upload) | Upload a watermark | **POST** `/watermarks`
[**delete()**](WatermarksApi.md#delete) | Delete a watermark | **DELETE** `/watermarks/{watermarkId}`
[**list()**](WatermarksApi.md#list) | List all watermarks | **GET** `/watermarks`
[**upload()**](WatermarksApi.md#upload) | Upload a watermark | **POST** /watermarks
[**delete()**](WatermarksApi.md#delete) | Delete a watermark | **DELETE** /watermarks/{watermarkId}
[**list()**](WatermarksApi.md#list) | List all watermarks | **GET** /watermarks


## **`upload()` - Upload a watermark**
Expand Down
8 changes: 4 additions & 4 deletions docs/Api/WebhooksApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ All URIs are relative to https://ws.api.video.

Method | Description | HTTP request
------------- | ------------- | -------------
[**create()**](WebhooksApi.md#create) | Create Webhook | **POST** `/webhooks`
[**get()**](WebhooksApi.md#get) | Retrieve Webhook details | **GET** `/webhooks/{webhookId}`
[**delete()**](WebhooksApi.md#delete) | Delete a Webhook | **DELETE** `/webhooks/{webhookId}`
[**list()**](WebhooksApi.md#list) | List all webhooks | **GET** `/webhooks`
[**create()**](WebhooksApi.md#create) | Create Webhook | **POST** /webhooks
[**get()**](WebhooksApi.md#get) | Retrieve Webhook details | **GET** /webhooks/{webhookId}
[**delete()**](WebhooksApi.md#delete) | Delete a Webhook | **DELETE** /webhooks/{webhookId}
[**list()**](WebhooksApi.md#list) | List all webhooks | **GET** /webhooks


## **`create()` - Create Webhook**
Expand Down
14 changes: 0 additions & 14 deletions docs/Model/LiveStreamSession.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/Model/LiveStreamSessionClient.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/Model/LiveStreamSessionDevice.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/Model/LiveStreamSessionLocation.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/Model/LiveStreamSessionReferrer.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/Model/LiveStreamSessionSession.md

This file was deleted.

Loading

0 comments on commit b6782c7

Please sign in to comment.