gcore 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

gcore/types/streaming/video_update_params.py

@@ -0,0 +1,214 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["VideoUpdateParams"]
+
+
+class VideoUpdateParams(TypedDict, total=False):
+    name: Required[str]
+    """Video name"""
+
+    auto_transcribe_audio_language: Literal["disable", "auto", "<language_code>"]
+    """Automatic creation of subtitles by transcribing the audio track. Values:
+
+    - disable – Do not transcribe.
+    - auto – Automatically detects the activation of the option based on the
+      settings in your account. If generation is activated, then automatic language
+      detection while transcribing.
+    - \\  – Transcribe from specific language. Can be used to specify the exact
+      language spoken in the audio track, or when auto language detection fails.
+      Language is set by 3-letter language code according to ISO-639-2
+      (bibliographic code). List of languages is available in `audio_language`
+      attribute of API POST /streaming/ai/transcribe . Example:
+
+    ```
+    `auto_transcribe_audio_language`: "auto"
+    `auto_transcribe_audio_language`: "ger"
+    ```
+
+    More details:
+
+    - List of AI tasks – API
+      [GET /streaming/ai/tasks](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/ai/get-ai-task-result)
+    - Add subtitles to an exist video – API
+      [POST /streaming/videos/{`video_id`}/subtitles](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/subtitles/add-subtitle).
+    """
+
+    auto_translate_subtitles_language: Literal["disable", "default", "<language_codes,>"]
+    """Automatic translation of auto-transcribed subtitles to the specified
+    language(s).
+
+    Can be used both together with `auto_transcribe_audio_language` option only. Use
+    it when you want to make automatic subtitles in languages other than the
+    original language in audio. Values:
+
+    - disable – Do not translate.
+    - default – There are 3 default languages: eng,fre,ger
+    - \\  – Explicit language to translate to, or list of languages separated by a
+      comma. Look at list of available languages in description of AI ASR task
+      creation. If several languages are specified for translation, a separate
+      subtitle will be generated for each language. Example:
+
+    ```
+    `auto_translate_subtitles_language`: default
+    `auto_translate_subtitles_language`: eng,fre,ger
+    ```
+
+    Please note that subtitle translation is done separately and after
+    transcription. Thus separate AI-tasks are created for translation.
+    """
+
+    client_user_id: int
+    """Custom field where you can specify user ID in your system"""
+
+    clip_duration_seconds: int
+    """
+    The length of the trimmed segment to transcode, instead of the entire length of
+    the video. Is only used in conjunction with specifying the start of a segment.
+    Transcoding duration is a number in seconds.
+    """
+
+    clip_start_seconds: int
+    """
+    If you want to transcode only a trimmed segment of a video instead of entire
+    length if the video, then you can provide timecodes of starting point and
+    duration of a segment to process. Start encoding from is a number in seconds.
+    """
+
+    custom_iframe_url: str
+    """
+    Deprecated. Custom URL of IFrame for video player to be used in share panel in
+    player. Auto generated IFrame URL provided by default
+    """
+
+    description: str
+    """Video details; not visible to the end-users"""
+
+    directory_id: int
+    """ID of the directory where the video should be uploaded. (beta)"""
+
+    origin_http_headers: str
+    """Authorization HTTP request header.
+
+    Will be used as credentials to authenticate a request to download a file
+    (specified in "`origin_url`" parameter) on an external server. Syntax:
+    `Authorization: ` Examples:
+
+    - "`origin_http_headers`": "Authorization: Basic ..."
+    - "`origin_http_headers`": "Authorization: Bearer ..."
+    - "`origin_http_headers`": "Authorization: APIKey ..." Example of usage when
+      downloading a file from Google Drive:
+
+    ```
+    POST https://api.gcore.com/streaming/videos
+    "video": {
+    "name": "IBC 2024 intro.mp4",
+    "`origin_url`": "https://www.googleapis.com/drive/v3/files/...?alt=media",
+    "`origin_http_headers`": "Authorization: Bearer ABC"
+    }
+    ```
+    """
+
+    origin_url: str
+    """
+    URL to an original file which you want to copy from external storage. If
+    specified, system will download the file and will use it as video source for
+    transcoding.
+    """
+
+    poster: str
+    """
+    Poster is your own static image which can be displayed before the video starts.
+    After uploading the video, the system will automatically create several
+    screenshots (they will be stored in "screenshots" attribute) from which you can
+    select an default screenshot. This "poster" field is for uploading your own
+    image. Also use attribute "`screenshot_id`" to select poster as a default
+    screnshot. Attribute accepts single image as base64-encoded string
+    [(RFC 2397 – The "data" URL scheme)](https://www.rfc-editor.org/rfc/rfc2397). In
+    format: `data:[];base64,` MIME-types are image/jpeg, image/webp, and image/png
+    and file sizes up to 1Mb. Examples:
+
+    - `data:image/jpeg;base64,/9j/4AA...qf/2Q==`
+    - `data:image/png;base64,iVBORw0KGg...ggg==`
+    - `data:image/webp;base64,UklGRt.../DgAAAAA`
+    """
+
+    priority: int
+    """
+    Priority allows you to adjust the urgency of processing some videos before
+    others in your account, if your algorithm requires it. For example, when there
+    are very urgent video and some regular ones that can wait in the queue. Value
+    range, integer [-10..10]. -10 is the lowest down-priority, 10 is the highest
+    up-priority. Default priority is 0.
+    """
+
+    projection: str
+    """Deprecated. Regulates the video format:
+
+    - **regular** — plays the video as usual
+    - **vr360** — plays the video in 360 degree mode
+    - **vr180** — plays the video in 180 degree mode
+    - **vr360tb** — plays the video in 3D 360 degree mode Top-Bottom.
+
+    Default is regular
+    """
+
+    quality_set_id: int
+    """
+    Custom quality set ID for transcoding, if transcoding is required according to
+    your conditions. Look at GET /`quality_sets` method
+    """
+
+    remote_poster_url: str
+    """
+    Poster URL to download from external resource, instead of uploading via "poster"
+    attribute. It has the same restrictions as "poster" attribute.
+    """
+
+    remove_poster: bool
+    """Set it to true to remove poster"""
+
+    screenshot_id: int
+    """
+    Default screenshot index. Specify an ID from the "screenshots" array, so that
+    the URL of the required screenshot appears in the "screenshot" attribute as the
+    default screenshot. By default 5 static screenshots will be taken from different
+    places in the video after transcoding. If the video is short, there may be fewer
+    screenshots. Counting from 0. A value of -1 sets the default screenshot to the
+    URL of your own image from the "poster" attribute. Look at "screenshot"
+    attribute in GET /videos/{`video_id`} for details.
+    """
+
+    share_url: str
+    """
+    Deprecated. Custom URL or iframe displayed in the link field when a user clicks
+    on a sharing button in player. If empty, the link field and social network
+    sharing is disabled
+    """
+
+    source_bitrate_limit: bool
+    """
+    The option allows you to set the video transcoding rule so that the output
+    bitrate in ABR ladder is not exceeding the bitrate of the original video.
+
+    This option is for advanced users only.
+
+    By default `source_bitrate_limit: true` this option allows you to have the
+    output bitrate not more than in the original video, thus to transcode video
+    faster and to deliver it to end-viewers faster as well. At the same time, the
+    quality will be similar to the original. If for some reason you need more
+    byte-space in the output quality when encoding, you can set this option to
+    `source_bitrate_limit: false`. Then, when transcoding, the quality ceiling will
+    be raised from the bitrate of the original video to the maximum possible limit
+    specified in our the Product Documentation. For example, this may be needed
+    when:
+
+    - to improve the visual quality parameters using PSNR, SSIM, VMAF metrics,
+    - to improve the picture quality on dynamic scenes,
+    - etc. The option is applied only at the video creation stage and cannot be
+      changed later. If you want to re-transcode the video using new value, then you
+      need to create and upload a new video only.
+    """

