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

gcore/types/streaming/video_update_params.py

@@ -12,7 +12,9 @@ class VideoUpdateParams(TypedDict, total=False):
     """Video name"""
 
     auto_transcribe_audio_language: Literal["disable", "auto", "<language_code>"]
-    """Automatic creation of subtitles by transcribing the audio track. Values:
+    """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
@@ -22,7 +24,9 @@ class VideoUpdateParams(TypedDict, total=False):
       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:
+      attribute of API POST /streaming/ai/transcribe .
+
+    Example:
 
     ```
     auto_transcribe_audio_language: "auto"
@@ -41,16 +45,23 @@ class VideoUpdateParams(TypedDict, total=False):
     """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:
+    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:
+      creation.
+
+    If several languages are specified for translation, a separate subtitle will be
+    generated for each language.
+
+    Example:
 
     ```
     auto_translate_subtitles_language: default
@@ -79,9 +90,10 @@ class VideoUpdateParams(TypedDict, total=False):
     """
 
     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
+    """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
@@ -94,8 +106,11 @@ class VideoUpdateParams(TypedDict, total=False):
     """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: <auth-scheme> <authorization-parameters>` Examples:
+    (specified in "`origin_url`" parameter) on an external server.
+
+    Syntax: `Authorization: <auth-scheme> <authorization-parameters>`
+
+    Examples:
 
     - "`origin_http_headers`": "Authorization: Basic ..."
     - "`origin_http_headers`": "Authorization: Bearer ..."
@@ -121,16 +136,21 @@ class VideoUpdateParams(TypedDict, total=False):
     """
 
     poster: str
-    """
-    Poster is your own static image which can be displayed before the video starts.
+    """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
+    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:[<mediatype>];base64,<data>` MIME-types are image/jpeg,
-    image/webp, and image/png and file sizes up to 1Mb. Examples:
+    format: `data:[<mediatype>];base64,<data>`
+
+    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==`
@@ -141,13 +161,16 @@ class VideoUpdateParams(TypedDict, total=False):
     """
     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.
+    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:
+    """Deprecated.
+
+    Regulates the video format:
 
     - **regular** — plays the video as usual
     - **vr360** — plays the video in 360 degree mode
@@ -166,28 +189,34 @@ class VideoUpdateParams(TypedDict, total=False):
     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.
+    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.
+    """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
+    """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
@@ -200,16 +229,19 @@ class VideoUpdateParams(TypedDict, total=False):
     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:
+    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.
+    - 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/waap/domain_update_params.py

@@ -2,11 +2,11 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, TypedDict
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["DomainUpdateParams"]
 
 
 class DomainUpdateParams(TypedDict, total=False):
-    status: Literal["active", "monitor"]
+    status: Required[Literal["active", "monitor"]]
     """The current status of the domain"""

gcore/types/waap/domains/advanced_rule_create_params.py

@@ -12,7 +12,10 @@ __all__ = ["AdvancedRuleCreateParams", "Action", "ActionBlock", "ActionTag"]
 
 class AdvancedRuleCreateParams(TypedDict, total=False):
     action: Required[Action]
-    """The action that the rule takes when triggered"""
+    """The action that the rule takes when triggered.
+
+    Only one action can be set per rule.
+    """
 
     enabled: Required[bool]
     """Whether or not the rule is enabled"""
@@ -24,26 +27,31 @@ class AdvancedRuleCreateParams(TypedDict, total=False):
     """A CEL syntax expression that contains the rule's conditions.
 
     Allowed objects are: request, whois, session, response, tags,
-    `user_defined_tags`, `user_agent`, `client_data`. More info can be found here:
+    `user_defined_tags`, `user_agent`, `client_data`.
+
+    More info can be found here:
     https://gcore.com/docs/waap/waap-rules/advanced-rules
     """
 
-    description: Optional[str]
+    description: str
     """The description assigned to the rule"""
 
     phase: Optional[Literal["access", "header_filter", "body_filter"]]
-    """The WAAP request/response phase for applying the rule.
+    """The WAAP request/response phase for applying the rule. Default is "access".
+
+    The "access" phase is responsible for modifying the request before it is sent to
+    the origin server.
+
+    The "`header_filter`" phase is responsible for modifying the HTTP headers of a
+    response before they are sent back to the client.
 
