gcore 0.13.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

gcore/types/iam/api_token_list.py

@@ -25,57 +25,57 @@ class APITokenListItemClientUserRole(BaseModel):
 
 
 class APITokenListItemClientUser(BaseModel):
-    client_id: Optional[int] = None
+    client_id: int
     """Account's ID."""
 
-    deleted: Optional[bool] = None
+    deleted: bool
     """Deletion flag. If true, then the API token was deleted."""
 
-    role: Optional[APITokenListItemClientUserRole] = None
+    role: APITokenListItemClientUserRole
 
-    user_email: Optional[str] = None
+    user_email: str
     """User's email who issued the API token."""
 
-    user_id: Optional[int] = None
+    user_id: int
     """User's ID who issued the API token."""
 
-    user_name: Optional[str] = None
+    user_name: str
     """User's name who issued the API token."""
 
 
 class APITokenListItem(BaseModel):
-    client_user: APITokenListItemClientUser
-
-    exp_date: str
-    """
-    Date when the API token becomes expired (ISO 8086/RFC 3339 format), UTC. If
-    null, then the API token will never expire.
-    """
-
-    name: str
-    """API token name."""
-
-    id: Optional[int] = None
+    id: int
     """API token ID."""
 
-    created: Optional[str] = None
+    client_user: APITokenListItemClientUser
+
+    created: str
     """Date when the API token was issued (ISO 8086/RFC 3339 format), UTC."""
 
-    deleted: Optional[bool] = None
+    deleted: bool
     """Deletion flag. If true, then the API token was deleted."""
 
-    description: Optional[str] = None
-    """API token description."""
+    exp_date: Optional[str] = None
+    """
+    Date when the API token becomes expired (ISO 8086/RFC 3339 format), UTC. If
+    null, then the API token will never expire.
+    """
 
-    expired: Optional[bool] = None
+    expired: bool
     """Expiration flag.
 
     If true, then the API token has expired. When an API token expires it will be
     automatically deleted.
     """
 
-    last_usage: Optional[str] = None
+    last_usage: str
     """Date when the API token was last used (ISO 8086/RFC 3339 format), UTC."""
 
+    name: str
+    """API token name."""
+
+    description: Optional[str] = None
+    """API token description."""
+
 
 APITokenList: TypeAlias = List[APITokenListItem]

gcore/types/iam/user.py

@@ -51,7 +51,9 @@ class User(BaseModel):
     """User's email address."""
 
     groups: Optional[List[Group]] = None
-    """User's group in the current account. IAM supports 5 groups:
+    """User's group in the current account.
+
+    IAM supports 5 groups:
 
     - Users
     - Administrators
@@ -61,7 +63,10 @@ class User(BaseModel):
     """
 
     lang: Optional[Literal["de", "en", "ru", "zh", "az"]] = None
-    """User's language. Defines language of the control panel and email messages."""
+    """User's language.
+
+    Defines language of the control panel and email messages.
+    """
 
     name: Optional[str] = None
     """User's name."""

gcore/types/iam/user_detailed.py

@@ -37,36 +37,38 @@ class Group(BaseModel):
 
 
 class UserDetailed(BaseModel):
-    id: Optional[int] = None
+    id: int
     """User's ID."""
 
-    activated: Optional[bool] = None
+    activated: bool
     """Email confirmation:
 
     - `true` – user confirmed the email;
     - `false` – user did not confirm the email.
     """
 
-    auth_types: Optional[List[Literal["password", "sso", "github", "google-oauth2"]]] = None
+    auth_types: List[Literal["password", "sso", "github", "google-oauth2"]]
     """System field. List of auth types available for the account."""
 
-    client: Optional[float] = None
+    client: float
     """User's account ID."""
 
-    client_and_roles: Optional[List[ClientAndRole]] = None
+    client_and_roles: List[ClientAndRole]
     """List of user's clients. User can access to one or more clients."""
 
-    company: Optional[str] = None
+    company: str
     """User's company."""
 
-    deleted: Optional[bool] = None
+    deleted: bool
     """Deletion flag. If `true` then user was deleted."""
 
-    email: Optional[str] = None
+    email: str
     """User's email address."""
 
-    groups: Optional[List[Group]] = None
-    """User's group in the current account. IAM supports 5 groups:
+    groups: List[Group]
+    """User's group in the current account.
+
+    IAM supports 5 groups:
 
     - Users
     - Administrators
