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

gcore/resources/streaming/quality_sets.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import httpx
 
-from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -49,7 +49,7 @@ class QualitySetsResource(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,
     ) -> QualitySets:
         """
         Method returns a list of all custom quality sets.
@@ -64,19 +64,26 @@ class QualitySetsResource(SyncAPIResource):
         described in the
         [documentation](https://gcore.com/docs/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs).
         These values are the default for everyone. There is no need to configure
-        anything additional. Read more about qiality in our blog
+        anything additional.
+
+        Read more about qiality in our blog
         [How we lowered the bitrate for live and VOD streaming by 32.5% without sacrificing quality](https://gcore.com/blog/how-we-lowered-the-bitrate-for-live-and-vod-streaming-by-32-5-without-sacrificing-quality).
-        ![Quality ladder](https://demo-files.gvideo.io/apidocs/encoding_ladder.png) Only
-        for those cases when, in addition to the main parameters, it is necessary to use
-        your own, then it is necessary to use custom quality sets. How to use:
+
+        ![Quality ladder](https://demo-files.gvideo.io/apidocs/encoding_ladder.png)
+
+        Only for those cases when, in addition to the main parameters, it is necessary
+        to use your own, then it is necessary to use custom quality sets.
+
+        How to use:
 
         1. By default custom quality set is empty – `{ "live":[],"vod":[] }`
         2. Request the use of custom quality sets from your manager or the Support Team.
         3. Please forward your requirements to us, since the parameters are set not by
            you, but by our engineers. (We are working to ensure that later you can
            create qualities by yourself.)
-        4. Use the created quality sets through the these specified API methods. Here
-           are some common parameters of quality settings:
+        4. Use the created quality sets through the these specified API methods.
+
+        Here are some common parameters of quality settings:
 
         - Resolution: Determines the size of the video frame. I.e. 720p, 1080p, 4K, etc.
         - Bitrate: Refers to the amount of data processed per unit of time.
@@ -91,7 +98,9 @@ class QualitySetsResource(SyncAPIResource):
           is a paid feature.
         """
         return self._get(
-            "/streaming/quality_sets",
+            "/streaming/quality_sets"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/quality_sets",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -101,28 +110,32 @@ class QualitySetsResource(SyncAPIResource):
     def set_default(
         self,
         *,
-        live: quality_set_set_default_params.Live | NotGiven = NOT_GIVEN,
-        vod: quality_set_set_default_params.Vod | NotGiven = NOT_GIVEN,
+        live: quality_set_set_default_params.Live | Omit = omit,
+        vod: quality_set_set_default_params.Vod | 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,
     ) -> QualitySets:
-        """Method to set default quality set for VOD and Live transcoding.
+        """
+        Method to set default quality set for VOD and Live transcoding.
+
+        For changing default quality set, specify the ID of the custom quality set from
+        the method GET /`quality_sets`.
 
-        For changing
-        default quality set, specify the ID of the custom quality set from the method
-        GET /`quality_sets`. Default value can be reverted to the system defaults
-        (cleared) by setting `"id": null`.
+        Default value can be reverted to the system defaults (cleared) by setting
+        `"id": null`.
 
         Live transcoding management:
 
         - You can specify quality set explicitly in POST /streams method, look at
           attribute "`quality_set_id`".
-        - Otherwise these default values will be used by the system by default. VOD
-          transcoding management:
+        - Otherwise these default values will be used by the system by default.
+
+        VOD transcoding management:
+
         - You can specify quality set explicitly in POST /videos method, look at
           attribute "`quality_set_id`".
         - Otherwise these default values will be used by the system by default.
@@ -137,7 +150,9 @@ class QualitySetsResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._put(
-            "/streaming/quality_sets/default",
+            "/streaming/quality_sets/default"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/quality_sets/default",
             body=maybe_transform(
                 {
                     "live": live,
@@ -180,7 +195,7 @@ class AsyncQualitySetsResource(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,
     ) -> QualitySets:
         """
         Method returns a list of all custom quality sets.
@@ -195,19 +210,26 @@ class AsyncQualitySetsResource(AsyncAPIResource):
         described in the
         [documentation](https://gcore.com/docs/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs).
         These values are the default for everyone. There is no need to configure
-        anything additional. Read more about qiality in our blog
+        anything additional.
+
+        Read more about qiality in our blog
         [How we lowered the bitrate for live and VOD streaming by 32.5% without sacrificing quality](https://gcore.com/blog/how-we-lowered-the-bitrate-for-live-and-vod-streaming-by-32-5-without-sacrificing-quality).
-        ![Quality ladder](https://demo-files.gvideo.io/apidocs/encoding_ladder.png) Only
-        for those cases when, in addition to the main parameters, it is necessary to use
-        your own, then it is necessary to use custom quality sets. How to use:
+
+        ![Quality ladder](https://demo-files.gvideo.io/apidocs/encoding_ladder.png)
+
+        Only for those cases when, in addition to the main parameters, it is necessary
+        to use your own, then it is necessary to use custom quality sets.
+
+        How to use:
 
         1. By default custom quality set is empty – `{ "live":[],"vod":[] }`
         2. Request the use of custom quality sets from your manager or the Support Team.
         3. Please forward your requirements to us, since the parameters are set not by
            you, but by our engineers. (We are working to ensure that later you can
            create qualities by yourself.)
-        4. Use the created quality sets through the these specified API methods. Here
-           are some common parameters of quality settings:
+        4. Use the created quality sets through the these specified API methods.
+
+        Here are some common parameters of quality settings:
 
         - Resolution: Determines the size of the video frame. I.e. 720p, 1080p, 4K, etc.
         - Bitrate: Refers to the amount of data processed per unit of time.
@@ -222,7 +244,9 @@ class AsyncQualitySetsResource(AsyncAPIResource):
           is a paid feature.
         """
         return await self._get(
-            "/streaming/quality_sets",
+            "/streaming/quality_sets"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/quality_sets",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -232,28 +256,32 @@ class AsyncQualitySetsResource(AsyncAPIResource):
     async def set_default(
         self,
         *,
-        live: quality_set_set_default_params.Live | NotGiven = NOT_GIVEN,
-        vod: quality_set_set_default_params.Vod | NotGiven = NOT_GIVEN,
+        live: quality_set_set_default_params.Live | Omit = omit,
+        vod: quality_set_set_default_params.Vod | 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,
     ) -> QualitySets:
-        """Method to set default quality set for VOD and Live transcoding.
+        """
+        Method to set default quality set for VOD and Live transcoding.
+
+        For changing default quality set, specify the ID of the custom quality set from
+        the method GET /`quality_sets`.
 
-        For changing
-        default quality set, specify the ID of the custom quality set from the method
-        GET /`quality_sets`. Default value can be reverted to the system defaults
-        (cleared) by setting `"id": null`.
+        Default value can be reverted to the system defaults (cleared) by setting
+        `"id": null`.
 
         Live transcoding management:
 
         - You can specify quality set explicitly in POST /streams method, look at
           attribute "`quality_set_id`".
-        - Otherwise these default values will be used by the system by default. VOD
-          transcoding management:
+        - Otherwise these default values will be used by the system by default.
+
+        VOD transcoding management:
+
         - You can specify quality set explicitly in POST /videos method, look at
           attribute "`quality_set_id`".
         - Otherwise these default values will be used by the system by default.
@@ -268,7 +296,9 @@ class AsyncQualitySetsResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._put(
-            "/streaming/quality_sets/default",
+            "/streaming/quality_sets/default"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/quality_sets/default",
             body=await async_maybe_transform(
                 {
                     "live": live,

gcore/resources/streaming/restreams.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
@@ -45,13 +45,13 @@ class RestreamsResource(SyncAPIResource):
     def create(
         self,
         *,
-        restream: restream_create_params.Restream | NotGiven = NOT_GIVEN,
+        restream: restream_create_params.Restream | 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,
     ) -> None:
         """
         Create restream
@@ -67,7 +67,9 @@ class RestreamsResource(SyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
-            "/streaming/restreams",
+            "/streaming/restreams"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/restreams",
             body=maybe_transform({"restream": restream}, restream_create_params.RestreamCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -79,13 +81,13 @@ class RestreamsResource(SyncAPIResource):
         self,
         restream_id: int,
         *,
-        restream: restream_update_params.Restream | NotGiven = NOT_GIVEN,
+        restream: restream_update_params.Restream | 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,
     ) -> Restream:
         """
         Updates restream settings
@@ -100,7 +102,9 @@ class RestreamsResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._patch(
-            f"/streaming/restreams/{restream_id}",
+            f"/streaming/restreams/{restream_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/restreams/{restream_id}",
             body=maybe_transform({"restream": restream}, restream_update_params.RestreamUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -111,13 +115,13 @@ class RestreamsResource(SyncAPIResource):
     def list(
         self,
         *,
-        page: int | NotGiven = NOT_GIVEN,
+        page: int | 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,
     ) -> SyncPageStreaming[Restream]:
         """Returns a list of created restreams
 
@@ -135,7 +139,9 @@ class RestreamsResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get_api_list(
-            "/streaming/restreams",
+            "/streaming/restreams"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/restreams",
             page=SyncPageStreaming[Restream],
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -156,7 +162,7 @@ class RestreamsResource(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 restream
@@ -172,7 +178,9 @@ class RestreamsResource(SyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._delete(
-            f"/streaming/restreams/{restream_id}",
+            f"/streaming/restreams/{restream_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/restreams/{restream_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -188,7 +196,7 @@ class RestreamsResource(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,
     ) -> Restream:
         """
         Returns restream details
@@ -203,7 +211,9 @@ class RestreamsResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get(
-            f"/streaming/restreams/{restream_id}",
+            f"/streaming/restreams/{restream_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/restreams/{restream_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -234,13 +244,13 @@ class AsyncRestreamsResource(AsyncAPIResource):
     async def create(
         self,
         *,
-        restream: restream_create_params.Restream | NotGiven = NOT_GIVEN,
+        restream: restream_create_params.Restream | 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,
     ) -> None:
         """
         Create restream
@@ -256,7 +266,9 @@ class AsyncRestreamsResource(AsyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
-            "/streaming/restreams",
+            "/streaming/restreams"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/restreams",
             body=await async_maybe_transform({"restream": restream}, restream_create_params.RestreamCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -268,13 +280,13 @@ class AsyncRestreamsResource(AsyncAPIResource):
         self,
         restream_id: int,
         *,
-        restream: restream_update_params.Restream | NotGiven = NOT_GIVEN,
+        restream: restream_update_params.Restream | 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,
     ) -> Restream:
         """
         Updates restream settings
@@ -289,7 +301,9 @@ class AsyncRestreamsResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._patch(
-            f"/streaming/restreams/{restream_id}",
+            f"/streaming/restreams/{restream_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/restreams/{restream_id}",
             body=await async_maybe_transform({"restream": restream}, restream_update_params.RestreamUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -300,13 +314,13 @@ class AsyncRestreamsResource(AsyncAPIResource):
     def list(
         self,
         *,
-        page: int | NotGiven = NOT_GIVEN,
+        page: int | 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,
     ) -> AsyncPaginator[Restream, AsyncPageStreaming[Restream]]:
         """Returns a list of created restreams
 
@@ -324,7 +338,9 @@ class AsyncRestreamsResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get_api_list(
-            "/streaming/restreams",
+            "/streaming/restreams"
+            if self._client._base_url_overridden
+            else "https://api.gcore.com//streaming/restreams",
             page=AsyncPageStreaming[Restream],
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -345,7 +361,7 @@ class AsyncRestreamsResource(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 restream
@@ -361,7 +377,9 @@ class AsyncRestreamsResource(AsyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._delete(
-            f"/streaming/restreams/{restream_id}",
+            f"/streaming/restreams/{restream_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/restreams/{restream_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -377,7 +395,7 @@ class AsyncRestreamsResource(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,
     ) -> Restream:
         """
         Returns restream details
@@ -392,7 +410,9 @@ class AsyncRestreamsResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._get(
-            f"/streaming/restreams/{restream_id}",
+            f"/streaming/restreams/{restream_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/restreams/{restream_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),