gcore 0.12.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

gcore/resources/streaming/videos/subtitles.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import httpx
 
-from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ...._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
 from ...._utils import maybe_transform, async_maybe_transform
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -53,13 +53,14 @@ class SubtitlesResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Subtitle:
         """
         Add new subtitle/captions to a video entity.
 
-        **Add already exist subtitles** Subtitles must be in one of the following
-        formats:
+        **Add already exist subtitles**
+
+        Subtitles must be in one of the following formats:
 
         - SRT – SubRip Text is described on
           [wikipedia.org](https://en.wikipedia.org/wiki/SubRip#SubRip_file_format). Must
@@ -69,19 +70,26 @@ class SubtitlesResource(SyncAPIResource):
         - WebVTT – Web Video Text Tracks Format is described on
           [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API).
           Must start from "WEBVTT" header. Use validators to check the subtitles, like
-          [W3C](https://w3c.github.io/webvtt.js/parser.html). Language is 3-letter
-          language code according to ISO-639-2 (bibliographic code). Specify language
-          you need, or just look at our list in the attribute "`audio_language`" of
-          section
-          ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
-          You can add multiple subtitles in the same language, language uniqueness is
-          not required. Size must be up to 5Mb.
+          [W3C](https://w3c.github.io/webvtt.js/parser.html).
+
+        Language is 3-letter language code according to ISO-639-2 (bibliographic code).
+        Specify language you need, or just look at our list in the attribute
+        "`audio_language`" of section
+        ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
+
+        You can add multiple subtitles in the same language, language uniqueness is not
+        required.
+
+        Size must be up to 5Mb.
 
         The update time for added or changed subtitles is up to 30 seconds. Just like
         videos, subtitles are cached, so it takes time to update the data.
 
-        **AI subtitles and transcribing** It is also possible to automatically create
-        subtitles based on AI. Read more:
+        **AI subtitles and transcribing**
+
+        It is also possible to automatically create subtitles based on AI.
+
+        Read more:
 
         - What is
           ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
@@ -95,14 +103,20 @@ class SubtitlesResource(SyncAPIResource):
           that. Also you can point several languages to translate to, then a separate
           subtitle will be generated for each specified language. The created AI-task(s)
           will be automatically executed, and result will also be automatically attached
-          to this video as subtitle(s). If AI is disabled in your account, you will
-          receive code 422 in response.
+          to this video as subtitle(s).
 
-        **Where and how subtitles are displayed?** Subtitles are became available in the
-        API response and in playback manifests. All added subtitles are automatically
-        inserted into the output manifest .m3u8. This way, subtitles become available to
-        any player: our player, OS built-in, or other specialized ones. You don't need
-        to do anything else. Read more information in the Knowledge Base. Example:
+        If AI is disabled in your account, you will receive code 422 in response.
+
+        **Where and how subtitles are displayed?**
+
+        Subtitles are became available in the API response and in playback manifests.
+
+        All added subtitles are automatically inserted into the output manifest .m3u8.
+        This way, subtitles become available to any player: our player, OS built-in, or
+        other specialized ones. You don't need to do anything else. Read more
+        information in the Knowledge Base.
+
+        Example:
 
         ```
         # EXT-X-MEDIA:TYPE=SUBTITLES,GROUP-ID="subs0",NAME="English",LANGUAGE="en",AUTOSELECT=YES,URI="subs-0.m3u8"
@@ -120,7 +134,9 @@ class SubtitlesResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._post(
-            f"/streaming/videos/{video_id}/subtitles",
+            f"/streaming/videos/{video_id}/subtitles"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles",
             body=maybe_transform(body, subtitle_create_params.SubtitleCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -133,26 +149,30 @@ class SubtitlesResource(SyncAPIResource):
         id: int,
         *,
         video_id: int,
-        language: str | NotGiven = NOT_GIVEN,
-        name: str | NotGiven = NOT_GIVEN,
-        vtt: str | NotGiven = NOT_GIVEN,
+        language: str | Omit = omit,
+        name: str | Omit = omit,
+        vtt: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SubtitleBase:
-        """Method to update subtitle of a video.
+        """
+        Method to update subtitle of a video.
+
+        You can update all or only some of fields you need.
 
-        You can update all or only some of fields
-        you need. If you want to replace the text of subtitles (i.e. found a typo in the
-        text, or the timing in the video changed), then:
+        If you want to replace the text of subtitles (i.e. found a typo in the text, or
+        the timing in the video changed), then:
 
         - download it using GET method,
         - change it in an external editor,
-        - and update it using this PATCH method. Just like videos, subtitles are cached,
-          so it takes time to update the data. See POST method for details.
+        - and update it using this PATCH method.
+
+        Just like videos, subtitles are cached, so it takes time to update the data. See
+        POST method for details.
 
         Args:
           language: 3-letter language code according to ISO-639-2 (bibliographic code)
@@ -170,7 +190,9 @@ class SubtitlesResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._patch(
-            f"/streaming/videos/{video_id}/subtitles/{id}",
+            f"/streaming/videos/{video_id}/subtitles/{id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles/{id}",
             body=maybe_transform(
                 {
                     "language": language,
@@ -194,7 +216,7 @@ class SubtitlesResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SubtitleListResponse:
         """
         Method returns a list of all subtitles that are already attached to a video.