gcore/types/streaming/videos/__init__.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .subtitle_create_params import SubtitleCreateParams as SubtitleCreateParams
+from .subtitle_list_response import SubtitleListResponse as SubtitleListResponse
+from .subtitle_update_params import SubtitleUpdateParams as SubtitleUpdateParams

gcore/types/streaming/videos/subtitle_create_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+from ..subtitle_base_param import SubtitleBaseParam
+
+__all__ = ["SubtitleCreateParams", "Body"]
+
+
+class SubtitleCreateParams(TypedDict, total=False):
+    body: Required[Body]
+
+
+class Body(SubtitleBaseParam, total=False):
+    pass

gcore/types/streaming/videos/subtitle_list_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from ..subtitle import Subtitle
+
+__all__ = ["SubtitleListResponse"]
+
+SubtitleListResponse: TypeAlias = List[Subtitle]

gcore/types/streaming/videos/subtitle_update_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SubtitleUpdateParams"]
+
+
+class SubtitleUpdateParams(TypedDict, total=False):
+    video_id: Required[int]
+
+    language: str
+    """3-letter language code according to ISO-639-2 (bibliographic code)"""
+
+    name: str
+    """Name of subtitle file"""
+
+    vtt: str
+    """Full text of subtitles/captions, with escaped "\n" ("\r") symbol of new line"""