-    Default is "access". The "access" phase is responsible for modifying the request
-    before it is sent to the origin server. The "`header_filter`" phase is
-    responsible for modifying the HTTP headers of a response before they are sent
-    back to the client. The "`body_filter`" phase is responsible for modifying the
-    body of a response before it is sent back to the client.
+    The "`body_filter`" phase is responsible for modifying the body of a response
+    before it is sent back to the client.
     """
 
 
 class ActionBlock(TypedDict, total=False):
-    action_duration: Optional[str]
+    action_duration: str
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
@@ -51,8 +59,8 @@ class ActionBlock(TypedDict, total=False):
     intervals are not allowed.
     """
 
-    status_code: Optional[Literal[403, 405, 418, 429]]
-    """Designates the HTTP status code to deliver when a request is blocked."""
+    status_code: Literal[403, 405, 418, 429]
+    """A custom HTTP status code that the WAAP returns if a rule blocks a request"""
 
 
 class ActionTag(TypedDict, total=False):
@@ -61,23 +69,23 @@ class ActionTag(TypedDict, total=False):
 
 
 class Action(TypedDict, total=False):
-    allow: Optional[object]
+    allow: object
     """The WAAP allowed the request"""
 
-    block: Optional[ActionBlock]
+    block: ActionBlock
     """
     WAAP block action behavior could be configured with response status code and
     action duration.
     """
 
-    captcha: Optional[object]
+    captcha: object
     """The WAAP presented the user with a captcha"""
 
-    handshake: Optional[object]
+    handshake: object
     """The WAAP performed automatic browser validation"""
 
-    monitor: Optional[object]
+    monitor: object
     """The WAAP monitored the request but took no action"""
 
-    tag: Optional[ActionTag]
+    tag: ActionTag
     """WAAP tag action gets a list of tags to tag the request scope with"""

gcore/types/waap/domains/advanced_rule_list_params.py

@@ -46,11 +46,14 @@ class AdvancedRuleListParams(TypedDict, total=False):
     """Determine the field to order results by"""
 
     phase: Literal["access", "header_filter", "body_filter"]
-    """
-    Filter rules based on the WAAP request/response phase for applying the rule. The
-    "access" phase is responsible for modifying the request before it is sent to the
-    origin server. The "`header_filter`" phase is responsible for modifying the HTTP
-    headers of a response before they are sent back to the client. The
-    "`body_filter`" phase is responsible for modifying the body of a response before
-    it is sent back to the client.
+    """Filter rules based on the WAAP request/response phase for applying the rule.
+
+    The "access" phase is responsible for modifying the request before it is sent to
+    the origin server.
+
+    The "`header_filter`" phase is responsible for modifying the HTTP headers of a
+    response before they are sent back to the client.
+
+    The "`body_filter`" phase is responsible for modifying the body of a response
+    before it is sent back to the client.
     """

gcore/types/waap/domains/advanced_rule_update_params.py

@@ -15,7 +15,7 @@ class AdvancedRuleUpdateParams(TypedDict, total=False):
     """The domain ID"""
 
     action: Optional[Action]
-    """The action that a WAAP rule takes when triggered"""
+    """The action that a WAAP rule takes when triggered."""
 
     description: Optional[str]
     """The description assigned to the rule"""
@@ -27,26 +27,31 @@ class AdvancedRuleUpdateParams(TypedDict, total=False):
     """The name assigned to the rule"""
 
     phase: Optional[Literal["access", "header_filter", "body_filter"]]
-    """
-    The WAAP request/response phase for applying the rule. The "access" phase is
-    responsible for modifying the request before it is sent to the origin server.
+    """The WAAP request/response phase for applying the rule.
+
+    The "access" phase is responsible for modifying the request before it is sent to
+    the origin server.
+
     The "`header_filter`" phase is responsible for modifying the HTTP headers of a
-    response before they are sent back to the client. The "`body_filter`" phase is
-    responsible for modifying the body of a response before it is sent back to the
-    client.
+    response before they are sent back to the client.
+
+    The "`body_filter`" phase is responsible for modifying the body of a response
+    before it is sent back to the client.
     """
 
     source: Optional[str]
     """A CEL syntax expression that contains the rule's conditions.
 
     Allowed objects are: request, whois, session, response, tags,
-    `user_defined_tags`, `user_agent`, `client_data`. More info can be found here:
+    `user_defined_tags`, `user_agent`, `client_data`.
+
+    More info can be found here:
     https://gcore.com/docs/waap/waap-rules/advanced-rules
     """
 
 
 class ActionBlock(TypedDict, total=False):