@@ -75,11 +77,14 @@ class UserDetailed(BaseModel):
     - Purge and Prefetch only (API+Web)
     """
 
-    is_active: Optional[bool] = None
+    is_active: bool
     """User activity flag."""
 
-    lang: Optional[Literal["de", "en", "ru", "zh", "az"]] = None
-    """User's language. Defines language of the control panel and email messages."""
+    lang: Literal["de", "en", "ru", "zh", "az"]
+    """User's language.
+
+    Defines language of the control panel and email messages.
+    """
 
     name: Optional[str] = None
     """User's name."""
@@ -87,18 +92,18 @@ class UserDetailed(BaseModel):
     phone: Optional[str] = None
     """User's phone."""
 
-    reseller: Optional[int] = None
+    reseller: int
     """Services provider ID."""
 
-    sso_auth: Optional[bool] = None
+    sso_auth: bool
     """SSO authentication flag. If `true` then user can login via SAML SSO."""
 
-    two_fa: Optional[bool] = None
+    two_fa: bool
     """Two-step verification:
 
     - `true` – user enabled two-step verification;
     - `false` – user disabled two-step verification.
     """
 
-    user_type: Optional[Literal["common", "reseller", "seller"]] = None
+    user_type: Literal["common", "reseller", "seller"]
     """User's type."""

gcore/types/iam/user_invite.py

@@ -1,15 +1,13 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
-
 from ..._models import BaseModel
 
 __all__ = ["UserInvite"]
 
 
 class UserInvite(BaseModel):
-    status: Optional[str] = None
+    status: str
     """Status of the invitation."""
 
-    user_id: Optional[int] = None
+    user_id: int
     """Invited user ID."""

gcore/types/iam/user_invite_params.py

@@ -17,7 +17,10 @@ class UserInviteParams(TypedDict, total=False):
     user_role: Required[UserRole]
 
     lang: Literal["de", "en", "ru", "zh", "az"]
-    """User's language. Defines language of the control panel and email messages."""
+    """User's language.
+
+    Defines language of the control panel and email messages.
+    """
 
     name: str
     """User name."""

gcore/types/iam/user_update.py

@@ -37,36 +37,38 @@ class Group(BaseModel):
 
 
 class UserUpdate(BaseModel):
-    id: Optional[int] = None
+    id: int
     """User's ID."""
 
-    activated: Optional[bool] = None
+    activated: bool
     """Email confirmation:
 
     - `true` – user confirmed the email;
     - `false` – user did not confirm the email.
     """
 
-    auth_types: Optional[List[Literal["password", "sso", "github", "google-oauth2"]]] = None
+    auth_types: List[Literal["password", "sso", "github", "google-oauth2"]]
     """System field. List of auth types available for the account."""
 
-    client: Optional[float] = None
+    client: float
     """User's account ID."""
 
-    client_and_roles: Optional[List[ClientAndRole]] = None
+    client_and_roles: List[ClientAndRole]
     """List of user's clients. User can access to one or more clients."""
 
-    company: Optional[str] = None
+    company: str
     """User's company."""
 
-    deleted: Optional[bool] = None
+    deleted: bool
     """Deletion flag. If `true` then user was deleted."""
 
-    email: Optional[str] = None
+    email: str
     """User's email address."""
 
-    groups: Optional[List[Group]] = None
-    """User's group in the current account. IAM supports 5 groups:
+    groups: List[Group]
+    """User's group in the current account.
+
+    IAM supports 5 groups:
 
     - Users
     - Administrators
@@ -75,11 +77,14 @@ class UserUpdate(BaseModel):
     - Purge and Prefetch only (API+Web)
     """
 
-    is_active: Optional[bool] = None
+    is_active: bool
     """User activity flag."""
 
-    lang: Optional[Literal["de", "en", "ru", "zh", "az"]] = None
-    """User's language. Defines language of the control panel and email messages."""
+    lang: Literal["de", "en", "ru", "zh", "az"]
+    """User's language.
+
+    Defines language of the control panel and email messages.
+    """
 
     name: Optional[str] = None
     """User's name."""
@@ -87,18 +92,18 @@ class UserUpdate(BaseModel):
     phone: Optional[str] = None
     """User's phone."""
 
-    reseller: Optional[int] = None
+    reseller: int
     """Services provider ID."""
 
-    sso_auth: Optional[bool] = None
+    sso_auth: bool
     """SSO authentication flag. If `true` then user can login via SAML SSO."""
 
-    two_fa: Optional[bool] = None
+    two_fa: bool
     """Two-step verification:
 
     - `true` – user enabled two-step verification;
     - `false` – user disabled two-step verification.
     """
 
-    user_type: Optional[Literal["common", "reseller", "seller"]] = None
+    user_type: Literal["common", "reseller", "seller"]
     """User's type."""