gcore/types/streaming/views.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["Views", "Data"]
+
+
+class Data(BaseModel):
+    date: str
+
+    type: str
+
+    views: int
+
+    id: Optional[int] = None
+
+    browser: Optional[str] = None
+
+    country: Optional[str] = None
+
+    event: Optional[str] = None
+
+    host: Optional[str] = None
+
+    ip: Optional[str] = None
+
+    os: Optional[str] = None
+
+    platform: Optional[str] = None
+
+
+class Views(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/views_by_browser.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ViewsByBrowser", "Data"]
+
+
+class Data(BaseModel):
+    browser: str
+
+    views: int
+
+
+class ViewsByBrowser(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/views_by_country.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ViewsByCountry", "Data"]
+
+
+class Data(BaseModel):
+    country: str
+
+    country_name: str
+
+    views: int
+
+
+class ViewsByCountry(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/views_by_hostname.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ViewsByHostname", "Data"]
+
+
+class Data(BaseModel):
+    host: str
+
+    views: int
+
+
+class ViewsByHostname(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/views_by_operating_system.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ViewsByOperatingSystem", "Data"]
+
+
+class Data(BaseModel):
+    os: str
+
+    views: int
+
+
+class ViewsByOperatingSystem(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/views_by_referer.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ViewsByReferer", "Data"]
+
+
+class Data(BaseModel):
+    embed_url: str
+
+    views: int
+
+
+class ViewsByReferer(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/views_by_region.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ViewsByRegion", "Data"]
+
+
+class Data(BaseModel):
+    region: str
+
+    region_name: str
+
+    views: int
+
+
+class ViewsByRegion(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/views_heatmap.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ViewsHeatmap", "Data"]
+
+
+class Data(BaseModel):
+    viewers: int
+
+    seconds: Optional[int] = None
+
+    time: Optional[str] = None
+
+
+class ViewsHeatmap(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/vod_statistics_series.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = ["VodStatisticsSeries", "VodStatisticsSeryItem", "VodStatisticsSeryItemMetrics"]
+
+
+class VodStatisticsSeryItemMetrics(BaseModel):
+    vod: List[int]
+
+
+class VodStatisticsSeryItem(BaseModel):
+    client: int
+
+    metrics: VodStatisticsSeryItemMetrics
+
+
+VodStatisticsSeries: TypeAlias = List[VodStatisticsSeryItem]

gcore/types/streaming/vod_total_stream_duration_series.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = ["VodTotalStreamDurationSeries", "VodTotalStreamDurationSeryItem"]
+
+
+class VodTotalStreamDurationSeryItem(BaseModel):
+    client: int
+
+    duration: int
+    """count of minutes"""
+
+    client_user_id: Optional[int] = None
+
+    stream_id: Optional[str] = None
+
+
+VodTotalStreamDurationSeries: TypeAlias = List[VodTotalStreamDurationSeryItem]

gcore/types/waap/domains/custom_rule_create_params.py

@@ -278,10 +278,10 @@ class ConditionURL(TypedDict, total=False):
     The pattern to match against the request URL. Constraints depend on
     `match_type`:
 
-    - **Exact/Contains**: plain text matching (e.g., `/admin`).
-    - **Regex**: a valid regular expression (must comply with
-      `^[\\ww!\\$$~:#\\[[\\]]@\\((\\))\\*\\++,=\\//\\--\\..\\%%]+$`). Lookahead/lookbehind constructs are
-      forbidden.
+    - **Exact/Contains**: plain text matching (e.g., `/admin`, must comply with
+      `^[\\ww!\\$$~:#\\[[\\]]@\\((\\))\\*\\++,=\\//\\--\\..\\%%]+$`).
+    - **Regex**: a valid regular expression (e.g., `^/upload(/\\dd+)?/\\ww+`).
+      Lookahead/lookbehind constructs are forbidden.
     """
 
     match_type: Literal["Exact", "Contains", "Regex"]

gcore/types/waap/domains/custom_rule_update_params.py

@@ -281,10 +281,10 @@ class ConditionURL(TypedDict, total=False):
     The pattern to match against the request URL. Constraints depend on
     `match_type`:
 
-    - **Exact/Contains**: plain text matching (e.g., `/admin`).
-    - **Regex**: a valid regular expression (must comply with
-      `^[\\ww!\\$$~:#\\[[\\]]@\\((\\))\\*\\++,=\\//\\--\\..\\%%]+$`). Lookahead/lookbehind constructs are
-      forbidden.
+    - **Exact/Contains**: plain text matching (e.g., `/admin`, must comply with
+      `^[\\ww!\\$$~:#\\[[\\]]@\\((\\))\\*\\++,=\\//\\--\\..\\%%]+$`).
+    - **Regex**: a valid regular expression (e.g., `^/upload(/\\dd+)?/\\ww+`).
+      Lookahead/lookbehind constructs are forbidden.
     """
 
     match_type: Literal["Exact", "Contains", "Regex"]

gcore/types/waap/ip_info_get_blocked_requests_params.py

@@ -9,7 +9,11 @@ __all__ = ["IPInfoGetBlockedRequestsParams"]
 
 class IPInfoGetBlockedRequestsParams(TypedDict, total=False):
     domain_id: Required[int]
-    """The domain ID"""
+    """The identifier for a domain.
+
+    When specified, the response will exclusively contain data pertinent to the
+    indicated domain, filtering out information from other domains.
+    """
 
     ip: Required[str]
     """The IP address to check"""

gcore/types/waap/ip_info_get_counts_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Required, TypedDict
 
 __all__ = ["IPInfoGetCountsParams"]
@@ -11,7 +12,7 @@ class IPInfoGetCountsParams(TypedDict, total=False):
     ip: Required[str]
     """The IP address to check"""
 
-    domain_id: int
+    domain_id: Optional[int]
     """The identifier for a domain.
 
     When specified, the response will exclusively contain data pertinent to the

gcore/types/waap/ip_info_get_top_sessions_params.py

@@ -9,7 +9,11 @@ __all__ = ["IPInfoGetTopSessionsParams"]
 
 class IPInfoGetTopSessionsParams(TypedDict, total=False):
     domain_id: Required[int]
-    """The domain ID"""
+    """The identifier for a domain.
+
+    When specified, the response will exclusively contain data pertinent to the
+    indicated domain, filtering out information from other domains.
+    """
 
     ip: Required[str]
     """The IP address to check"""

gcore/types/waap/ip_info_get_top_urls_params.py

@@ -9,7 +9,11 @@ __all__ = ["IPInfoGetTopURLsParams"]
 
 class IPInfoGetTopURLsParams(TypedDict, total=False):
     domain_id: Required[int]
-    """The domain ID"""
+    """The identifier for a domain.
+
+    When specified, the response will exclusively contain data pertinent to the
+    indicated domain, filtering out information from other domains.
+    """
 
     ip: Required[str]
     """The IP address to check"""

gcore/types/waap/ip_info_get_top_user_agents_params.py

@@ -9,7 +9,11 @@ __all__ = ["IPInfoGetTopUserAgentsParams"]
 
 class IPInfoGetTopUserAgentsParams(TypedDict, total=False):
     domain_id: Required[int]
-    """The domain ID"""
+    """The identifier for a domain.
+
+    When specified, the response will exclusively contain data pertinent to the
+    indicated domain, filtering out information from other domains.
+    """
 
     ip: Required[str]
     """The IP address to check"""

gcore/types/waap/waap_custom_rule.py

@@ -259,10 +259,10 @@ class ConditionURL(BaseModel):
     The pattern to match against the request URL. Constraints depend on
     `match_type`:
 
-    - **Exact/Contains**: plain text matching (e.g., `/admin`).
-    - **Regex**: a valid regular expression (must comply with
-      `^[\\ww!\\$$~:#\\[[\\]]@\\((\\))\\*\\++,=\\//\\--\\..\\%%]+$`). Lookahead/lookbehind constructs are
-      forbidden.
+    - **Exact/Contains**: plain text matching (e.g., `/admin`, must comply with
+      `^[\\ww!\\$$~:#\\[[\\]]@\\((\\))\\*\\++,=\\//\\--\\..\\%%]+$`).
+    - **Regex**: a valid regular expression (e.g., `^/upload(/\\dd+)?/\\ww+`).
+      Lookahead/lookbehind constructs are forbidden.
     """
 
     match_type: Optional[Literal["Exact", "Contains", "Regex"]] = None

{gcore-0.6.0.dist-info → gcore-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gcore
-Version: 0.6.0
+Version: 0.7.0
 Summary: The official Python library for the gcore API
 Project-URL: Homepage, https://github.com/G-Core/gcore-python
 Project-URL: Repository, https://github.com/G-Core/gcore-python