-    action_duration: Optional[str]
+    action_duration: str
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
@@ -54,8 +59,8 @@ class ActionBlock(TypedDict, total=False):
     intervals are not allowed.
     """
 
-    status_code: Optional[Literal[403, 405, 418, 429]]
-    """Designates the HTTP status code to deliver when a request is blocked."""
+    status_code: Literal[403, 405, 418, 429]
+    """A custom HTTP status code that the WAAP returns if a rule blocks a request"""
 
 
 class ActionTag(TypedDict, total=False):
@@ -64,23 +69,23 @@ class ActionTag(TypedDict, total=False):
 
 
 class Action(TypedDict, total=False):
-    allow: Optional[object]
+    allow: object
     """The WAAP allowed the request"""
 
-    block: Optional[ActionBlock]
+    block: ActionBlock
     """
     WAAP block action behavior could be configured with response status code and
     action duration.
     """
 
-    captcha: Optional[object]
+    captcha: object
     """The WAAP presented the user with a captcha"""
 
-    handshake: Optional[object]
+    handshake: object
     """The WAAP performed automatic browser validation"""
 
-    monitor: Optional[object]
+    monitor: object
     """The WAAP monitored the request but took no action"""
 
-    tag: Optional[ActionTag]
+    tag: ActionTag
     """WAAP tag action gets a list of tags to tag the request scope with"""

gcore/types/waap/domains/api_path_create_params.py

@@ -23,10 +23,7 @@ class APIPathCreateParams(TypedDict, total=False):
     """
 
     api_groups: SequenceNotStr[str]
-    """An array of api groups associated with the API path"""
 
     api_version: str
-    """The API version"""
 
     tags: SequenceNotStr[str]
-    """An array of tags associated with the API path"""

gcore/types/waap/domains/api_path_update_params.py

@@ -14,7 +14,6 @@ class APIPathUpdateParams(TypedDict, total=False):
     """The domain ID"""
 
     api_groups: SequenceNotStr[str]
-    """An array of api groups associated with the API path"""
 
     path: str
     """The updated API path.
@@ -24,7 +23,6 @@ class APIPathUpdateParams(TypedDict, total=False):
     """
 
     status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]
-    """The status of the discovered API path"""
+    """The different statuses an API path can have"""
 
     tags: SequenceNotStr[str]
-    """An array of tags associated with the API path"""

gcore/types/waap/domains/custom_rule_create_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable, Optional
+from typing import List, Iterable
 from typing_extensions import Literal, Required, TypedDict
 
 from ...._types import SequenceNotStr
