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

gcore/types/cdn/shield_aggregated_stats.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ShieldAggregatedStats"]
+
+
+class ShieldAggregatedStats(BaseModel):
+    api_1_example: Optional[object] = FieldInfo(alias="1 (example)", default=None)
+    """CDN resource ID for which statistics data is shown."""
+
+    metrics: Optional[object] = None
+    """Statistics parameters."""
+
+    resource: Optional[object] = None
+    """Resources IDs by which statistics data is grouped."""
+
+    shield_usage: Optional[str] = None
+    """Number of CDN resources that used origin shielding."""

gcore/types/cdn/shield_list_response.py

@@ -0,0 +1,25 @@
+# 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__ = ["ShieldListResponse", "ShieldListResponseItem"]
+
+
+class ShieldListResponseItem(BaseModel):
+    id: Optional[int] = None
+    """Origin shielding location ID."""
+
+    city: Optional[str] = None
+    """City of origin shielding location."""
+
+    country: Optional[str] = None
+    """Country of origin shielding location."""
+
+    datacenter: Optional[str] = None
+    """Name of origin shielding location datacenter."""
+
+
+ShieldListResponse: TypeAlias = List[ShieldListResponseItem]

gcore/types/cdn/ssl_detail.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["SslDetail"]
+
+
+class SslDetail(BaseModel):
+    id: Optional[int] = None
+    """SSL certificate ID."""
+
+    automated: Optional[bool] = None
+    """How the SSL certificate was issued.
+
+    Possible values:
+
+    - **true** - Certificate was issued automatically.
+    - **false** - Certificate was added by a use.
+    """
+
+    cert_issuer: Optional[str] = None
+    """Name of the certification center issued the SSL certificate."""
+
+    cert_subject_alt: Optional[str] = None
+    """Alternative domain names that the SSL certificate secures."""
+
+    cert_subject_cn: Optional[str] = None
+    """Domain name that the SSL certificate secures."""
+
+    deleted: Optional[bool] = None
+    """Defines whether the certificate has been deleted. Parameter is **deprecated**.
+
+    Possible values:
+
+    - **true** - Certificate has been deleted.
+    - **false** - Certificate has not been deleted.
+    """
+
+    has_related_resources: Optional[bool] = FieldInfo(alias="hasRelatedResources", default=None)
+    """Defines whether the SSL certificate is used by a CDN resource.
+
+    Possible values:
+
+    - **true** - Certificate is used by a CDN resource.
+    - **false** - Certificate is not used by a CDN resource.
+    """
+
+    name: Optional[str] = None
+    """SSL certificate name."""
+
+    ssl_certificate_chain: Optional[str] = FieldInfo(alias="sslCertificateChain", default=None)
+    """Parameter is **deprecated**."""
+
+    validity_not_after: Optional[str] = None
+    """Date when certificate become untrusted (ISO 8601/RFC 3339 format, UTC.)"""
+
+    validity_not_before: Optional[str] = None
+    """Date when certificate become valid (ISO 8601/RFC 3339 format, UTC.)"""

gcore/types/cdn/ssl_detail_list.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 .ssl_detail import SslDetail
+
+__all__ = ["SslDetailList"]
+
+SslDetailList: TypeAlias = List[SslDetail]

gcore/types/cdn/ssl_request_status.py

