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

gcore/types/cdn/network_capacity.py

@@ -0,0 +1,22 @@
+# 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__ = ["NetworkCapacity", "NetworkCapacityItem"]
+
+
+class NetworkCapacityItem(BaseModel):
+    capacity: Optional[float] = None
+    """Network capacity in Gbit/s."""
+
+    country: Optional[str] = None
+    """Country name."""
+
+    country_code: Optional[str] = None
+    """ISO country code."""
+
+
+NetworkCapacity: TypeAlias = List[NetworkCapacityItem]

gcore/types/cdn/origin_group_create_params.py

@@ -0,0 +1,184 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["OriginGroupCreateParams", "NoneAuth", "NoneAuthSource", "AwsSignatureV4", "AwsSignatureV4Auth"]
+
+
+class NoneAuth(TypedDict, total=False):
+    name: Required[str]
+    """Origin group name."""
+
+    sources: Required[Iterable[NoneAuthSource]]
+    """List of origin sources in the origin group."""
+
+    auth_type: str
+    """Origin authentication type.
+
+    Possible values:
+
+    - **none** - Used for public origins.
+    - **awsSignatureV4** - Used for S3 storage.
+    """
+
+    proxy_next_upstream: SequenceNotStr[str]
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+    use_next: bool
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+
+class NoneAuthSource(TypedDict, total=False):
+    backup: bool
+    """
+    Defines whether the origin is a backup, meaning that it will not be used until
+    one of active origins become unavailable.
+
+    Possible values:
+
+    - **true** - Origin is a backup.
+    - **false** - Origin is not a backup.
+    """
+
+    enabled: bool
+    """Enables or disables an origin source in the origin group.
+
+    Possible values:
+
+    - **true** - Origin is enabled and the CDN uses it to pull content.
+    - **false** - Origin is disabled and the CDN does not use it to pull content.
+
+    Origin group must contain at least one enabled origin.
+    """
+
+    source: str
+    """IP address or domain name of the origin and the port, if custom port is used."""
+
+
+class AwsSignatureV4(TypedDict, total=False):
+    auth: Required[AwsSignatureV4Auth]
+    """Credentials to access the private bucket."""
+
+    auth_type: Required[str]
+    """Authentication type.
+
+    **awsSignatureV4** value is used for S3 storage.
+    """
+
+    name: Required[str]
+    """Origin group name."""
+
+    proxy_next_upstream: SequenceNotStr[str]
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+    use_next: bool
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+
+class AwsSignatureV4Auth(TypedDict, total=False):
+    s3_access_key_id: Required[str]
+    """Access key ID for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), colon, dash, and underscore.
+    - From 3 to 512 characters.
+    """
+
+    s3_bucket_name: Required[str]
+    """S3 bucket name.
+
+    Restrictions:
+
+    - Maximum 128 characters.
+    """
+
+    s3_secret_access_key: Required[str]
+    """Secret access key for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and
+      underscores.
+    - If "`s3_type`": amazon, length should be 40 characters.
+    - If "`s3_type`": other, length should be from 16 to 255 characters.
+    """
+
+    s3_type: Required[str]
+    """Storage type compatible with S3.
+
+    Possible values:
+
+    - **amazon** – AWS S3 storage.
+    - **other** – Other (not AWS) S3 compatible storage.
+    """
+
+    s3_region: str
+    """S3 storage region.
+
+    The parameter is required, if "`s3_type`": amazon.
+    """
+
+    s3_storage_hostname: str
+    """S3 storage hostname.
+
+    The parameter is required, if "`s3_type`": other.
+    """
+
+
+OriginGroupCreateParams: TypeAlias = Union[NoneAuth, AwsSignatureV4]

gcore/types/cdn/origin_group_list_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["OriginGroupListParams"]
+
+
+class OriginGroupListParams(TypedDict, total=False):
+    has_related_resources: bool
+    """Defines whether the origin group has related CDN resources.
+
+    Possible values:
+
+    - **true** – Origin group has related CDN resources.
+    - **false** – Origin group does not have related CDN resources.
+    """
+
+    name: str
+    """Origin group name."""
+
+    sources: str
+    """Origin sources (IP addresses or domains) in the origin group."""

gcore/types/cdn/origin_group_replace_params.py

