From 658c15d2cda1411ba9078a6a87e46faef8a2aff7 Mon Sep 17 00:00:00 2001 From: olivierapivideo Date: Tue, 21 Nov 2023 16:31:45 +0000 Subject: [PATCH] The documentation repo becomes independent :) --- .github/workflows/create-documentation-pr.yml | 27 ++ .gitignore | 3 +- README.md | 311 +++++++++--------- 3 files changed, 190 insertions(+), 151 deletions(-) create mode 100644 .github/workflows/create-documentation-pr.yml diff --git a/.github/workflows/create-documentation-pr.yml b/.github/workflows/create-documentation-pr.yml new file mode 100644 index 0000000..c6d94bd --- /dev/null +++ b/.github/workflows/create-documentation-pr.yml @@ -0,0 +1,27 @@ +name: Create documentation PR +on: + # Trigger the workflow on pull requests targeting the main branch + pull_request: + types: [assigned, unassigned, opened, reopened, synchronize, edited, labeled, unlabeled, edited, closed] + branches: + - main + +jobs: + create_documentation_pr: + if: github.event.action != 'closed' + + runs-on: ubuntu-latest + + steps: + - name: Check out current repository code + uses: actions/checkout@v2 + + - name: Create the documentation pull request + uses: apivideo/api.video-create-readme-file-pull-request-action@main + with: + source-file-path: "README.md" + destination-repository: apivideo/api.video-documentation + destination-path: sdks/api-clients + destination-filename: apivideo-php-client.md + pat: "${{ secrets.PAT }}" + \ No newline at end of file diff --git a/.gitignore b/.gitignore index 629ecfb..917de52 100644 --- a/.gitignore +++ b/.gitignore @@ -6,5 +6,4 @@ test.php .openapi-generator .openapi-generator-ignore .phpunit.result.cache -post-generate.sh -documentation.md \ No newline at end of file +post-generate.sh \ No newline at end of file diff --git a/README.md b/README.md index 595a48e..d59831a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + [![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-php-client?style=social)](https://github.com/apivideo/api.video-php-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) ![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png)

api.video PHP client

