diff --git a/.github/workflows/create-documentation-pr.yml b/.github/workflows/create-documentation-pr.yml new file mode 100644 index 0000000..0fd13d4 --- /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-swift5-client.md + pat: "${{ secrets.PAT }}" + \ No newline at end of file diff --git a/.gitignore b/.gitignore index d1353b4..22029d2 100644 --- a/.gitignore +++ b/.gitignore @@ -102,5 +102,4 @@ iOSInjectionProject/ !*.xcworkspace/contents.xcworkspacedata **/xcshareddata/WorkspaceSettings.xcsettings -# End of https://www.toptal.com/developers/gitignore/api/swift,xcode -documentation.md \ No newline at end of file +# End of https://www.toptal.com/developers/gitignore/api/swift,xcode \ No newline at end of file diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index ba85e5b..39d2d96 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -184,7 +184,6 @@ docs/Webhook.md docs/WebhooksAPI.md docs/WebhooksCreationPayload.md docs/WebhooksListResponse.md -documentation.md git_push.sh post-generate.sh project.yml diff --git a/README.md b/README.md index ef539b1..e60faf0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ + [![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-swift-client?style=social)]()   [![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 Swift client

[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) @@ -29,15 +30,27 @@ - [Public endpoints](#public-endpoints) - [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client) - [Contribution](#contribution) + + -## Installation +## Project description +api.video's Swift API client for iOS, macOS and tvOS streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. -### Carthage +## Getting started + +### Installation + +#### Carthage Specify it in your `Cartfile`: @@ -47,7 +60,7 @@ github "apivideo/api.video-swift-client" ~> 1.2.1 Run `carthage update` -### CocoaPods +#### CocoaPods Add `pod 'ApiVideoClient', '1.2.1'` in your `Podfile` @@ -72,264 +85,264 @@ try VideosAPI.uploadWithUploadToken(token: "MY_VIDEO_TOKEN", file: url) { video, } ``` -# Documentation +## Documentation -## API Endpoints +### API Endpoints All URIs are relative to *https://ws.api.video* -### AnalyticsAPI +#### AnalyticsAPI -#### Retrieve an instance of AnalyticsAPI: +##### Retrieve an instance of AnalyticsAPI: ```swift AnalyticsAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**getLiveStreamsPlays**](docs/AnalyticsAPI.md#getLiveStreamsPlays) | **GET** /analytics/live-streams/plays | Get play events for live stream -[**getVideosPlays**](docs/AnalyticsAPI.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video +[**getLiveStreamsPlays**](https://github.com/apivideo/api.video-swift-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-swift-client/blob/main/docs/AnalyticsAPI.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video -### CaptionsAPI +#### CaptionsAPI -#### Retrieve an instance of CaptionsAPI: +##### Retrieve an instance of CaptionsAPI: ```swift CaptionsAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**](docs/CaptionsAPI.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption -[**get**](docs/CaptionsAPI.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption -[**update**](docs/CaptionsAPI.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption -[**delete**](docs/CaptionsAPI.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption -[**list**](docs/CaptionsAPI.md#list) | **GET** /videos/{videoId}/captions | List video captions +[**upload**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsAPI.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption +[**get**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsAPI.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption +[**update**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsAPI.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption +[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsAPI.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsAPI.md#list) | **GET** /videos/{videoId}/captions | List video captions -### ChaptersAPI +#### ChaptersAPI -#### Retrieve an instance of ChaptersAPI: +##### Retrieve an instance of ChaptersAPI: ```swift ChaptersAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**](docs/ChaptersAPI.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter -[**get**](docs/ChaptersAPI.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter -[**delete**](docs/ChaptersAPI.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter -[**list**](docs/ChaptersAPI.md#list) | **GET** /videos/{videoId}/chapters | List video chapters +[**upload**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/ChaptersAPI.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter +[**get**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/ChaptersAPI.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter +[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/ChaptersAPI.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/ChaptersAPI.md#list) | **GET** /videos/{videoId}/chapters | List video chapters -### LiveStreamsAPI +#### LiveStreamsAPI -#### Retrieve an instance of LiveStreamsAPI: +##### Retrieve an instance of LiveStreamsAPI: ```swift LiveStreamsAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](docs/LiveStreamsAPI.md#create) | **POST** /live-streams | Create live stream -[**get**](docs/LiveStreamsAPI.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream -[**update**](docs/LiveStreamsAPI.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream -[**delete**](docs/LiveStreamsAPI.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream -[**list**](docs/LiveStreamsAPI.md#list) | **GET** /live-streams | List all live streams -[**uploadThumbnail**](docs/LiveStreamsAPI.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail -[**deleteThumbnail**](docs/LiveStreamsAPI.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail +[**create**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamsAPI.md#create) | **POST** /live-streams | Create live stream +[**get**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamsAPI.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream +[**update**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamsAPI.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream +[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamsAPI.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamsAPI.md#list) | **GET** /live-streams | List all live streams +[**uploadThumbnail**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamsAPI.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail +[**deleteThumbnail**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamsAPI.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail -### PlayerThemesAPI +#### PlayerThemesAPI -#### Retrieve an instance of PlayerThemesAPI: +##### Retrieve an instance of PlayerThemesAPI: ```swift PlayerThemesAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](docs/PlayerThemesAPI.md#create) | **POST** /players | Create a player -[**get**](docs/PlayerThemesAPI.md#get) | **GET** /players/{playerId} | Retrieve a player -[**update**](docs/PlayerThemesAPI.md#update) | **PATCH** /players/{playerId} | Update a player -[**delete**](docs/PlayerThemesAPI.md#delete) | **DELETE** /players/{playerId} | Delete a player -[**list**](docs/PlayerThemesAPI.md#list) | **GET** /players | List all player themes -[**uploadLogo**](docs/PlayerThemesAPI.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo -[**deleteLogo**](docs/PlayerThemesAPI.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo +[**create**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#create) | **POST** /players | Create a player +[**get**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#get) | **GET** /players/{playerId} | Retrieve a player +[**update**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#update) | **PATCH** /players/{playerId} | Update a player +[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#delete) | **DELETE** /players/{playerId} | Delete a player +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#list) | **GET** /players | List all player themes +[**uploadLogo**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo +[**deleteLogo**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo -### UploadTokensAPI +#### UploadTokensAPI -#### Retrieve an instance of UploadTokensAPI: +##### Retrieve an instance of UploadTokensAPI: ```swift UploadTokensAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**createToken**](docs/UploadTokensAPI.md#createToken) | **POST** /upload-tokens | Generate an upload token -[**getToken**](docs/UploadTokensAPI.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token -[**deleteToken**](docs/UploadTokensAPI.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token -[**list**](docs/UploadTokensAPI.md#list) | **GET** /upload-tokens | List all active upload tokens +[**createToken**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#createToken) | **POST** /upload-tokens | Generate an upload token +[**getToken**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token +[**deleteToken**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#list) | **GET** /upload-tokens | List all active upload tokens -### VideosAPI +#### VideosAPI -#### Retrieve an instance of VideosAPI: +##### Retrieve an instance of VideosAPI: ```swift VideosAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](docs/VideosAPI.md#create) | **POST** /videos | Create a video object -[**upload**](docs/VideosAPI.md#upload) | **POST** /videos/{videoId}/source | Upload a video -[**uploadWithUploadToken**](docs/VideosAPI.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token -[**get**](docs/VideosAPI.md#get) | **GET** /videos/{videoId} | Retrieve a video object -[**update**](docs/VideosAPI.md#update) | **PATCH** /videos/{videoId} | Update a video object -[**delete**](docs/VideosAPI.md#delete) | **DELETE** /videos/{videoId} | Delete a video object -[**list**](docs/VideosAPI.md#list) | **GET** /videos | List all video objects -[**uploadThumbnail**](docs/VideosAPI.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail -[**pickThumbnail**](docs/VideosAPI.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Set a thumbnail -[**getStatus**](docs/VideosAPI.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status and details +[**create**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#create) | **POST** /videos | Create a video object +[**upload**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#upload) | **POST** /videos/{videoId}/source | Upload a video +[**uploadWithUploadToken**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token +[**get**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#get) | **GET** /videos/{videoId} | Retrieve a video object +[**update**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#update) | **PATCH** /videos/{videoId} | Update a video object +[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#delete) | **DELETE** /videos/{videoId} | Delete a video object +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#list) | **GET** /videos | List all video objects +[**uploadThumbnail**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail +[**pickThumbnail**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Set a thumbnail +[**getStatus**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status and details -### WatermarksAPI +#### WatermarksAPI -#### Retrieve an instance of WatermarksAPI: +##### Retrieve an instance of WatermarksAPI: ```swift WatermarksAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**](docs/WatermarksAPI.md#upload) | **POST** /watermarks | Upload a watermark -[**delete**](docs/WatermarksAPI.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark -[**list**](docs/WatermarksAPI.md#list) | **GET** /watermarks | List all watermarks +[**upload**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WatermarksAPI.md#upload) | **POST** /watermarks | Upload a watermark +[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WatermarksAPI.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WatermarksAPI.md#list) | **GET** /watermarks | List all watermarks -### WebhooksAPI +#### WebhooksAPI -#### Retrieve an instance of WebhooksAPI: +##### Retrieve an instance of WebhooksAPI: ```swift WebhooksAPI ``` -#### Endpoints +##### Endpoints Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](docs/WebhooksAPI.md#create) | **POST** /webhooks | Create Webhook -[**get**](docs/WebhooksAPI.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details -[**delete**](docs/WebhooksAPI.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook -[**list**](docs/WebhooksAPI.md#list) | **GET** /webhooks | List all webhooks - - - -## Models - - - [AccessToken](docs/AccessToken.md) - - [AdditionalBadRequestErrors](docs/AdditionalBadRequestErrors.md) - - [AnalyticsData](docs/AnalyticsData.md) - - [AnalyticsPlays400Error](docs/AnalyticsPlays400Error.md) - - [AnalyticsPlaysResponse](docs/AnalyticsPlaysResponse.md) - - [AuthenticatePayload](docs/AuthenticatePayload.md) - - [BadRequest](docs/BadRequest.md) - - [BytesRange](docs/BytesRange.md) - - [Caption](docs/Caption.md) - - [CaptionsListResponse](docs/CaptionsListResponse.md) - - [CaptionsUpdatePayload](docs/CaptionsUpdatePayload.md) - - [Chapter](docs/Chapter.md) - - [ChaptersListResponse](docs/ChaptersListResponse.md) - - [Link](docs/Link.md) - - [LiveStream](docs/LiveStream.md) - - [LiveStreamAssets](docs/LiveStreamAssets.md) - - [LiveStreamCreationPayload](docs/LiveStreamCreationPayload.md) - - [LiveStreamListResponse](docs/LiveStreamListResponse.md) - - [LiveStreamSession](docs/LiveStreamSession.md) - - [LiveStreamSessionClient](docs/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](docs/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](docs/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](docs/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](docs/LiveStreamSessionSession.md) - - [LiveStreamUpdatePayload](docs/LiveStreamUpdatePayload.md) - - [Metadata](docs/Metadata.md) - - [Model403ErrorSchema](docs/Model403ErrorSchema.md) - - [NotFound](docs/NotFound.md) - - [Pagination](docs/Pagination.md) - - [PaginationLink](docs/PaginationLink.md) - - [PlayerSessionEvent](docs/PlayerSessionEvent.md) - - [PlayerTheme](docs/PlayerTheme.md) - - [PlayerThemeAssets](docs/PlayerThemeAssets.md) - - [PlayerThemeCreationPayload](docs/PlayerThemeCreationPayload.md) - - [PlayerThemeUpdatePayload](docs/PlayerThemeUpdatePayload.md) - - [PlayerThemesListResponse](docs/PlayerThemesListResponse.md) - - [Quality](docs/Quality.md) - - [RefreshTokenPayload](docs/RefreshTokenPayload.md) - - [RestreamsRequestObject](docs/RestreamsRequestObject.md) - - [RestreamsResponseObject](docs/RestreamsResponseObject.md) - - [TokenCreationPayload](docs/TokenCreationPayload.md) - - [TokenListResponse](docs/TokenListResponse.md) - - [UploadToken](docs/UploadToken.md) - - [Video](docs/Video.md) - - [VideoAssets](docs/VideoAssets.md) - - [VideoClip](docs/VideoClip.md) - - [VideoCreationPayload](docs/VideoCreationPayload.md) - - [VideoSession](docs/VideoSession.md) - - [VideoSessionClient](docs/VideoSessionClient.md) - - [VideoSessionDevice](docs/VideoSessionDevice.md) - - [VideoSessionLocation](docs/VideoSessionLocation.md) - - [VideoSessionOs](docs/VideoSessionOs.md) - - [VideoSessionReferrer](docs/VideoSessionReferrer.md) - - [VideoSessionSession](docs/VideoSessionSession.md) - - [VideoSource](docs/VideoSource.md) - - [VideoSourceLiveStream](docs/VideoSourceLiveStream.md) - - [VideoSourceLiveStreamLink](docs/VideoSourceLiveStreamLink.md) - - [VideoStatus](docs/VideoStatus.md) - - [VideoStatusEncoding](docs/VideoStatusEncoding.md) - - [VideoStatusEncodingMetadata](docs/VideoStatusEncodingMetadata.md) - - [VideoStatusIngest](docs/VideoStatusIngest.md) - - [VideoStatusIngestReceivedParts](docs/VideoStatusIngestReceivedParts.md) - - [VideoThumbnailPickPayload](docs/VideoThumbnailPickPayload.md) - - [VideoUpdatePayload](docs/VideoUpdatePayload.md) - - [VideoWatermark](docs/VideoWatermark.md) - - [VideosListResponse](docs/VideosListResponse.md) - - [Watermark](docs/Watermark.md) - - [WatermarksListResponse](docs/WatermarksListResponse.md) - - [Webhook](docs/Webhook.md) - - [WebhooksCreationPayload](docs/WebhooksCreationPayload.md) - - [WebhooksListResponse](docs/WebhooksListResponse.md) - - -## Documentation for Authorization - -### API key +[**create**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WebhooksAPI.md#create) | **POST** /webhooks | Create Webhook +[**get**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WebhooksAPI.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details +[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WebhooksAPI.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook +[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WebhooksAPI.md#list) | **GET** /webhooks | List all webhooks + + + +### Models + + - [AccessToken](https://github.com/apivideo/api.video-swift-client/blob/main/docs/AccessToken.md) + - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-swift-client/blob/main/docs/AdditionalBadRequestErrors.md) + - [AnalyticsData](https://github.com/apivideo/api.video-swift-client/blob/main/docs/AnalyticsData.md) + - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-swift-client/blob/main/docs/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/AuthenticatePayload.md) + - [BadRequest](https://github.com/apivideo/api.video-swift-client/blob/main/docs/BadRequest.md) + - [BytesRange](https://github.com/apivideo/api.video-swift-client/blob/main/docs/BytesRange.md) + - [Caption](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Caption.md) + - [CaptionsListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsListResponse.md) + - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsUpdatePayload.md) + - [Chapter](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Chapter.md) + - [ChaptersListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/ChaptersListResponse.md) + - [Link](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Link.md) + - [LiveStream](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStream.md) + - [LiveStreamAssets](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamAssets.md) + - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamCreationPayload.md) + - [LiveStreamListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamListResponse.md) + - [LiveStreamSession](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamSession.md) + - [LiveStreamSessionClient](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamSessionClient.md) + - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamSessionDevice.md) + - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamSessionLocation.md) + - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamSessionReferrer.md) + - [LiveStreamSessionSession](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamSessionSession.md) + - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/LiveStreamUpdatePayload.md) + - [Metadata](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Metadata.md) + - [Model403ErrorSchema](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Model403ErrorSchema.md) + - [NotFound](https://github.com/apivideo/api.video-swift-client/blob/main/docs/NotFound.md) + - [Pagination](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Pagination.md) + - [PaginationLink](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PaginationLink.md) + - [PlayerSessionEvent](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerSessionEvent.md) + - [PlayerTheme](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerTheme.md) + - [PlayerThemeAssets](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesListResponse.md) + - [Quality](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Quality.md) + - [RefreshTokenPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/RefreshTokenPayload.md) + - [RestreamsRequestObject](https://github.com/apivideo/api.video-swift-client/blob/main/docs/RestreamsRequestObject.md) + - [RestreamsResponseObject](https://github.com/apivideo/api.video-swift-client/blob/main/docs/RestreamsResponseObject.md) + - [TokenCreationPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/TokenCreationPayload.md) + - [TokenListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/TokenListResponse.md) + - [UploadToken](https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadToken.md) + - [Video](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Video.md) + - [VideoAssets](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoAssets.md) + - [VideoClip](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoClip.md) + - [VideoCreationPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoCreationPayload.md) + - [VideoSession](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSession.md) + - [VideoSessionClient](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSessionClient.md) + - [VideoSessionDevice](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSessionDevice.md) + - [VideoSessionLocation](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSessionLocation.md) + - [VideoSessionOs](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSessionOs.md) + - [VideoSessionReferrer](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSessionReferrer.md) + - [VideoSessionSession](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSessionSession.md) + - [VideoSource](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSource.md) + - [VideoSourceLiveStream](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoSourceLiveStreamLink.md) + - [VideoStatus](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoStatus.md) + - [VideoStatusEncoding](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoUpdatePayload.md) + - [VideoWatermark](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideoWatermark.md) + - [VideosListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosListResponse.md) + - [Watermark](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Watermark.md) + - [WatermarksListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WatermarksListResponse.md) + - [Webhook](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Webhook.md) + - [WebhooksCreationPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WebhooksCreationPayload.md) + - [WebhooksListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/WebhooksListResponse.md) + + +### Documentation for Authorization + +#### API key Most endpoints required to be authenticated using the API key mechanism described in our [documentation](https://docs.api.video/reference#authentication). @@ -337,16 +350,16 @@ You must NOT store your API key in your application code to prevent your API key Only the [Public endpoints](#public-endpoints) can be called without authentication. In the case, you want to call an endpoint that requires authentication, you will have to use a backend server. See [Security best practices](https://docs.api.video/sdks/security) for more details. -### Public endpoints +#### Public endpoints Some endpoints don't require authentication. These one can be called without setting `ApiVideoClient.apiKey`. -## Have you gotten use from this API client? +### Have you gotten use from this API client? 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.