Merge pull request #87 from apivideo/api-rate-limiting-oas

Add API rate limiting to the OAS
apivideo · Apr 18, 2024 · 9e11fa1 · 9e11fa1
2 parents 03ed6fb + 79c6d7b
commit 9e11fa1
Show file tree

Hide file tree

Showing 12 changed files with 260 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -273,6 +273,7 @@ Method | Description | HTTP request
  - [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)
+ - [TooManyRequests](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/TooManyRequests.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)

diff --git a/docs/Model/TooManyRequests.md b/docs/Model/TooManyRequests.md
@@ -0,0 +1,11 @@
+# # TooManyRequests
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | A link to the error documentation. | [optional]
+**title** | **string** | A description of the error that occurred. | [optional]
+**status** | **int** | The HTTP status code. | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/src/Api/AnalyticsApi.php b/src/Api/AnalyticsApi.php
@@ -51,7 +51,7 @@ public function __construct(BaseClient $client)
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\AnalyticsPlaysResponse|\ApiVideo\Client\Model\AnalyticsPlays400Error|\ApiVideo\Client\Model\Model403ErrorSchema|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\AnalyticsPlaysResponse|\ApiVideo\Client\Model\AnalyticsPlays400Error|\ApiVideo\Client\Model\Model403ErrorSchema|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function getLiveStreamsPlays(\DateTime $from, string $dimension, array $queryParams = []): \ApiVideo\Client\Model\AnalyticsPlaysResponse
     {
@@ -157,7 +157,7 @@ private function buildGetLiveStreamsPlaysRequest(\DateTime $from, string $dimens
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\AnalyticsPlaysResponse|\ApiVideo\Client\Model\AnalyticsPlays400Error|\ApiVideo\Client\Model\Model403ErrorSchema|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\AnalyticsPlaysResponse|\ApiVideo\Client\Model\AnalyticsPlays400Error|\ApiVideo\Client\Model\Model403ErrorSchema|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function getVideosPlays(\DateTime $from, string $dimension, array $queryParams = []): \ApiVideo\Client\Model\AnalyticsPlaysResponse
     {

diff --git a/src/Api/CaptionsApi.php b/src/Api/CaptionsApi.php
@@ -51,7 +51,7 @@ public function __construct(BaseClient $client)
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Caption|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Caption|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function upload(string $videoId, string $language, \SplFileObject $file): \ApiVideo\Client\Model\Caption
     {
@@ -157,7 +157,7 @@ private function buildUploadRequest(string $videoId, string $language, \SplFileO
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Caption|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Caption|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function get(string $videoId, string $language): \ApiVideo\Client\Model\Caption
     {
@@ -238,7 +238,7 @@ private function buildGetRequest(string $videoId, string $language): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Caption|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Caption|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function update(string $videoId, string $language, \ApiVideo\Client\Model\CaptionsUpdatePayload $captionsUpdatePayload): \ApiVideo\Client\Model\Caption
     {
@@ -406,7 +406,7 @@ private function buildDeleteRequest(string $videoId, string $language): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\CaptionsListResponse|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\CaptionsListResponse|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function list(string $videoId, array $queryParams = []): \ApiVideo\Client\Model\CaptionsListResponse
     {

diff --git a/src/Api/ChaptersApi.php b/src/Api/ChaptersApi.php
@@ -51,7 +51,7 @@ public function __construct(BaseClient $client)
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Chapter|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Chapter|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function upload(string $videoId, string $language, \SplFileObject $file): \ApiVideo\Client\Model\Chapter
     {
@@ -157,7 +157,7 @@ private function buildUploadRequest(string $videoId, string $language, \SplFileO
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Chapter|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Chapter|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function get(string $videoId, string $language): \ApiVideo\Client\Model\Chapter
     {
@@ -315,7 +315,7 @@ private function buildDeleteRequest(string $videoId, string $language): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\ChaptersListResponse|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\ChaptersListResponse|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function list(string $videoId, array $queryParams = []): \ApiVideo\Client\Model\ChaptersListResponse
     {

diff --git a/src/Api/LiveStreamsApi.php b/src/Api/LiveStreamsApi.php
@@ -49,7 +49,7 @@ public function __construct(BaseClient $client)
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\BadRequest
+     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\TooManyRequests
      */
     public function create(\ApiVideo\Client\Model\LiveStreamCreationPayload $liveStreamCreationPayload): \ApiVideo\Client\Model\LiveStream
     {
@@ -108,7 +108,7 @@ private function buildCreateRequest(\ApiVideo\Client\Model\LiveStreamCreationPay
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\LiveStream
+     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\TooManyRequests
      */
     public function get(string $liveStreamId): \ApiVideo\Client\Model\LiveStream
     {
@@ -173,7 +173,7 @@ private function buildGetRequest(string $liveStreamId): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\BadRequest
+     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\TooManyRequests
      */
     public function update(string $liveStreamId, \ApiVideo\Client\Model\LiveStreamUpdatePayload $liveStreamUpdatePayload): \ApiVideo\Client\Model\LiveStream
     {
@@ -309,7 +309,7 @@ private function buildDeleteRequest(string $liveStreamId): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\LiveStreamListResponse
+     * @return \ApiVideo\Client\Model\LiveStreamListResponse|\ApiVideo\Client\Model\TooManyRequests
      */
     public function list(array $queryParams = []): \ApiVideo\Client\Model\LiveStreamListResponse
     {
@@ -398,7 +398,7 @@ private function buildListRequest(array $queryParams = []): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function uploadThumbnail(string $liveStreamId, \SplFileObject $file): \ApiVideo\Client\Model\LiveStream
     {
@@ -488,7 +488,7 @@ private function buildUploadThumbnailRequest(string $liveStreamId, \SplFileObjec
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\LiveStream|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function deleteThumbnail(string $liveStreamId): \ApiVideo\Client\Model\LiveStream
     {

diff --git a/src/Api/PlayerThemesApi.php b/src/Api/PlayerThemesApi.php
@@ -49,7 +49,7 @@ public function __construct(BaseClient $client)
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\PlayerTheme
+     * @return \ApiVideo\Client\Model\PlayerTheme|\ApiVideo\Client\Model\TooManyRequests
      */
     public function create(\ApiVideo\Client\Model\PlayerThemeCreationPayload $playerThemeCreationPayload): \ApiVideo\Client\Model\PlayerTheme
     {
@@ -108,7 +108,7 @@ private function buildCreateRequest(\ApiVideo\Client\Model\PlayerThemeCreationPa
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\PlayerTheme|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\PlayerTheme|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function get(string $playerId): \ApiVideo\Client\Model\PlayerTheme
     {
@@ -173,7 +173,7 @@ private function buildGetRequest(string $playerId): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\PlayerTheme|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\PlayerTheme|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function update(string $playerId, \ApiVideo\Client\Model\PlayerThemeUpdatePayload $playerThemeUpdatePayload): \ApiVideo\Client\Model\PlayerTheme
     {
@@ -309,7 +309,7 @@ private function buildDeleteRequest(string $playerId): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\PlayerThemesListResponse|\ApiVideo\Client\Model\BadRequest
+     * @return \ApiVideo\Client\Model\PlayerThemesListResponse|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\TooManyRequests
      */
     public function list(array $queryParams = []): \ApiVideo\Client\Model\PlayerThemesListResponse
     {
@@ -387,7 +387,7 @@ private function buildListRequest(array $queryParams = []): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\PlayerTheme|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\PlayerTheme|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function uploadLogo(string $playerId, \SplFileObject $file, string $link = null): \ApiVideo\Client\Model\PlayerTheme
     {

diff --git a/src/Api/UploadTokensApi.php b/src/Api/UploadTokensApi.php
@@ -49,7 +49,7 @@ public function __construct(BaseClient $client)
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\UploadToken|\ApiVideo\Client\Model\BadRequest
+     * @return \ApiVideo\Client\Model\UploadToken|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\TooManyRequests
      */
     public function createToken(\ApiVideo\Client\Model\TokenCreationPayload $tokenCreationPayload): \ApiVideo\Client\Model\UploadToken
     {
@@ -108,7 +108,7 @@ private function buildCreateTokenRequest(\ApiVideo\Client\Model\TokenCreationPay
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\UploadToken|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\UploadToken|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function getToken(string $uploadToken): \ApiVideo\Client\Model\UploadToken
     {
@@ -234,7 +234,7 @@ private function buildDeleteTokenRequest(string $uploadToken): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\TokenListResponse
+     * @return \ApiVideo\Client\Model\TokenListResponse|\ApiVideo\Client\Model\TooManyRequests
      */
     public function list(array $queryParams = []): \ApiVideo\Client\Model\TokenListResponse
     {

diff --git a/src/Api/VideosApi.php b/src/Api/VideosApi.php
@@ -49,7 +49,7 @@ public function __construct(BaseClient $client)
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest
+     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\TooManyRequests
      */
     public function create(\ApiVideo\Client\Model\VideoCreationPayload $videoCreationPayload): \ApiVideo\Client\Model\Video
     {
@@ -110,7 +110,7 @@ private function buildCreateRequest(\ApiVideo\Client\Model\VideoCreationPayload
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function upload(string $videoId, \SplFileObject $file, string $contentRange = null): \ApiVideo\Client\Model\Video
     {
@@ -225,7 +225,7 @@ public function createUploadProgressiveSession(string $videoId) {
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest
+     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\TooManyRequests
      */
     public function uploadWithUploadToken(string $token, \SplFileObject $file, string $contentRange = null, string $videoId = null): \ApiVideo\Client\Model\Video
     {
@@ -339,7 +339,7 @@ public function createUploadWithUploadTokenProgressiveSession(string $token, str
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function get(string $videoId): \ApiVideo\Client\Model\Video
     {
@@ -404,7 +404,7 @@ private function buildGetRequest(string $videoId): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function update(string $videoId, \ApiVideo\Client\Model\VideoUpdatePayload $videoUpdatePayload): \ApiVideo\Client\Model\Video
     {
@@ -540,7 +540,7 @@ private function buildDeleteRequest(string $videoId): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\VideosListResponse|\ApiVideo\Client\Model\BadRequest
+     * @return \ApiVideo\Client\Model\VideosListResponse|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\TooManyRequests
      */
     public function list(array $queryParams = []): \ApiVideo\Client\Model\VideosListResponse
     {
@@ -655,7 +655,7 @@ private function buildListRequest(array $queryParams = []): Request
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\BadRequest|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function uploadThumbnail(string $videoId, \SplFileObject $file): \ApiVideo\Client\Model\Video
     {
@@ -746,7 +746,7 @@ private function buildUploadThumbnailRequest(string $videoId, \SplFileObject $fi
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\Video|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function pickThumbnail(string $videoId, \ApiVideo\Client\Model\VideoThumbnailPickPayload $videoThumbnailPickPayload): \ApiVideo\Client\Model\Video
     {
@@ -820,7 +820,7 @@ private function buildPickThumbnailRequest(string $videoId, \ApiVideo\Client\Mod
      *
      * @throws \ApiVideo\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
-     * @return \ApiVideo\Client\Model\VideoStatus|\ApiVideo\Client\Model\NotFound
+     * @return \ApiVideo\Client\Model\VideoStatus|\ApiVideo\Client\Model\NotFound|\ApiVideo\Client\Model\TooManyRequests
      */
     public function getStatus(string $videoId): \ApiVideo\Client\Model\VideoStatus
     {