@@ -5,7 +6,7 @@ [api.video](https://api.video) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app. -# Table of contents +## Table of contents - [Project description](#project-description) - [Getting started](#getting-started) @@ -33,20 +34,32 @@ - [Tests](#tests) - [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-) - [Contribution](#contribution) + + + +## Project description api.video's PHP API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. -# Getting started +## Getting started -## Installation +### Installation ```shell composer require api-video/php-api-client ``` -## Initialization +### Initialization Due to PHP PSR support, you must initialize the client with 3 to 5 arguments: 1. Base URI, which can be either `https://sandbox.api.video` or `https://ws.api.video` @@ -57,7 +70,7 @@ Due to PHP PSR support, you must initialize the client with 3 to 5 arguments: Note : If the HTTP client also implements RequestFactoryInterface and StreamFactoryInterface, then it is not necessary to pass this object in 4th and 5th argument. -### Symfony HTTP client example +#### Symfony HTTP client example The Symfony HTTP client has the triple advantage of playing the role of **HTTP client**, but also of **request factory** and **stream factory**. It is therefore sufficient to pass it as an argument 3 times. @@ -68,9 +81,9 @@ composer require symfony/http-client composer require nyholm/psr7 ``` -## Code sample +### Code sample -### Client initialization +#### Client initialization ```php ``` -### Create a video +#### Create a video ```php $payload = (new VideoCreationPayload()) @@ -95,7 +108,7 @@ $payload = (new VideoCreationPayload()) $video = $client->videos()->create($payload); ``` -### Upload a video +#### Upload a video ```php $payload = (new VideoCreationPayload()) @@ -110,188 +123,188 @@ $client->videos()->upload( ); ``` -# Documentation +## Documentation -## API Endpoints +### API Endpoints -### AnalyticsApi +#### AnalyticsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**getLiveStreamsPlays()**](docs/Api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** `/analytics/live-streams/plays` -[**getVideosPlays()**](docs/Api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** `/analytics/videos/plays` +[**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` -### CaptionsApi +#### CaptionsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**upload()**](docs/Api/CaptionsApi.md#upload) | Upload a caption | **POST** `/videos/{videoId}/captions/{language}` -[**get()**](docs/Api/CaptionsApi.md#get) | Retrieve a caption | **GET** `/videos/{videoId}/captions/{language}` -[**update()**](docs/Api/CaptionsApi.md#update) | Update a caption | **PATCH** `/videos/{videoId}/captions/{language}` -[**delete()**](docs/Api/CaptionsApi.md#delete) | Delete a caption | **DELETE** `/videos/{videoId}/captions/{language}` -[**list()**](docs/Api/CaptionsApi.md#list) | List video captions | **GET** `/videos/{videoId}/captions` +[**upload()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#upload) | Upload a caption | **POST** `/videos/{videoId}/captions/{language}` +[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#get) | Retrieve a caption | **GET** `/videos/{videoId}/captions/{language}` +[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#update) | Update a caption | **PATCH** `/videos/{videoId}/captions/{language}` +[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#delete) | Delete a caption | **DELETE** `/videos/{videoId}/captions/{language}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#list) | List video captions | **GET** `/videos/{videoId}/captions` -### ChaptersApi +#### ChaptersApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**upload()**](docs/Api/ChaptersApi.md#upload) | Upload a chapter | **POST** `/videos/{videoId}/chapters/{language}` -[**get()**](docs/Api/ChaptersApi.md#get) | Retrieve a chapter | **GET** `/videos/{videoId}/chapters/{language}` -[**delete()**](docs/Api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** `/videos/{videoId}/chapters/{language}` -[**list()**](docs/Api/ChaptersApi.md#list) | List video chapters | **GET** `/videos/{videoId}/chapters` +[**upload()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#upload) | Upload a chapter | **POST** `/videos/{videoId}/chapters/{language}` +[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#get) | Retrieve a chapter | **GET** `/videos/{videoId}/chapters/{language}` +[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** `/videos/{videoId}/chapters/{language}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#list) | List video chapters | **GET** `/videos/{videoId}/chapters` -### LiveStreamsApi +#### LiveStreamsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](docs/Api/LiveStreamsApi.md#create) | Create live stream | **POST** `/live-streams` -[**get()**](docs/Api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** `/live-streams/{liveStreamId}` -[**update()**](docs/Api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** `/live-streams/{liveStreamId}` -[**delete()**](docs/Api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** `/live-streams/{liveStreamId}` -[**list()**](docs/Api/LiveStreamsApi.md#list) | List all live streams | **GET** `/live-streams` -[**uploadThumbnail()**](docs/Api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/live-streams/{liveStreamId}/thumbnail` -[**deleteThumbnail()**](docs/Api/LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** `/live-streams/{liveStreamId}/thumbnail` +[**create()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#create) | Create live stream | **POST** `/live-streams` +[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** `/live-streams/{liveStreamId}` +[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** `/live-streams/{liveStreamId}` +[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** `/live-streams/{liveStreamId}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#list) | List all live streams | **GET** `/live-streams` +[**uploadThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/live-streams/{liveStreamId}/thumbnail` +[**deleteThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** `/live-streams/{liveStreamId}/thumbnail` -### PlayerThemesApi +#### PlayerThemesApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](docs/Api/PlayerThemesApi.md#create) | Create a player | **POST** `/players` -[**get()**](docs/Api/PlayerThemesApi.md#get) | Retrieve a player | **GET** `/players/{playerId}` -[**update()**](docs/Api/PlayerThemesApi.md#update) | Update a player | **PATCH** `/players/{playerId}` -[**delete()**](docs/Api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** `/players/{playerId}` -[**list()**](docs/Api/PlayerThemesApi.md#list) | List all player themes | **GET** `/players` -[**uploadLogo()**](docs/Api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** `/players/{playerId}/logo` -[**deleteLogo()**](docs/Api/PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** `/players/{playerId}/logo` +[**create()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#create) | Create a player | **POST** `/players` +[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#get) | Retrieve a player | **GET** `/players/{playerId}` +[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#update) | Update a player | **PATCH** `/players/{playerId}` +[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** `/players/{playerId}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#list) | List all player themes | **GET** `/players` +[**uploadLogo()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** `/players/{playerId}/logo` +[**deleteLogo()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** `/players/{playerId}/logo` -### UploadTokensApi +#### UploadTokensApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**createToken()**](docs/Api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** `/upload-tokens` -[**getToken()**](docs/Api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** `/upload-tokens/{uploadToken}` -[**deleteToken()**](docs/Api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** `/upload-tokens/{uploadToken}` -[**list()**](docs/Api/UploadTokensApi.md#list) | List all active upload tokens | **GET** `/upload-tokens` +[**createToken()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** `/upload-tokens` +[**getToken()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** `/upload-tokens/{uploadToken}` +[**deleteToken()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** `/upload-tokens/{uploadToken}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#list) | List all active upload tokens | **GET** `/upload-tokens` -### VideosApi +#### VideosApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](docs/Api/VideosApi.md#create) | Create a video object | **POST** `/videos` -[**upload()**](docs/Api/VideosApi.md#upload) | Upload a video | **POST** `/videos/{videoId}/source` -[**uploadWithUploadToken()**](docs/Api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** `/upload` -[**get()**](docs/Api/VideosApi.md#get) | Retrieve a video object | **GET** `/videos/{videoId}` -[**update()**](docs/Api/VideosApi.md#update) | Update a video object | **PATCH** `/videos/{videoId}` -[**delete()**](docs/Api/VideosApi.md#delete) | Delete a video object | **DELETE** `/videos/{videoId}` -[**list()**](docs/Api/VideosApi.md#list) | List all video objects | **GET** `/videos` -[**uploadThumbnail()**](docs/Api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/videos/{videoId}/thumbnail` -[**pickThumbnail()**](docs/Api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** `/videos/{videoId}/thumbnail` -[**getStatus()**](docs/Api/VideosApi.md#getStatus) | Retrieve video status and details | **GET** `/videos/{videoId}/status` +[**create()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#create) | Create a video object | **POST** `/videos` +[**upload()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#upload) | Upload a video | **POST** `/videos/{videoId}/source` +[**uploadWithUploadToken()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** `/upload` +[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#get) | Retrieve a video object | **GET** `/videos/{videoId}` +[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#update) | Update a video object | **PATCH** `/videos/{videoId}` +[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#delete) | Delete a video object | **DELETE** `/videos/{videoId}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#list) | List all video objects | **GET** `/videos` +[**uploadThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/videos/{videoId}/thumbnail` +[**pickThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** `/videos/{videoId}/thumbnail` +[**getStatus()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#getStatus) | Retrieve video status and details | **GET** `/videos/{videoId}/status` -### WatermarksApi +#### WatermarksApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**upload()**](docs/Api/WatermarksApi.md#upload) | Upload a watermark | **POST** `/watermarks` -[**delete()**](docs/Api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** `/watermarks/{watermarkId}` -[**list()**](docs/Api/WatermarksApi.md#list) | List all watermarks | **GET** `/watermarks` +[**upload()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WatermarksApi.md#upload) | Upload a watermark | **POST** `/watermarks` +[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** `/watermarks/{watermarkId}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WatermarksApi.md#list) | List all watermarks | **GET** `/watermarks` -### WebhooksApi +#### WebhooksApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](docs/Api/WebhooksApi.md#create) | Create Webhook | **POST** `/webhooks` -[**get()**](docs/Api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** `/webhooks/{webhookId}` -[**delete()**](docs/Api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** `/webhooks/{webhookId}` -[**list()**](docs/Api/WebhooksApi.md#list) | List all webhooks | **GET** `/webhooks` - - - -## Models - - - [AccessToken](docs/Model/AccessToken.md) - - [AdditionalBadRequestErrors](docs/Model/AdditionalBadRequestErrors.md) - - [AnalyticsData](docs/Model/AnalyticsData.md) - - [AnalyticsPlays400Error](docs/Model/AnalyticsPlays400Error.md) - - [AnalyticsPlaysResponse](docs/Model/AnalyticsPlaysResponse.md) - - [AuthenticatePayload](docs/Model/AuthenticatePayload.md) - - [BadRequest](docs/Model/BadRequest.md) - - [BytesRange](docs/Model/BytesRange.md) - - [Caption](docs/Model/Caption.md) - - [CaptionsListResponse](docs/Model/CaptionsListResponse.md) - - [CaptionsUpdatePayload](docs/Model/CaptionsUpdatePayload.md) - - [Chapter](docs/Model/Chapter.md) - - [ChaptersListResponse](docs/Model/ChaptersListResponse.md) - - [Link](docs/Model/Link.md) - - [LiveStream](docs/Model/LiveStream.md) - - [LiveStreamAssets](docs/Model/LiveStreamAssets.md) - - [LiveStreamCreationPayload](docs/Model/LiveStreamCreationPayload.md) - - [LiveStreamListResponse](docs/Model/LiveStreamListResponse.md) - - [LiveStreamSession](docs/Model/LiveStreamSession.md) - - [LiveStreamSessionClient](docs/Model/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](docs/Model/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](docs/Model/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](docs/Model/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](docs/Model/LiveStreamSessionSession.md) - - [LiveStreamUpdatePayload](docs/Model/LiveStreamUpdatePayload.md) - - [Metadata](docs/Model/Metadata.md) - - [Model403ErrorSchema](docs/Model/Model403ErrorSchema.md) - - [NotFound](docs/Model/NotFound.md) - - [Pagination](docs/Model/Pagination.md) - - [PaginationLink](docs/Model/PaginationLink.md) - - [PlayerSessionEvent](docs/Model/PlayerSessionEvent.md) - - [PlayerTheme](docs/Model/PlayerTheme.md) - - [PlayerThemeAssets](docs/Model/PlayerThemeAssets.md) - - [PlayerThemeCreationPayload](docs/Model/PlayerThemeCreationPayload.md) - - [PlayerThemeUpdatePayload](docs/Model/PlayerThemeUpdatePayload.md) - - [PlayerThemesListResponse](docs/Model/PlayerThemesListResponse.md) - - [Quality](docs/Model/Quality.md) - - [RefreshTokenPayload](docs/Model/RefreshTokenPayload.md) - - [RestreamsRequestObject](docs/Model/RestreamsRequestObject.md) - - [RestreamsResponseObject](docs/Model/RestreamsResponseObject.md) - - [TokenCreationPayload](docs/Model/TokenCreationPayload.md) - - [TokenListResponse](docs/Model/TokenListResponse.md) - - [UploadToken](docs/Model/UploadToken.md) - - [Video](docs/Model/Video.md) - - [VideoAssets](docs/Model/VideoAssets.md) - - [VideoClip](docs/Model/VideoClip.md) - - [VideoCreationPayload](docs/Model/VideoCreationPayload.md) - - [VideoSession](docs/Model/VideoSession.md) - - [VideoSessionClient](docs/Model/VideoSessionClient.md) - - [VideoSessionDevice](docs/Model/VideoSessionDevice.md) - - [VideoSessionLocation](docs/Model/VideoSessionLocation.md) - - [VideoSessionOs](docs/Model/VideoSessionOs.md) - - [VideoSessionReferrer](docs/Model/VideoSessionReferrer.md) - - [VideoSessionSession](docs/Model/VideoSessionSession.md) - - [VideoSource](docs/Model/VideoSource.md) - - [VideoSourceLiveStream](docs/Model/VideoSourceLiveStream.md) - - [VideoSourceLiveStreamLink](docs/Model/VideoSourceLiveStreamLink.md) - - [VideoStatus](docs/Model/VideoStatus.md) - - [VideoStatusEncoding](docs/Model/VideoStatusEncoding.md) - - [VideoStatusEncodingMetadata](docs/Model/VideoStatusEncodingMetadata.md) - - [VideoStatusIngest](docs/Model/VideoStatusIngest.md) - - [VideoStatusIngestReceivedParts](docs/Model/VideoStatusIngestReceivedParts.md) - - [VideoThumbnailPickPayload](docs/Model/VideoThumbnailPickPayload.md) - - [VideoUpdatePayload](docs/Model/VideoUpdatePayload.md) - - [VideoWatermark](docs/Model/VideoWatermark.md) - - [VideosListResponse](docs/Model/VideosListResponse.md) - - [Watermark](docs/Model/Watermark.md) - - [WatermarksListResponse](docs/Model/WatermarksListResponse.md) - - [Webhook](docs/Model/Webhook.md) - - [WebhooksCreationPayload](docs/Model/WebhooksCreationPayload.md) - - [WebhooksListResponse](docs/Model/WebhooksListResponse.md) - - -## Authentication +[**create()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#create) | Create Webhook | **POST** `/webhooks` +[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** `/webhooks/{webhookId}` +[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** `/webhooks/{webhookId}` +[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#list) | List all webhooks | **GET** `/webhooks` + + + +### Models + + - [AccessToken](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AccessToken.md) + - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AdditionalBadRequestErrors.md) + - [AnalyticsData](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AnalyticsData.md) + - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AuthenticatePayload.md) + - [BadRequest](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/BadRequest.md) + - [BytesRange](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/BytesRange.md) + - [Caption](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Caption.md) + - [CaptionsListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/CaptionsListResponse.md) + - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/CaptionsUpdatePayload.md) + - [Chapter](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Chapter.md) + - [ChaptersListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/ChaptersListResponse.md) + - [Link](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Link.md) + - [LiveStream](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStream.md) + - [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) + - [NotFound](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/NotFound.md) + - [Pagination](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Pagination.md) + - [PaginationLink](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PaginationLink.md) + - [PlayerSessionEvent](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerSessionEvent.md) + - [PlayerTheme](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerTheme.md) + - [PlayerThemeAssets](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemesListResponse.md) + - [Quality](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Quality.md) + - [RefreshTokenPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RefreshTokenPayload.md) + - [RestreamsRequestObject](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RestreamsRequestObject.md) + - [RestreamsResponseObject](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RestreamsResponseObject.md) + - [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) + - [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) + - [VideoStatus](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatus.md) + - [VideoStatusEncoding](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoUpdatePayload.md) + - [VideoWatermark](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoWatermark.md) + - [VideosListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideosListResponse.md) + - [Watermark](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Watermark.md) + - [WatermarksListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/WatermarksListResponse.md) + - [Webhook](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Webhook.md) + - [WebhooksCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/WebhooksCreationPayload.md) + - [WebhooksListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/WebhooksListResponse.md) + + +### Authentication Some endpoints don't require authentication. These one can be called with a Client instantiated with a `null` API key: @@ -309,7 +322,7 @@ $client = new \ApiVideo\Client\Client( ``` -## Chunks +### Chunks The video is automatically split into 50 Mb chunks. @@ -321,7 +334,7 @@ For example : `bytes 0-500000/0` for 500 Kb chunks. The chunks size value must be between 5 Mb and 128mb. -## Tests +### Tests In order to run the PhpUnit tests, it is necessary to enter two variables in the command line: @@ -341,6 +354,6 @@ Please take a moment to leave a star on the client ⭐ This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! -# Contribution +## Contribution Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file