@@ -0,0 +1,190 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["OriginGroupReplaceParams", "NoneAuth", "NoneAuthSource", "AwsSignatureV4", "AwsSignatureV4Auth"]
+
+
+class NoneAuth(TypedDict, total=False):
+    auth_type: Required[str]
+    """Origin authentication type.
+
+    Possible values:
+
+    - **none** - Used for public origins.
+    - **awsSignatureV4** - Used for S3 storage.
+    """
+
+    name: Required[str]
+    """Origin group name."""
+
+    path: Required[str]
+    """Parameter is **deprecated**."""
+
+    sources: Required[Iterable[NoneAuthSource]]
+    """List of origin sources in the origin group."""
+
+    use_next: Required[bool]
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+    proxy_next_upstream: SequenceNotStr[str]
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+
+class NoneAuthSource(TypedDict, total=False):
+    backup: bool
+    """
+    Defines whether the origin is a backup, meaning that it will not be used until
+    one of active origins become unavailable.
+
+    Possible values:
+
+    - **true** - Origin is a backup.
+    - **false** - Origin is not a backup.
+    """
+
+    enabled: bool
+    """Enables or disables an origin source in the origin group.
+
+    Possible values:
+
+    - **true** - Origin is enabled and the CDN uses it to pull content.
+    - **false** - Origin is disabled and the CDN does not use it to pull content.
+
+    Origin group must contain at least one enabled origin.
+    """
+
+    source: str
+    """IP address or domain name of the origin and the port, if custom port is used."""
+
+
+class AwsSignatureV4(TypedDict, total=False):
+    auth: Required[AwsSignatureV4Auth]
+    """Credentials to access the private bucket."""
+
+    auth_type: Required[str]
+    """Authentication type.
+
+    **awsSignatureV4** value is used for S3 storage.
+    """
+
+    name: Required[str]
+    """Origin group name."""
+
+    path: Required[str]
+    """Parameter is **deprecated**."""
+
+    use_next: Required[bool]
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+    proxy_next_upstream: SequenceNotStr[str]
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+
+class AwsSignatureV4Auth(TypedDict, total=False):
+    s3_access_key_id: Required[str]
+    """Access key ID for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), colon, dash, and underscore.
+    - From 3 to 512 characters.
+    """
+
+    s3_bucket_name: Required[str]
+    """S3 bucket name.
+
+    Restrictions:
+
+    - Maximum 128 characters.
+    """
+
+    s3_secret_access_key: Required[str]
+    """Secret access key for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and
+      underscores.
+    - If "`s3_type`": amazon, length should be 40 characters.
+    - If "`s3_type`": other, length should be from 16 to 255 characters.
+    """
+
+    s3_type: Required[str]
+    """Storage type compatible with S3.
+
+    Possible values:
+
+    - **amazon** – AWS S3 storage.
+    - **other** – Other (not AWS) S3 compatible storage.
+    """
+
+    s3_region: str
+    """S3 storage region.
+
+    The parameter is required, if "`s3_type`": amazon.
+    """
+
+    s3_storage_hostname: str
+    """S3 storage hostname.
+
+    The parameter is required, if "`s3_type`": other.
+    """
+
+
+OriginGroupReplaceParams: TypeAlias = Union[NoneAuth, AwsSignatureV4]

gcore/types/cdn/origin_group_update_params.py

@@ -0,0 +1,190 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["OriginGroupUpdateParams", "NoneAuth", "NoneAuthSource", "AwsSignatureV4", "AwsSignatureV4Auth"]
+
+
+class NoneAuth(TypedDict, total=False):
+    name: Required[str]
+    """Origin group name."""
+
+    auth_type: str
+    """Origin authentication type.
+
+    Possible values:
+
+    - **none** - Used for public origins.
+    - **awsSignatureV4** - Used for S3 storage.
+    """
+
+    path: str
+    """Parameter is **deprecated**."""
+
+    proxy_next_upstream: SequenceNotStr[str]
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+    sources: Iterable[NoneAuthSource]
+    """List of origin sources in the origin group."""
+
+    use_next: bool
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+
+class NoneAuthSource(TypedDict, total=False):
+    backup: bool
+    """
+    Defines whether the origin is a backup, meaning that it will not be used until
+    one of active origins become unavailable.
+
+    Possible values:
+
+    - **true** - Origin is a backup.
+    - **false** - Origin is not a backup.
+    """
+
+    enabled: bool
+    """Enables or disables an origin source in the origin group.
+
+    Possible values:
+
+    - **true** - Origin is enabled and the CDN uses it to pull content.
+    - **false** - Origin is disabled and the CDN does not use it to pull content.
+
+    Origin group must contain at least one enabled origin.
+    """
+
+    source: str
+    """IP address or domain name of the origin and the port, if custom port is used."""
+
+
+class AwsSignatureV4(TypedDict, total=False):
+    auth: AwsSignatureV4Auth
+    """Credentials to access the private bucket."""
+
+    auth_type: str
+    """Authentication type.
+
+    **awsSignatureV4** value is used for S3 storage.
+    """
+
+    name: str
+    """Origin group name."""
+
+    path: str
+    """Parameter is **deprecated**."""
+
+    proxy_next_upstream: SequenceNotStr[str]
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+    use_next: bool
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+
+class AwsSignatureV4Auth(TypedDict, total=False):
+    s3_access_key_id: Required[str]
+    """Access key ID for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), colon, dash, and underscore.
+    - From 3 to 512 characters.
+    """
+
+    s3_bucket_name: Required[str]
+    """S3 bucket name.
+
+    Restrictions:
+
+    - Maximum 128 characters.
+    """
+
+    s3_secret_access_key: Required[str]
+    """Secret access key for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and
+      underscores.
+    - If "`s3_type`": amazon, length should be 40 characters.
+    - If "`s3_type`": other, length should be from 16 to 255 characters.
+    """
+
+    s3_type: Required[str]
+    """Storage type compatible with S3.
+
+    Possible values:
+
+    - **amazon** – AWS S3 storage.
+    - **other** – Other (not AWS) S3 compatible storage.
+    """
+
+    s3_region: str
+    """S3 storage region.
+
+    The parameter is required, if "`s3_type`": amazon.
+    """
+
+    s3_storage_hostname: str
+    """S3 storage hostname.
+
+    The parameter is required, if "`s3_type`": other.
+    """
+
+
+OriginGroupUpdateParams: TypeAlias = Union[NoneAuth, AwsSignatureV4]