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

gcore/types/cdn/resource_list_params.py

@@ -0,0 +1,107 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ResourceListParams"]
+
+
+class ResourceListParams(TypedDict, total=False):
+    cname: str
+    """Delivery domain (CNAME) of the CDN resource."""
+
+    deleted: bool
+    """Defines whether a CDN resource has been deleted.
+
+    Possible values:
+
+    - **true** - CDN resource has been deleted.
+    - **false** - CDN resource has not been deleted.
+    """
+
+    enabled: bool
+    """Enables or disables a CDN resource change by a user.
+
+    Possible values:
+
+    - **true** - CDN resource is enabled.
+    - **false** - CDN resource is disabled.
+    """
+
+    max_created: str
+    """
+    Most recent date of CDN resource creation for which CDN resources should be
+    returned (ISO 8601/RFC 3339 format, UTC.)
+    """
+
+    min_created: str
+    """
+    Earliest date of CDN resource creation for which CDN resources should be
+    returned (ISO 8601/RFC 3339 format, UTC.)
+    """
+
+    origin_group: Annotated[int, PropertyInfo(alias="originGroup")]
+    """Origin group ID."""
+
+    rules: str
+    """Rule name or pattern."""
+
+    secondary_hostnames: Annotated[str, PropertyInfo(alias="secondaryHostnames")]
+    """Additional delivery domains (CNAMEs) of the CDN resource."""
+
+    shield_dc: str
+    """Name of the origin shielding data center location."""
+
+    shielded: bool
+    """Defines whether origin shielding is enabled for the CDN resource.
+
+    Possible values:
+
+    - **true** - Origin shielding is enabled for the CDN resource.
+    - **false** - Origin shielding is disabled for the CDN resource.
+    """
+
+    ssl_data: Annotated[int, PropertyInfo(alias="sslData")]
+    """SSL certificate ID."""
+
+    ssl_data_in: Annotated[int, PropertyInfo(alias="sslData_in")]
+    """SSL certificates IDs.
+
+    Example:
+
+    - ?`sslData_in`=1643,1644,1652
+    """
+
+    ssl_enabled: Annotated[bool, PropertyInfo(alias="sslEnabled")]
+    """Defines whether the HTTPS protocol is enabled for content delivery.
+
+    Possible values:
+
+    - **true** - HTTPS protocol is enabled for CDN resource.
+    - **false** - HTTPS protocol is disabled for CDN resource.
+    """
+
+    status: Literal["active", "processed", "suspended", "deleted"]
+    """CDN resource status."""
+
+    suspend: bool
+    """Defines whether the CDN resource was automatically suspended by the system.
+
+    Possible values:
+
+    - **true** - CDN resource is selected for automatic suspension in the next 7
+      days.
+    - **false** - CDN resource is not selected for automatic suspension.
+    """
+
+    vp_enabled: bool
+    """Defines whether the CDN resource is integrated with the Streaming platform.
+
+    Possible values:
+
+    - **true** - CDN resource is used for Streaming platform.
+    - **false** - CDN resource is not used for Streaming platform.
+    """

gcore/types/cdn/resource_prefetch_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 ..._types import SequenceNotStr
+
+__all__ = ["ResourcePrefetchParams"]
+
+
+class ResourcePrefetchParams(TypedDict, total=False):
+    paths: Required[SequenceNotStr[str]]
+    """Paths to files that should be pre-populated to the CDN.
+
+    Paths to the files should be specified without a domain name.
+    """

gcore/types/cdn/resource_purge_params.py

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["ResourcePurgeParams", "PurgeByURL", "PurgeByPattern", "PurgeAllCache"]
+
+
+class PurgeByURL(TypedDict, total=False):
+    urls: SequenceNotStr[str]
+    """**Purge by URL** clears the cache of a specific files.
+
+    This purge type is recommended.
+
+    Specify file URLs including query strings. URLs should start with / without a
+    domain name.
+
+    Purge by URL depends on the following CDN options:
+
+    1. "vary response header" is used. If your origin serves variants of the same
+       content depending on the Vary HTTP response header, purge by URL will delete
+       only one version of the file.
+    2. "slice" is used. If you update several files in the origin without clearing
+       the CDN cache, purge by URL will delete only the first slice (with bytes=0…
+       .)
+    3. "ignoreQueryString" is used. Don’t specify parameters in the purge request.
+    4. "`query_params_blacklist`" is used. Only files with the listed in the option
+       parameters will be cached as different objects. Files with other parameters
+       will be cached as one object. In this case, specify the listed parameters in
+       the Purge request. Don't specify other parameters.
+    5. "`query_params_whitelist`" is used. Files with listed in the option
+       parameters will be cached as one object. Files with other parameters will be
+       cached as different objects. In this case, specify other parameters (if any)
+       besides the ones listed in the purge request.
+    """
+
+
+class PurgeByPattern(TypedDict, total=False):
+    paths: SequenceNotStr[str]
+    """**Purge by pattern** clears the cache that matches the pattern.
+
+    Use \\** operator, which replaces any number of symbols in your path. It's
+    important to note that wildcard usage (\\**) is permitted only at the end of a
+    pattern.
+
+    Query string added to any patterns will be ignored, and purge request will be
+    processed as if there weren't any parameters.
+
+    Purge by pattern is recursive. Both /path and /path\\** will result in recursive
+    purging, meaning all content under the specified path will be affected. As such,
+    using the pattern /path\\** is functionally equivalent to simply using /path.
+    """
+
+
+class PurgeAllCache(TypedDict, total=False):
+    paths: SequenceNotStr[str]
+    """**Purge all cache** clears the entire cache for the CDN resource.
+
+    Specify an empty array to purge all content for the resource.
+
+    When you purge all assets, CDN servers request content from your origin server
+    and cause a high load. Therefore, we recommend to use purge by URL for large
+    content quantities.
+    """
+
+
+ResourcePurgeParams: TypeAlias = Union[PurgeByURL, PurgeByPattern, PurgeAllCache]