@@ -0,0 +1,135 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["SslRequestStatus", "LatestStatus", "Status"]
+
+
+class LatestStatus(BaseModel):
+    id: Optional[int] = None
+    """ID of the attempt to issue the Let's Encrypt certificate."""
+
+    created: Optional[str] = None
+    """
+    Date and time when the issuing attempt status was created (ISO 8601/RFC 3339
+    format, UTC).
+    """
+
+    details: Optional[str] = None
+    """
+    Detailed description of the error that occurred when trying to issue a Let's
+    Encrypt certificate.
+    """
+
+    error: Optional[str] = None
+    """
+    Brief description of the error that occurred when trying to issue a Let's
+    Encrypt certificate.
+    """
+
+    retry_after: Optional[str] = None
+    """
+    Date indicating when the certificate issuance limit will be lifted (ISO 8601/RFC
+    3339 format, UTC).
+
+    It is filled in only if error = RateLimited.
+    """
+
+    status: Optional[str] = None
+    """Status of the attempt to issue the Let's Encrypt certificate.
+
+    Possible values:
+
+    - **Done** - Attempt is successful. Let's Encrypt certificate was issued.
+    - **Failed** - Attempt failed. Let's Encrypt certificate was not issued.
+    - **Cancelled** - Attempt is canceled. Let's Encrypt certificate was not issued.
+    """
+
+
+class Status(BaseModel):
+    id: Optional[int] = None
+    """ID of the attempt to issue the Let's Encrypt certificate."""
+
+    created: Optional[str] = None
+    """
+    Date and time when the issuing attempt status was created (ISO 8601/RFC 3339
+    format, UTC).
+    """
+
+    details: Optional[str] = None
+    """
+    Detailed description of the error that occurred when trying to issue a Let's
+    Encrypt certificate.
+    """
+
+    error: Optional[str] = None
+    """
+    Brief description of the error that occurred when trying to issue a Let's
+    Encrypt certificate.
+    """
+
+    retry_after: Optional[str] = None
+    """
+    Date indicating when the certificate issuance limit will be lifted (ISO 8601/RFC
+    3339 format, UTC).
+
+    It is filled in only if error = RateLimited.
+    """
+
+    status: Optional[str] = None
+    """Status of the attempt to issue the Let's Encrypt certificate.
+
+    Possible values:
+
+    - **Done** - Attempt is successful. Let's Encrypt certificate was issued.
+    - **Failed** - Attempt failed. Let's Encrypt certificate was not issued.
+    - **Cancelled** - Attempt is canceled. Let's Encrypt certificate was not issued.
+    """
+
+
+class SslRequestStatus(BaseModel):
+    id: Optional[int] = None
+    """ID of the attempt to issue a Let's Encrypt certificate."""
+
+    active: Optional[bool] = None
+    """Defines whether the Let's Encrypt certificate issuing process is active.
+
+    Possible values:
+
+    - **true** - Issuing process is active.
+    - **false** - Issuing process is completed.
+    """
+
+    attempts_count: Optional[int] = None
+    """Number of attempts to issue the Let's Encrypt certificate."""
+
+    finished: Optional[str] = None
+    """
+    Date when the process of issuing a Let's Encrypt certificate was finished (ISO
+    8601/RFC 3339 format, UTC).
+
+    The field is **null** if the issuing process is not finished.
+    """
+
+    latest_status: Optional[LatestStatus] = None
+    """Detailed information about last attempt to issue a Let's Encrypt certificate."""
+
+    next_attempt_time: Optional[str] = None
+    """
+    Time of the next scheduled attempt to issue the Let's Encrypt certificate (ISO
+    8601/RFC 3339 format, UTC).
+    """
+
+    resource: Optional[int] = None
+    """CDN resource ID."""
+
+    started: Optional[str] = None
+    """
+    Date when the process of issuing a Let's Encrypt certificate was started (ISO
+    8601/RFC 3339 format, UTC).
+    """
+
+    statuses: Optional[List[Status]] = None
+    """Detailed information about attempts to issue a Let's Encrypt certificate."""

gcore/types/cdn/statistic_get_logs_usage_aggregated_params.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetLogsUsageAggregatedParams"]
+
+
+class StatisticGetLogsUsageAggregatedParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    to: Required[str]
+    """End of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    flat: bool
+    """The waу parameters are arranged in the response.
+
+    Possible values:
+
+    - **true** – Flat structure is used.
+    - **false** – Embedded structure is used (default.)
+    """
+
+    group_by: str
+    """Output data grouping.
+
+    Possible value:
+
+    - **resource** - Data is grouped by CDN resources.
+    """
+
+    resource: int
+    """CDN resources IDs by that statistics data is grouped.
+
+    To request multiple values, use:
+
+    - &resource=1&resource=2
+    """

gcore/types/cdn/statistic_get_logs_usage_series_params.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetLogsUsageSeriesParams"]
+
+
+class StatisticGetLogsUsageSeriesParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)
+
+    Example:
+
+    - &from=2020-01-01T00:00:00.000
+    """
+
+    to: Required[str]
+    """End of the requested time period (ISO 8601/RFC 3339 format, UTC.)
+
+    Example:
+
+    - &from=2020-01-01T00:00:00.000
+    """
+
+    resource: int
+    """CDN resources IDs by that statistics data is grouped.
+
+    To request multiple values, use:
+
+    - &resource=1&resource=2
+    """

gcore/types/cdn/statistic_get_resource_usage_aggregated_params.py