gcore/types/iam/user_update_params.py

@@ -19,7 +19,9 @@ class UserUpdateParams(TypedDict, total=False):
     """User's email address."""
 
     groups: Iterable[Group]
-    """User's group in the current account. IAM supports 5 groups:
+    """User's group in the current account.
+
+    IAM supports 5 groups:
 
     - Users
     - Administrators
@@ -29,7 +31,10 @@ class UserUpdateParams(TypedDict, total=False):
     """
 
     lang: Literal["de", "en", "ru", "zh", "az"]
-    """User's language. Defines language of the control panel and email messages."""
+    """User's language.
+
+    Defines language of the control panel and email messages.
+    """
 
     name: Optional[str]
     """User's name."""

gcore/types/streaming/ai_contentmoderation_hardnudity.py

@@ -25,10 +25,12 @@ class AIContentmoderationHardnudity(BaseModel):
     """
     Meta parameter, designed to store your own extra information about a video
     entity: video source, video id, etc. It is not used in any way in video
-    processing. For example, if an AI-task was created automatically when you
-    uploaded a video with the AI auto-processing option (nudity detection, etc),
-    then the ID of the associated video for which the task was performed will be
-    explicitly indicated here.
+    processing.
+
+    For example, if an AI-task was created automatically when you uploaded a video
+    with the AI auto-processing option (nudity detection, etc), then the ID of the
+    associated video for which the task was performed will be explicitly indicated
+    here.
     """
 
     client_user_id: Optional[str] = None

gcore/types/streaming/ai_contentmoderation_nsfw.py

@@ -25,10 +25,12 @@ class AIContentmoderationNsfw(BaseModel):
     """
     Meta parameter, designed to store your own extra information about a video
     entity: video source, video id, etc. It is not used in any way in video
-    processing. For example, if an AI-task was created automatically when you
-    uploaded a video with the AI auto-processing option (nudity detection, etc),
-    then the ID of the associated video for which the task was performed will be
-    explicitly indicated here.
+    processing.
+
+    For example, if an AI-task was created automatically when you uploaded a video
+    with the AI auto-processing option (nudity detection, etc), then the ID of the
+    associated video for which the task was performed will be explicitly indicated
+    here.
     """
 
     client_user_id: Optional[str] = None

gcore/types/streaming/ai_contentmoderation_softnudity.py

@@ -25,10 +25,12 @@ class AIContentmoderationSoftnudity(BaseModel):
     """
     Meta parameter, designed to store your own extra information about a video
     entity: video source, video id, etc. It is not used in any way in video
-    processing. For example, if an AI-task was created automatically when you
-    uploaded a video with the AI auto-processing option (nudity detection, etc),
-    then the ID of the associated video for which the task was performed will be
-    explicitly indicated here.
+    processing.
+
+    For example, if an AI-task was created automatically when you uploaded a video
+    with the AI auto-processing option (nudity detection, etc), then the ID of the
+    associated video for which the task was performed will be explicitly indicated
+    here.
     """
 
     client_user_id: Optional[str] = None

gcore/types/streaming/ai_contentmoderation_sport.py

@@ -25,10 +25,12 @@ class AIContentmoderationSport(BaseModel):
     """
     Meta parameter, designed to store your own extra information about a video
     entity: video source, video id, etc. It is not used in any way in video
-    processing. For example, if an AI-task was created automatically when you
-    uploaded a video with the AI auto-processing option (nudity detection, etc),
-    then the ID of the associated video for which the task was performed will be
-    explicitly indicated here.
+    processing.
+
+    For example, if an AI-task was created automatically when you uploaded a video
+    with the AI auto-processing option (nudity detection, etc), then the ID of the
+    associated video for which the task was performed will be explicitly indicated
+    here.
     """
 
     client_user_id: Optional[str] = None

gcore/types/streaming/ai_task.py

@@ -25,14 +25,20 @@ class TaskDataAITranscribe(BaseModel):
     audio_language: Optional[str] = None
     """Language in original audio (transcription only).
 
-    This value is used to determine the language from which to transcribe. If this
-    is not set, the system will run auto language identification and the subtitles
-    will be in the detected language. The method also works based on AI analysis.
-    It's fairly accurate, but if it's wrong, then set the language explicitly.
+    This value is used to determine the language from which to transcribe.
+
+    If this is not set, the system will run auto language identification and the
+    subtitles will be in the detected language. The method also works based on AI
+    analysis. It's fairly accurate, but if it's wrong, then set the language
+    explicitly.
+
     Additionally, when this is not set, we also support recognition of alternate
-    languages in the video (language code-switching). Language is set by 3-letter
-    language code according to ISO-639-2 (bibliographic code). We can process
-    languages:
+    languages in the video (language code-switching).
+
+    Language is set by 3-letter language code according to ISO-639-2 (bibliographic
+    code).
+
+    We can process languages:
 
     - 'afr': Afrikaans
     - 'alb': Albanian
@@ -139,10 +145,12 @@ class TaskDataAITranscribe(BaseModel):
     """
     Meta parameter, designed to store your own extra information about a video
     entity: video source, video id, etc. It is not used in any way in video
