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

gcore/types/cloud/ssh_key_created.py

@@ -26,9 +26,12 @@ class SSHKeyCreated(BaseModel):
     """The private part of an SSH key is the confidential portion of the key pair.
 
     It should never be shared or exposed. This key is used to prove your identity
-    when connecting to a server. If you omit the `public_key`, the platform will
-    generate a key for you. The `private_key` will be returned **once** in the API
-    response. Be sure to save it securely, as it cannot be retrieved again later.
+    when connecting to a server.
+
+    If you omit the `public_key`, the platform will generate a key for you. The
+    `private_key` will be returned **once** in the API response. Be sure to save it
+    securely, as it cannot be retrieved again later.
+
     Best practice: Save the private key to a secure location on your machine (e.g.,
     `~/.ssh/id_ed25519`) and set the file permissions to be readable only by you.
     """

gcore/types/cloud/volume_update_params.py

@@ -25,7 +25,9 @@ class VolumeUpdateParams(TypedDict, total=False):
 
     Provide key-value pairs to add or update tags. Set tag values to `null` to
     remove tags. Unspecified tags remain unchanged. Read-only tags are always
-    preserved and cannot be modified. **Examples:**
+    preserved and cannot be modified.
+
+    **Examples:**
 
     - **Add/update tags:**
       `{'tags': {'environment': 'production', 'team': 'backend'}}` adds new tags or

gcore/types/dns/zone_get_statistics_params.py

@@ -11,20 +11,23 @@ __all__ = ["ZoneGetStatisticsParams"]
 
 class ZoneGetStatisticsParams(TypedDict, total=False):
     from_: Annotated[int, PropertyInfo(alias="from")]
-    """
-    Beginning of the requested time period (Unix Timestamp, UTC.) In a query string:
-    &from=1709068637
+    """Beginning of the requested time period (Unix Timestamp, UTC.)
+
+    In a query string: &from=1709068637
     """
 
     granularity: str
     """
     Granularity parameter string is a sequence of decimal numbers, each with
-    optional fraction and a unit suffix, such as "300ms", "1.5h" or "2h45m". Valid
-    time units are "s", "m", "h".
+    optional fraction and a unit suffix, such as "300ms", "1.5h" or "2h45m".
+
+    Valid time units are "s", "m", "h".
     """
 
     record_type: str
-    """DNS record type. Possible values:
+    """DNS record type.
+
+    Possible values:
 
     - A
     - AAAA
@@ -37,7 +40,7 @@ class ZoneGetStatisticsParams(TypedDict, total=False):
     """
 
     to: int
-    """
-    End of the requested time period (Unix Timestamp, UTC.) In a query string:
-    &to=1709673437
+    """End of the requested time period (Unix Timestamp, UTC.)
+
+    In a query string: &to=1709673437
     """

gcore/types/dns/zone_get_statistics_response.py

@@ -11,7 +11,9 @@ class ZoneGetStatisticsResponse(BaseModel):
     requests: Optional[object] = None
     """
     Requests amount (values) for particular zone fractionated by time intervals
-    (keys). Example of response:
+    (keys).
+
+    Example of response:
     `{ "requests": { "1598608080000": 14716, "1598608140000": 51167, "1598608200000": 53432, "1598611020000": 51050, "1598611080000": 52611, "1598611140000": 46884 } }`
     """
 

gcore/types/dns/zone_import_params.py

@@ -14,19 +14,25 @@ class ZoneImportParams(TypedDict, total=False):
     It returns the number of bytes read (0 <= n <= len(p)) and any error
     encountered. Even if Read returns n < len(p), it may use all of p as scratch
     space during the call. If some data is available but not len(p) bytes, Read
-    conventionally returns what is available instead of waiting for more. When Read
-    encounters an error or end-of-file condition after successfully reading n > 0
-    bytes, it returns the number of bytes read. It may return the (non-nil) error
-    from the same call or return the error (and n == 0) from a subsequent call. An
-    instance of this general case is that a Reader returning a non-zero number of
-    bytes at the end of the input stream may return either err == EOF or err == nil.
-    The next Read should return 0, EOF. Callers should always process the n > 0
-    bytes returned before considering the error err. Doing so correctly handles I/O
-    errors that happen after reading some bytes and also both of the allowed EOF
-    behaviors. If len(p) == 0, Read should always return n == 0. It may return a
-    non-nil error if some error condition is known, such as EOF. Implementations of
-    Read are discouraged from returning a zero byte count with a nil error, except
-    when len(p) == 0. Callers should treat a return of 0 and nil as indicating that
-    nothing happened; in particular it does not indicate EOF. Implementations must
-    not retain p.
+    conventionally returns what is available instead of waiting for more.
+
+    When Read encounters an error or end-of-file condition after successfully
+    reading n > 0 bytes, it returns the number of bytes read. It may return the
+    (non-nil) error from the same call or return the error (and n == 0) from a
+    subsequent call. An instance of this general case is that a Reader returning a
+    non-zero number of bytes at the end of the input stream may return either err ==
+    EOF or err == nil. The next Read should return 0, EOF.
+
+    Callers should always process the n > 0 bytes returned before considering the
+    error err. Doing so correctly handles I/O errors that happen after reading some
+    bytes and also both of the allowed EOF behaviors.
+
+    If len(p) == 0, Read should always return n == 0. It may return a non-nil error
+    if some error condition is known, such as EOF.
+
+    Implementations of Read are discouraged from returning a zero byte count with a
+    nil error, except when len(p) == 0. Callers should treat a return of 0 and nil
+    as indicating that nothing happened; in particular it does not indicate EOF.
+
+    Implementations must not retain p.
     """

gcore/types/dns/zones/dns_output_rrset.py

@@ -42,9 +42,13 @@ class ResourceRecord(BaseModel):
     6. `backup` (bool)
     7. `notes` (string)
     8. `weight` (float)
-    9. `ip` (string) Some keys are reserved for balancing, @see
-       https://api.gcore.com/dns/v2/info/meta This meta will be used to decide which
-       resource record should pass through filters from the filter set
+    9. `ip` (string)
+
+    Some keys are reserved for balancing, @see
+    https://api.gcore.com/dns/v2/info/meta
+
+    This meta will be used to decide which resource record should pass through
+    filters from the filter set
     """
 
 

gcore/types/iam/account_overview.py

@@ -372,7 +372,9 @@ class User(BaseModel):
     """User's email address."""
 
     groups: Optional[List[UserGroup]] = 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
@@ -382,7 +384,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.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

@@ -66,7 +66,9 @@ class UserDetailed(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
@@ -79,7 +81,10 @@ class UserDetailed(BaseModel):
     """User activity flag."""
 
     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_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

@@ -66,7 +66,9 @@ class UserUpdate(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
@@ -79,7 +81,10 @@ class UserUpdate(BaseModel):
     """User activity flag."""
 
     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_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