@@ -0,0 +1,151 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetResourceUsageAggregatedParams"]
+
+
+class StatisticGetResourceUsageAggregatedParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)
+
+    Examples:
+
+    - &from=2018-11-01T00:00:00.000
+    - &from=2018-11-01
+    """
+
+    metrics: Required[str]
+    """Types of statistics data.
+
+    Possible values:
+
+    - **`upstream_bytes`** – Traffic in bytes from an origin server to CDN servers
+      or to origin shielding when used.
+    - **`sent_bytes`** – Traffic in bytes from CDN servers to clients.
+    - **`shield_bytes`** – Traffic in bytes from origin shielding to CDN servers.
+    - **`backblaze_bytes`** - Traffic in bytes from Backblaze origin.
+    - **`total_bytes`** – `shield_bytes`, `upstream_bytes` and `sent_bytes`
+      combined.
+    - **`cdn_bytes`** – `sent_bytes` and `shield_bytes` combined.
+    - **requests** – Number of requests to edge servers.
+    - **`responses_2xx`** – Number of 2xx response codes.
+    - **`responses_3xx`** – Number of 3xx response codes.
+    - **`responses_4xx`** – Number of 4xx response codes.
+    - **`responses_5xx`** – Number of 5xx response codes.
+    - **`responses_hit`** – Number of responses with the header Cache: HIT.
+    - **`responses_miss`** – Number of responses with the header Cache: MISS.
+    - **`response_types`** – Statistics by content type. It returns a number of
+      responses for content with different MIME types.
+    - **`cache_hit_traffic_ratio`** – Formula: 1 - `upstream_bytes` / `sent_bytes`.
+      We deduct the non-cached traffic from the total traffic amount.
+    - **`cache_hit_requests_ratio`** – Formula: `responses_hit` / requests. The
+      share of sending cached content.
+    - **`shield_traffic_ratio`** – Formula: (`shield_bytes` - `upstream_bytes`) /
+      `shield_bytes`. The efficiency of the Origin Shielding: how much more traffic
+      is sent from the Origin Shielding than from the origin.
+    - **`image_processed`** - Number of images transformed on the Image optimization
+      service.
+    - **`request_time`** - Time elapsed between the first bytes of a request were
+      processed and logging after the last bytes were sent to a user.
+    - **`upstream_response_time`** - Number of milliseconds it took to receive a
+      response from an origin. If upstream `response_time_` contains several
+      indications for one request (in case of more than 1 origin), we summarize
+      them. In case of aggregating several queries, the average of this amount is
+      calculated.
+    - **`95_percentile`** - Represents the 95th percentile of network bandwidth
+      usage in bytes per second. This means that 95% of the time, the network
+      resource usage was below this value.
+    - **`max_bandwidth`** - The maximum network bandwidth that was used during the
+      selected time represented in bytes per second.
+    - **`min_bandwidth`** - The minimum network bandwidth that was used during the
+      selected time represented in bytes per second.
+
+    Metrics **`upstream_response_time`** and **`request_time`** should be requested
+    separately from other metrics
+    """
+
+    service: Required[str]
+    """Service name.
+
+    Possible value:
+
+    - CDN
+    """
+
+    to: Required[str]
+    """End of the requested time period (ISO 8601/RFC 3339 format, UTC.)
+
+    Examples:
+
+    - &to=2018-11-01T00:00:00.000
+    - &to=2018-11-01
+    """
+
+    countries: str
+    """Names of countries for which data is displayed.
+
+    English short name from [ISO 3166 standard][1] without the definite article
+    "the" should be used.
+
+    [1]: https://www.iso.org/obp/ui/#search/code/
+
+    To request multiple values, use:
+
+    - &countries=france&countries=denmark
+    """
+
+    flat: bool
+    """The waу the parameters are arranged in the response.
+
+    Possible values:
+
+    - **true** – Flat structure is used.
+    - **false** – Embedded structure is used (default.)
+    """
+
+    group_by: str
+    """Output data grouping.
+
+    Possible values:
+
+    - **resource** – Data is grouped by CDN resources IDs.
+    - **region** – Data is grouped by regions of CDN edge servers.
+    - **country** – Data is grouped by countries of CDN edge servers.
+    - **vhost** – Data is grouped by resources CNAME.
+
+    To request multiple values, use:
+
+    - &`group_by`=region&`group_by`=resource
+    """
+
+    regions: str
+    """Regions for which data is displayed.
+
+    Possible values:
+
+    - **na** – North America
+    - **eu** – Europe
+    - **cis** – Commonwealth of Independent States
+    - **asia** – Asia
+    - **au** – Australia
+    - **latam** – Latin America
+    - **me** – Middle East
+    - **africa** - Africa
+    - **sa** - South America
+    """
+
+    resource: int
+    """CDN resources IDs by which statistics data is grouped.
+
+    To request multiple values, use:
+
+    - &resource=1&resource=2
+
+    If CDN resource ID is not specified, data related to all CDN resources is
+    returned.
+    """

gcore/types/cdn/statistic_get_resource_usage_series_params.py

@@ -0,0 +1,131 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetResourceUsageSeriesParams"]
+
+
+class StatisticGetResourceUsageSeriesParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    granularity: Required[str]
+    """Duration of the time blocks into which the data will be divided.
+
+    Possible values:
+
+    - **1m** - available only for up to 1 month in the past.
+    - **5m**
+    - **15m**
+    - **1h**
+    - **1d**
+    """
+
+    metrics: Required[str]
+    """Types of statistics data.
+
+    Possible values:
+
+    - **`upstream_bytes`** – Traffic in bytes from an origin server to CDN servers
+      or to origin shielding when used.
+    - **`sent_bytes`** – Traffic in bytes from CDN servers to clients.
+    - **`shield_bytes`** – Traffic in bytes from origin shielding to CDN servers.
+    - **`backblaze_bytes`** - Traffic in bytes from Backblaze origin.
+    - **`total_bytes`** – `shield_bytes`, `upstream_bytes` and `sent_bytes`
+      combined.
+    - **`cdn_bytes`** – `sent_bytes` and `shield_bytes` combined.
+    - **requests** – Number of requests to edge servers.
+    - **`responses_2xx`** – Number of 2xx response codes.
+    - **`responses_3xx`** – Number of 3xx response codes.
+    - **`responses_4xx`** – Number of 4xx response codes.
+    - **`responses_5xx`** – Number of 5xx response codes.
+    - **`responses_hit`** – Number of responses with the header Cache: HIT.
+    - **`responses_miss`** – Number of responses with the header Cache: MISS.
+    - **`response_types`** – Statistics by content type. It returns a number of
+      responses for content with different MIME types.
+    - **`cache_hit_traffic_ratio`** – Formula: 1 - `upstream_bytes` / `sent_bytes`.
+      We deduct the non-cached traffic from the total traffic amount.
+    - **`cache_hit_requests_ratio`** – Formula: `responses_hit` / requests. The
+      share of sending cached content.
+    - **`shield_traffic_ratio`** – Formula: (`shield_bytes` - `upstream_bytes`) /
+      `shield_bytes`. The efficiency of the Origin Shielding: how much more traffic
+      is sent from the Origin Shielding than from the origin.
+    - **`image_processed`** - Number of images transformed on the Image optimization
+      service.
+    - **`request_time`** - Time elapsed between the first bytes of a request were
+      processed and logging after the last bytes were sent to a user.
+    - **`upstream_response_time`** - Number of milliseconds it took to receive a
+      response from an origin. If upstream `response_time_` contains several
+      indications for one request (in case of more than 1 origin), we summarize
+      them. In case of aggregating several queries, the average of this amount is
+      calculated.
+
+    Metrics **`upstream_response_time`** and **`request_time`** should be requested
+    separately from other metrics
+    """
+
+    service: Required[str]
+    """Service name.
+
+    Possible value:
+
+    - CDN
+    """
+
+    to: Required[str]
+    """End of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    countries: str
+    """
+    Names of countries for which data should be displayed. English short name from
+    [ISO 3166 standard][1] without the definite article ("the") should be used.
+
+    [1]: https://www.iso.org/obp/ui/#search/code/
+
+    To request multiple values, use:
+
+    - &countries=france&countries=denmark
+    """
+
+    group_by: str
+    """Output data grouping.
+
+    Possible values:
+
+    - **resource** – Data is grouped by CDN resources IDs.
+    - **region** – Data is grouped by regions of CDN edge servers.
+    - **country** – Data is grouped by countries of CDN edge servers.
+    - **vhost** – Data is grouped by resources CNAMEs.
+
+    To request multiple values, use:
+
+    - &`group_by`=region&`group_by`=resource
+    """
+
+    regions: str
+    """Regions for which data is displayed.
+
+    Possible values:
+
+    - **na** – North America
+    - **eu** – Europe
+    - **cis** – Commonwealth of Independent States
+    - **asia** – Asia
+    - **au** – Australia
+    - **latam** – Latin America
+    - **me** – Middle East
+    - **africa** - Africa
+    - **sa** - South America
+    """
+
+    resource: int
+    """CDN resource IDs.
+
+    To request multiple values, use:
+
+    - &resource=1&resource=2
+    """

gcore/types/cdn/statistic_get_shield_usage_aggregated_params.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetShieldUsageAggregatedParams"]
+
+
+class StatisticGetShieldUsageAggregatedParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    to: Required[str]
+    """End of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    flat: bool
+    """The waу parameters are arranged in the response.
+
+    Possible values:
+
+    - **true** – Flat structure is used.
+    - **false** – Embedded structure is used (default.)
+    """
+
+    group_by: str
+    """Output data grouping.
+
+    Possible value:
+
+    - **resource** - Data is grouped by CDN resource.
+    """
+
+    resource: int
+    """CDN resources IDs by that statistics data is grouped.
+
+    To request multiple values, use:
+
+    - &resource=1&resource=2
+    """

gcore/types/cdn/statistic_get_shield_usage_series_params.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetShieldUsageSeriesParams"]
+
+
+class StatisticGetShieldUsageSeriesParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    to: Required[str]
+    """End of the requested time period (ISO 8601/RFC 3339 format, UTC.)"""
+
+    resource: int
+    """CDN resources IDs by that statistics data is grouped.
+
+    To request multiple values, use:
+
+    - &resource=1&resource=2
+    """