-    processing. For example, if an AI-task was created automatically when you
-    uploaded a video with the AI auto-processing option (transcribing,
-    translationing), then the ID of the associated video for which the task was
-    performed will be explicitly indicated here.
+    processing.
+
+    For example, if an AI-task was created automatically when you uploaded a video
+    with the AI auto-processing option (transcribing, translationing), then the ID
+    of the associated video for which the task was performed will be explicitly
+    indicated here.
     """
 
     client_user_id: Optional[str] = None
@@ -156,6 +164,7 @@ class TaskDataAITranscribe(BaseModel):
     """
     Indicates which language it is clearly necessary to translate into. If this is
     not set, the original language will be used from attribute "`audio_language`".
+
     Please note that:
 
     - transcription into the original language is a free procedure,

gcore/types/streaming/ai_task_create_params.py

@@ -20,14 +20,20 @@ class AITaskCreateParams(TypedDict, total=False):
     audio_language: str
     """Language in original audio (transcription only).
 
-    This value is used to determine the language from which to transcribe. If this
-    is not set, the system will run auto language identification and the subtitles
-    will be in the detected language. The method also works based on AI analysis.
-    It's fairly accurate, but if it's wrong, then set the language explicitly.
+    This value is used to determine the language from which to transcribe.
+
+    If this is not set, the system will run auto language identification and the
+    subtitles will be in the detected language. The method also works based on AI
+    analysis. It's fairly accurate, but if it's wrong, then set the language
+    explicitly.
+
     Additionally, when this is not set, we also support recognition of alternate
-    languages in the video (language code-switching). Language is set by 3-letter
-    language code according to ISO-639-2 (bibliographic code). We can process
-    languages:
+    languages in the video (language code-switching).
+
+    Language is set by 3-letter language code according to ISO-639-2 (bibliographic
+    code).
+
+    We can process languages:
 
     - 'afr': Afrikaans
     - 'alb': Albanian
@@ -140,10 +146,12 @@ class AITaskCreateParams(TypedDict, total=False):
     """
     Meta parameter, designed to store your own extra information about a video
     entity: video source, video id, etc. It is not used in any way in video
-    processing. For example, if an AI-task was created automatically when you
-    uploaded a video with the AI auto-processing option (nudity detection, etc),
-    then the ID of the associated video for which the task was performed will be
-    explicitly indicated here.
+    processing.
+
+    For example, if an AI-task was created automatically when you uploaded a video
+    with the AI auto-processing option (nudity detection, etc), then the ID of the
+    associated video for which the task was performed will be explicitly indicated
+    here.
     """
 
     client_user_id: str
@@ -157,6 +165,7 @@ class AITaskCreateParams(TypedDict, total=False):
     """
     Indicates which language it is clearly necessary to translate into. If this is
     not set, the original language will be used from attribute "`audio_language`".
+
     Please note that:
 
     - transcription into the original language is a free procedure,

gcore/types/streaming/ai_task_get_response.py

@@ -65,10 +65,11 @@ class AITaskGetResponseResultAIResultsTranscribe(BaseModel):
     """
 
     speech_detected: Optional[bool] = None
-    """
-    Determines whether speech was detected or not. Please note: If the task is in
-    "SUCCESS" status and speech was not found in the entire file, then "false" will
-    be indicated here and the `subtitles` field will be empty.
+    """Determines whether speech was detected or not.
+
+    Please note: If the task is in "SUCCESS" status and speech was not found in the
+    entire file, then "false" will be indicated here and the `subtitles` field will
+    be empty.
     """
 
     subtitles: Optional[List[AITaskGetResponseResultAIResultsTranscribeSubtitle]] = None

gcore/types/streaming/ai_task_list_params.py