@@ -36,7 +36,10 @@ __all__ = [
 
 class CustomRuleCreateParams(TypedDict, total=False):
     action: Required[Action]
-    """The action that the rule takes when triggered"""
+    """The action that the rule takes when triggered.
+
+    Only one action can be set per rule.
+    """
 
     conditions: Required[Iterable[Condition]]
     """The conditions required for the WAAP engine to trigger the rule.
@@ -51,12 +54,12 @@ class CustomRuleCreateParams(TypedDict, total=False):
     name: Required[str]
     """The name assigned to the rule"""
 
-    description: Optional[str]
+    description: str
     """The description assigned to the rule"""
 
 
 class ActionBlock(TypedDict, total=False):
-    action_duration: Optional[str]
+    action_duration: str
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
@@ -64,8 +67,8 @@ class ActionBlock(TypedDict, total=False):
     intervals are not allowed.
     """
 
-    status_code: Optional[Literal[403, 405, 418, 429]]
-    """Designates the HTTP status code to deliver when a request is blocked."""
+    status_code: Literal[403, 405, 418, 429]
+    """A custom HTTP status code that the WAAP returns if a rule blocks a request"""
 
 
 class ActionTag(TypedDict, total=False):
@@ -74,25 +77,25 @@ class ActionTag(TypedDict, total=False):
 
 
 class Action(TypedDict, total=False):
-    allow: Optional[object]
+    allow: object
     """The WAAP allowed the request"""
 
-    block: Optional[ActionBlock]
+    block: ActionBlock
     """
     WAAP block action behavior could be configured with response status code and
     action duration.
     """
 
-    captcha: Optional[object]
+    captcha: object
     """The WAAP presented the user with a captcha"""
 
-    handshake: Optional[object]
+    handshake: object
     """The WAAP performed automatic browser validation"""
 
-    monitor: Optional[object]
+    monitor: object
     """The WAAP monitored the request but took no action"""
 
-    tag: Optional[ActionTag]
+    tag: ActionTag
     """WAAP tag action gets a list of tags to tag the request scope with"""
 
 
@@ -218,15 +221,13 @@ class ConditionRequestRate(TypedDict, total=False):
     triggering a request rate condition
     """
 
-    http_methods: Optional[
-        List[Literal["CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"]]
-    ]
+    http_methods: List[Literal["CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"]]
     """Possible HTTP request methods that can trigger a request rate condition"""
 
-    ips: Optional[SequenceNotStr[str]]
+    ips: SequenceNotStr[str]
     """A list of source IPs that can trigger a request rate condition"""
 
-    user_defined_tag: Optional[str]
+    user_defined_tag: str
     """
     A user-defined tag that can be included in incoming requests and used to trigger
     a request rate condition
@@ -310,62 +311,62 @@ class ConditionUserDefinedTags(TypedDict, total=False):
 
 
 class Condition(TypedDict, total=False):
-    content_type: Optional[ConditionContentType]
+    content_type: ConditionContentType
     """Match the requested Content-Type"""
 
-    country: Optional[ConditionCountry]
+    country: ConditionCountry
     """Match the country that the request originated from"""
 
-    file_extension: Optional[ConditionFileExtension]
+    file_extension: ConditionFileExtension
     """Match the incoming file extension"""
 
-    header: Optional[ConditionHeader]
+    header: ConditionHeader
     """Match an incoming request header"""
 
-    header_exists: Optional[ConditionHeaderExists]
+    header_exists: ConditionHeaderExists
     """Match when an incoming request header is present"""
 
-    http_method: Optional[ConditionHTTPMethod]
+    http_method: ConditionHTTPMethod
     """Match the incoming HTTP method"""
 
-    ip: Optional[ConditionIP]
+    ip: ConditionIP
     """Match the incoming request against a single IP address"""
 
-    ip_range: Optional[ConditionIPRange]
+    ip_range: ConditionIPRange
     """Match the incoming request against an IP range"""
 
-    organization: Optional[ConditionOrganization]
+    organization: ConditionOrganization
     """
     Match the organization the request originated from, as determined by a WHOIS
     lookup of the requesting IP
     """
 
-    owner_types: Optional[ConditionOwnerTypes]
+    owner_types: ConditionOwnerTypes
     """
     Match the type of organization that owns the IP address making an incoming
     request
     """
 
-    request_rate: Optional[ConditionRequestRate]
+    request_rate: ConditionRequestRate
     """Match the rate at which requests come in that match certain conditions"""
 
-    response_header: Optional[ConditionResponseHeader]
+    response_header: ConditionResponseHeader
     """Match a response header"""
 
-    response_header_exists: Optional[ConditionResponseHeaderExists]
+    response_header_exists: ConditionResponseHeaderExists
     """Match when a response header is present"""
 
-    session_request_count: Optional[ConditionSessionRequestCount]
+    session_request_count: ConditionSessionRequestCount
     """Match the number of dynamic page requests made in a WAAP session"""
 
-    tags: Optional[ConditionTags]
+    tags: ConditionTags
     """Matches requests based on specified tags"""
 
-    url: Optional[ConditionURL]
+    url: ConditionURL
     """Match the incoming request URL"""
 
-    user_agent: Optional[ConditionUserAgent]
+    user_agent: ConditionUserAgent
     """Match the user agent making the request"""
 
-    user_defined_tags: Optional[ConditionUserDefinedTags]
+    user_defined_tags: ConditionUserDefinedTags
     """Matches requests based on user-defined tags"""