@@ -209,7 +231,9 @@ class SubtitlesResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get(
-            f"/streaming/videos/{video_id}/subtitles",
+            f"/streaming/videos/{video_id}/subtitles"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -226,7 +250,7 @@ class SubtitlesResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Delete specified video subtitle
@@ -242,7 +266,9 @@ class SubtitlesResource(SyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._delete(
-            f"/streaming/videos/{video_id}/subtitles/{id}",
+            f"/streaming/videos/{video_id}/subtitles/{id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles/{id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -259,7 +285,7 @@ class SubtitlesResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Subtitle:
         """
         Returns information about a specific subtitle for a video.
@@ -274,7 +300,9 @@ class SubtitlesResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get(
-            f"/streaming/videos/{video_id}/subtitles/{id}",
+            f"/streaming/videos/{video_id}/subtitles/{id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles/{id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -312,13 +340,14 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Subtitle:
         """
         Add new subtitle/captions to a video entity.
 
-        **Add already exist subtitles** Subtitles must be in one of the following
-        formats:
+        **Add already exist subtitles**
+
+        Subtitles must be in one of the following formats:
 
         - SRT – SubRip Text is described on
           [wikipedia.org](https://en.wikipedia.org/wiki/SubRip#SubRip_file_format). Must
@@ -328,19 +357,26 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         - WebVTT – Web Video Text Tracks Format is described on
           [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API).
           Must start from "WEBVTT" header. Use validators to check the subtitles, like
-          [W3C](https://w3c.github.io/webvtt.js/parser.html). Language is 3-letter
-          language code according to ISO-639-2 (bibliographic code). Specify language
-          you need, or just look at our list in the attribute "`audio_language`" of
-          section
-          ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
-          You can add multiple subtitles in the same language, language uniqueness is
-          not required. Size must be up to 5Mb.
+          [W3C](https://w3c.github.io/webvtt.js/parser.html).
+
+        Language is 3-letter language code according to ISO-639-2 (bibliographic code).
+        Specify language you need, or just look at our list in the attribute
+        "`audio_language`" of section
+        ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
+
+        You can add multiple subtitles in the same language, language uniqueness is not
+        required.
+
+        Size must be up to 5Mb.
 
         The update time for added or changed subtitles is up to 30 seconds. Just like
         videos, subtitles are cached, so it takes time to update the data.
 
-        **AI subtitles and transcribing** It is also possible to automatically create
-        subtitles based on AI. Read more:
+        **AI subtitles and transcribing**
+
+        It is also possible to automatically create subtitles based on AI.
+
+        Read more:
 
         - What is
           ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
@@ -354,14 +390,20 @@ class AsyncSubtitlesResource(AsyncAPIResource):
           that. Also you can point several languages to translate to, then a separate
           subtitle will be generated for each specified language. The created AI-task(s)
           will be automatically executed, and result will also be automatically attached
-          to this video as subtitle(s). If AI is disabled in your account, you will
-          receive code 422 in response.
+          to this video as subtitle(s).
 
-        **Where and how subtitles are displayed?** Subtitles are became available in the
-        API response and in playback manifests. All added subtitles are automatically
-        inserted into the output manifest .m3u8. This way, subtitles become available to
-        any player: our player, OS built-in, or other specialized ones. You don't need
-        to do anything else. Read more information in the Knowledge Base. Example:
+        If AI is disabled in your account, you will receive code 422 in response.
+
+        **Where and how subtitles are displayed?**
+
+        Subtitles are became available in the API response and in playback manifests.
+
+        All added subtitles are automatically inserted into the output manifest .m3u8.
+        This way, subtitles become available to any player: our player, OS built-in, or
+        other specialized ones. You don't need to do anything else. Read more
+        information in the Knowledge Base.
+
+        Example:
 
         ```
         # EXT-X-MEDIA:TYPE=SUBTITLES,GROUP-ID="subs0",NAME="English",LANGUAGE="en",AUTOSELECT=YES,URI="subs-0.m3u8"
@@ -379,7 +421,9 @@ class AsyncSubtitlesResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._post(
-            f"/streaming/videos/{video_id}/subtitles",
+            f"/streaming/videos/{video_id}/subtitles"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles",
             body=await async_maybe_transform(body, subtitle_create_params.SubtitleCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -392,26 +436,30 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         id: int,
         *,
         video_id: int,
-        language: str | NotGiven = NOT_GIVEN,
-        name: str | NotGiven = NOT_GIVEN,
-        vtt: str | NotGiven = NOT_GIVEN,
+        language: str | Omit = omit,
+        name: str | Omit = omit,
+        vtt: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SubtitleBase:
-        """Method to update subtitle of a video.
+        """
+        Method to update subtitle of a video.
+
+        You can update all or only some of fields you need.
 
-        You can update all or only some of fields
-        you need. If you want to replace the text of subtitles (i.e. found a typo in the
-        text, or the timing in the video changed), then:
+        If you want to replace the text of subtitles (i.e. found a typo in the text, or
+        the timing in the video changed), then:
 
         - download it using GET method,
         - change it in an external editor,
-        - and update it using this PATCH method. Just like videos, subtitles are cached,
-          so it takes time to update the data. See POST method for details.
+        - and update it using this PATCH method.
+
+        Just like videos, subtitles are cached, so it takes time to update the data. See
+        POST method for details.
 
         Args:
           language: 3-letter language code according to ISO-639-2 (bibliographic code)
@@ -429,7 +477,9 @@ class AsyncSubtitlesResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._patch(
-            f"/streaming/videos/{video_id}/subtitles/{id}",
+            f"/streaming/videos/{video_id}/subtitles/{id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles/{id}",
             body=await async_maybe_transform(
                 {
                     "language": language,
@@ -453,7 +503,7 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SubtitleListResponse:
         """
         Method returns a list of all subtitles that are already attached to a video.
@@ -468,7 +518,9 @@ class AsyncSubtitlesResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._get(
-            f"/streaming/videos/{video_id}/subtitles",
+            f"/streaming/videos/{video_id}/subtitles"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -485,7 +537,7 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Delete specified video subtitle
@@ -501,7 +553,9 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._delete(
-            f"/streaming/videos/{video_id}/subtitles/{id}",
+            f"/streaming/videos/{video_id}/subtitles/{id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles/{id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -518,7 +572,7 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Subtitle:
         """
         Returns information about a specific subtitle for a video.
@@ -533,7 +587,9 @@ class AsyncSubtitlesResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._get(
-            f"/streaming/videos/{video_id}/subtitles/{id}",
+            f"/streaming/videos/{video_id}/subtitles/{id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/videos/{video_id}/subtitles/{id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),