@@ -17,8 +17,10 @@ class AITaskListParams(TypedDict, total=False):
     ordering: Literal["task_id", "status", "task_name", "started_at"]
     """
     Which field to use when ordering the results: `task_id`, status, and
-    `task_name`. Sorting is done in ascending (ASC) order. If parameter is omitted
-    then "`started_at` DESC" is used for ordering by default.
+    `task_name`. Sorting is done in ascending (ASC) order.
+
+    If parameter is omitted then "`started_at` DESC" is used for ordering by
+    default.
     """
 
     page: int
@@ -27,9 +29,13 @@ class AITaskListParams(TypedDict, total=False):
     search: str
     """
     This is an field for combined text search in the following fields: `task_id`,
-    `task_name`, status, and `task_data`. Both full and partial searches are
-    possible inside specified above fields. For example, you can filter tasks of a
-    certain category, or tasks by a specific original file. Example:
+    `task_name`, status, and `task_data`.
+
+    Both full and partial searches are possible inside specified above fields. For
+    example, you can filter tasks of a certain category, or tasks by a specific
+    original file.
+
+    Example:
 
     - To filter tasks of Content Moderation NSFW method:
       `GET /streaming/ai/tasks?search=nsfw`

gcore/types/streaming/clip.py

@@ -12,34 +12,43 @@ class Clip(BaseModel):
     """ID of the clip"""
 
     duration: int
-    """
-    Requested segment duration in seconds to be cut. Please, note that cutting is
-    based on the idea of instantly creating a clip, instead of precise timing. So
-    final segment may be:
+    """Requested segment duration in seconds to be cut.
+
+    Please, note that cutting is based on the idea of instantly creating a clip,
+    instead of precise timing. So final segment may be:
 
     - Less than the specified value if there is less data in the DVR than the
       requested segment.
     - Greater than the specified value, because segment is aligned to the first and
       last key frames of already stored fragment in DVR, this way -1 and +1 chunks
-      can be added to left and right. Duration of cutted segment cannot be greater
-      than DVR duration for this stream. Therefore, to change the maximum, use
-      "`dvr_duration`" parameter of this stream.
+      can be added to left and right.
+
+    Duration of cutted segment cannot be greater than DVR duration for this stream.
+    Therefore, to change the maximum, use "`dvr_duration`" parameter of this stream.
     """
 
     created_at: Optional[str] = None
     """Creation date and time. Format is date time in ISO 8601"""
 
     expiration: Optional[int] = None
-    """
-    Expire time of the clip via a public link. Unix timestamp in seconds, absolute
-    value. This is the time how long the instant clip will be stored in the server
-    memory and can be accessed via public HLS/MP4 links. Download and/or use the
-    instant clip before this time expires. After the time has expired, the clip is
-    deleted from memory and is no longer available via the link. You need to create
-    a new segment, or use `vod_required: true` attribute. If value is omitted, then
-    expiration is counted as +3600 seconds (1 hour) to the end of the clip (i.e.
-    `unix timestamp = <start> + <duration> + 3600`). Allowed range: 1m <= expiration
-    <= 4h. Example:
+    """Expire time of the clip via a public link.
+
+    Unix timestamp in seconds, absolute value.
+
+    This is the time how long the instant clip will be stored in the server memory
+    and can be accessed via public HLS/MP4 links. Download and/or use the instant
+    clip before this time expires.
+
+    After the time has expired, the clip is deleted from memory and is no longer
+    available via the link. You need to create a new segment, or use
+    `vod_required: true` attribute.
+
+    If value is omitted, then expiration is counted as +3600 seconds (1 hour) to the
+    end of the clip (i.e. `unix timestamp = <start> + <duration> + 3600`).
+
+    Allowed range: 1m <= expiration <= 4h.
+
+    Example:
     `24.05.2024 14:00:00 (GMT) + 60 seconds of duration + 3600 seconds of expiration = 24.05.2024 15:01:00 (GMT) is Unix timestamp = 1716562860`
     """
 
@@ -65,11 +74,13 @@ class Clip(BaseModel):
     """List of available rendition heights"""
 
     start: Optional[int] = None
-    """
-    Starting point of the segment to cut. Unix timestamp in seconds, absolute value.
-    Example: `24.05.2024 14:00:00 (GMT) is Unix timestamp = 1716559200` If a value
-    from the past is specified, it is used as the starting point for the segment to
-    cut. If the value is omitted, then clip will start from now.
+    """Starting point of the segment to cut.
+
+    Unix timestamp in seconds, absolute value. Example:
+    `24.05.2024 14:00:00 (GMT) is Unix timestamp = 1716559200`
+
+    If a value from the past is specified, it is used as the starting point for the
+    segment to cut. If the value is omitted, then clip will start from now.
     """
 
     video_id: Optional[int] = None