Merge pull request #120 from ToshY/feature/116

Implement Stream API `Transcribe Video` post endpoint

Author: ToshY

Diff for: docs/stream-api.md

@@ -356,9 +356,9 @@ $streamApi->fetchVideo(
 $streamApi->addCaption(
     libraryId: 1,
     videoId: 'e7e9b99a-ea2a-434a-b200-f6615e7b6abd',
-    sourceLanguage: 'jp',
+    sourceLanguage: 'ja',
     body: [
-        'srclang' => 'jp',
+        'srclang' => 'ja',
         'label' => 'Subtitles (Japanese)',
         'captionsFile' => 'MQowMDowMDowMCwwMDAgLS0+IDAwOjAxOjAwLDAwMApOZXZlciBnb25uYSBnaXZlIHlvdSB1cC4K',
     ],
@@ -367,7 +367,7 @@ $streamApi->addCaption(
 
 !!! note
 
-    - The `sourceLanguage` / `srclang` is the [language shortcode](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the caption.
+    - The `sourceLanguage` / `srclang` is a [two-letter (set 1) language abbreviation](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for the caption.
     - The `captionsFile` requires the file contents to be sent as a base64 encoded string.
 
 #### [Delete Caption](https://docs.bunny.net/reference/video_deletecaption)
@@ -376,13 +376,31 @@ $streamApi->addCaption(
 $streamApi->deleteCaption(
     libraryId: 1,
     videoId: 'e7e9b99a-ea2a-434a-b200-f6615e7b6abd',
-    sourceLanguage: 'jp',
+    sourceLanguage: 'ja',
 );
 ```
 
 !!! note
 
-    - The `sourceLanguage` is the [language shortcode](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the caption.
+    - The `sourceLanguage` is a [two-letter (set 1) language abbreviation](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for the caption.
+
+#### [Transcribe Video](https://docs.bunny.net/reference/video_transcribevideo)
+
+```php
+$streamApi->transcribeVideo(
+    libraryId: 1,
+    videoId: 'e7e9b99a-ea2a-434a-b200-f6615e7b6abd',
+    query: [
+        'language' => 'fi',
+        'force' => true,
+    ],
+);
+```
+
+!!! note
+
+    - The `language` is a [two-letter (set 1) language abbreviation](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for transcribing the video.
+    - Once a video has transcribed you need to set `force` to `true` in order to force a new transcription to be added.
 
 #### [Get OEmbed](https://docs.bunny.net/reference/oembed_getoembed)
 

Diff for: src/Model/API/Stream/ManageVideos/TranscribeVideo.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ToshY\BunnyNet\Model\API\Stream\ManageVideos;
+
+use ToshY\BunnyNet\Enum\Header;
+use ToshY\BunnyNet\Enum\Method;
+use ToshY\BunnyNet\Enum\Type;
+use ToshY\BunnyNet\Model\AbstractParameter;
+use ToshY\BunnyNet\Model\EndpointInterface;
+use ToshY\BunnyNet\Model\EndpointQueryInterface;
+
+class TranscribeVideo implements EndpointInterface, EndpointQueryInterface
+{
+    public function getMethod(): Method
+    {
+        return Method::POST;
+    }
+
+    public function getPath(): string
+    {
+        return 'library/%d/videos/%s/transcribe';
+    }
+
+    public function getHeaders(): array
+    {
+        return [
+            Header::ACCEPT_JSON,
+        ];
+    }
+
+    public function getQuery(): array
+    {
+        return [
+            new AbstractParameter(name: 'language', type: Type::STRING_TYPE, required: true),
+            new AbstractParameter(name: 'force', type: Type::BOOLEAN_TYPE),
+        ];
+    }
+}

Diff for: src/StreamAPI.php

@@ -32,6 +32,7 @@
 use ToshY\BunnyNet\Model\API\Stream\ManageVideos\RepackageVideo;
 use ToshY\BunnyNet\Model\API\Stream\ManageVideos\SetThumbnail;
 use ToshY\BunnyNet\Model\API\Stream\ManageVideos\SetThumbnailByBody;
+use ToshY\BunnyNet\Model\API\Stream\ManageVideos\TranscribeVideo;
 use ToshY\BunnyNet\Model\API\Stream\ManageVideos\UpdateVideo;
 use ToshY\BunnyNet\Model\API\Stream\ManageVideos\UploadVideo;
 use ToshY\BunnyNet\Model\API\Stream\OEmbed\GetOEmbed;
@@ -590,6 +591,34 @@ public function deleteCaption(
         );
     }
 
+    /**
+     * @throws ClientExceptionInterface
+     * @throws Exception\BunnyClientResponseException
+     * @throws Exception\JSONException
+     * @throws Exception\InvalidTypeForKeyValueException
+     * @throws Exception\InvalidTypeForListValueException
+     * @throws Exception\ParameterIsRequiredException
+     * @param int $libraryId
+     * @param string $videoId
+     * @param array<string,mixed> $query
+     * @return BunnyClientResponseInterface
+     */
+    public function transcribeVideo(
+        int $libraryId,
+        string $videoId,
+        array $query,
+    ): BunnyClientResponseInterface {
+        $endpoint = new TranscribeVideo();
+
+        ParameterValidator::validate($query, $endpoint->getQuery());
+
+        return $this->client->request(
+            endpoint: $endpoint,
+            parameters: [$libraryId, $videoId],
+            query: $query,
+        );
+    }
+
     /**
      * @throws ClientExceptionInterface
      * @throws Exception\BunnyClientResponseException