gcore 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

gcore/types/iam/api_token_create_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 Literal, Required, TypedDict
+
+__all__ = ["APITokenCreateParams", "ClientUser", "ClientUserRole"]
+
+
+class APITokenCreateParams(TypedDict, total=False):
+    client_user: Required[ClientUser]
+    """API token role."""
+
+    exp_date: Required[str]
+    """
+    Date when the API token becomes expired (ISO 8086/RFC 3339 format), UTC. If
+    null, then the API token will never expire.
+    """
+
+    name: Required[str]
+    """API token name."""
+
+    description: str
+    """API token description."""
+
+
+class ClientUserRole(TypedDict, total=False):
+    id: int
+    """Group's ID: Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+    """
+
+    name: Literal[
+        "Users", "Administrators", "Engineers", "Purge and Prefetch only (API)", "Purge and Prefetch only (API+Web)"
+    ]
+    """Group's name."""
+
+
+class ClientUser(TypedDict, total=False):
+    role: ClientUserRole

gcore/types/iam/api_token_list.py

@@ -0,0 +1,81 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = ["APITokenList", "APITokenListItem", "APITokenListItemClientUser", "APITokenListItemClientUserRole"]
+
+
+class APITokenListItemClientUserRole(BaseModel):
+    id: Optional[int] = None
+    """Group's ID: Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+    """
+
+    name: Optional[
+        Literal[
+            "Users", "Administrators", "Engineers", "Purge and Prefetch only (API)", "Purge and Prefetch only (API+Web)"
+        ]
+    ] = None
+    """Group's name."""
+
+
+class APITokenListItemClientUser(BaseModel):
+    client_id: Optional[int] = None
+    """Account's ID."""
+
+    deleted: Optional[bool] = None
+    """Deletion flag. If true, then the API token was deleted."""
+
+    role: Optional[APITokenListItemClientUserRole] = None
+
+    user_email: Optional[str] = None
+    """User's email who issued the API token."""
+
+    user_id: Optional[int] = None
+    """User's ID who issued the API token."""
+
+    user_name: Optional[str] = None
+    """User's name who issued the API token."""
+
+
+class APITokenListItem(BaseModel):
+    client_user: APITokenListItemClientUser
+
+    exp_date: str
+    """
+    Date when the API token becomes expired (ISO 8086/RFC 3339 format), UTC. If
+    null, then the API token will never expire.
+    """
+
+    name: str
+    """API token name."""
+
+    id: Optional[int] = None
+    """API token ID."""
+
+    created: Optional[str] = None
+    """Date when the API token was issued (ISO 8086/RFC 3339 format), UTC."""
+
+    deleted: Optional[bool] = None
+    """Deletion flag. If true, then the API token was deleted."""
+
+    description: Optional[str] = None
+    """API token description."""
+
+    expired: Optional[bool] = None
+    """Expiration flag.
+
+    If true, then the API token has expired. When an API token expires it will be
+    automatically deleted.
+    """
+
+    last_usage: Optional[str] = None
+    """Date when the API token was last used (ISO 8086/RFC 3339 format), UTC."""
+
+
+APITokenList: TypeAlias = List[APITokenListItem]

gcore/types/iam/api_token_list_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["APITokenListParams"]
+
+
+class APITokenListParams(TypedDict, total=False):
+    deleted: bool
+    """The state of API tokens included in the response.
+     Two possible values:
+
+    - True - API token was not deleted.\\** False - API token was deleted.
+
+    Example, _&deleted=True_
+    """
+
+    issued_by: int
+    """User's ID.
+
+    Use to get API tokens issued by a particular user.
+     Example, _&`issued_by`=1234_
+    """
+
+    not_issued_by: int
+    """User's ID.
+
+    Use to get API tokens issued by anyone except a particular user.
+     Example, _¬_issued_by=1234_
+    """
+
+    role: str
+    """Group's ID. Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+
+    Example, _&role=Engineers_
+    """

gcore/types/iam/user.py

@@ -0,0 +1,86 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["User", "Group"]
+
+
+class Group(BaseModel):
+    id: Optional[int] = None
+    """Group's ID: Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+    """
+
+    name: Optional[
+        Literal[
+            "Users", "Administrators", "Engineers", "Purge and Prefetch only (API)", "Purge and Prefetch only (API+Web)"
+        ]
+    ] = None
+    """Group's name."""
+
+
+class User(BaseModel):
+    id: Optional[int] = None
+    """User's ID."""
+
+    activated: Optional[bool] = None
+    """Email confirmation:
+
+    - `true` – user confirmed the email;
+    - `false` – user did not confirm the email.
+    """
+
+    auth_types: Optional[List[Literal["password", "sso", "github", "google-oauth2"]]] = None
+    """System field. List of auth types available for the account."""
+
+    client: Optional[float] = None
+    """User's account ID."""
+
+    company: Optional[str] = None
+    """User's company."""
+
+    deleted: Optional[bool] = None
+    """Deletion flag. If `true` then user was deleted."""
+
+    email: Optional[str] = None
+    """User's email address."""
+
+    groups: Optional[List[Group]] = None
+    """User's group in the current account. IAM supports 5 groups:
+
+    - Users
+    - Administrators
+    - Engineers
+    - Purge and Prefetch only (API)
+    - Purge and Prefetch only (API+Web)
+    """
+
+    lang: Optional[Literal["de", "en", "ru", "zh", "az"]] = None
+    """User's language. Defines language of the control panel and email messages."""
+
+    name: Optional[str] = None
+    """User's name."""
+
+    phone: Optional[str] = None
+    """User's phone."""
+
+    reseller: Optional[int] = None
+    """Services provider ID."""
+
+    sso_auth: Optional[bool] = None
+    """SSO authentication flag. If `true` then user can login via SAML SSO."""
+
+    two_fa: Optional[bool] = None
+    """Two-step verification:
+
+    - `true` – user enabled two-step verification;
+    - `false` – user disabled two-step verification.
+    """
+
+    user_type: Optional[Literal["common"]] = None
+    """User's type."""

gcore/types/iam/user_detailed.py

@@ -0,0 +1,104 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["UserDetailed", "ClientAndRole", "Group"]
+
+
+class ClientAndRole(BaseModel):
+    client_company_name: str
+
+    client_id: int
+
+    user_id: int
+    """User's ID."""
+
+    user_roles: List[str]
+    """User role in this client."""
+
+
+class Group(BaseModel):
+    id: Optional[int] = None
+    """Group's ID: Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+    """
+
+    name: Optional[
+        Literal[
+            "Users", "Administrators", "Engineers", "Purge and Prefetch only (API)", "Purge and Prefetch only (API+Web)"
+        ]
+    ] = None
+    """Group's name."""
+
+
+class UserDetailed(BaseModel):
+    id: Optional[int] = None
+    """User's ID."""
+
+    activated: Optional[bool] = None
+    """Email confirmation:
+
+    - `true` – user confirmed the email;
+    - `false` – user did not confirm the email.
+    """
+
+    auth_types: Optional[List[Literal["password", "sso", "github", "google-oauth2"]]] = None
+    """System field. List of auth types available for the account."""
+
+    client: Optional[float] = None
+    """User's account ID."""
+
+    client_and_roles: Optional[List[ClientAndRole]] = None
+    """List of user's clients. User can access to one or more clients."""
+
+    company: Optional[str] = None
+    """User's company."""
+
+    deleted: Optional[bool] = None
+    """Deletion flag. If `true` then user was deleted."""
+
+    email: Optional[str] = None
+    """User's email address."""
+
+    groups: Optional[List[Group]] = None
+    """User's group in the current account. IAM supports 5 groups:
+
+    - Users
+    - Administrators
+    - Engineers
+    - Purge and Prefetch only (API)
+    - Purge and Prefetch only (API+Web)
+    """
+
+    is_active: Optional[bool] = None
+    """User activity flag."""
+
+    lang: Optional[Literal["de", "en", "ru", "zh", "az"]] = None
+    """User's language. Defines language of the control panel and email messages."""
+
+    name: Optional[str] = None
+    """User's name."""
+
+    phone: Optional[str] = None
+    """User's phone."""
+
+    reseller: Optional[int] = None
+    """Services provider ID."""
+
+    sso_auth: Optional[bool] = None
+    """SSO authentication flag. If `true` then user can login via SAML SSO."""
+
+    two_fa: Optional[bool] = None
+    """Two-step verification:
+
+    - `true` – user enabled two-step verification;
+    - `false` – user disabled two-step verification.
+    """
+
+    user_type: Optional[Literal["common", "reseller", "seller"]] = None
+    """User's type."""

gcore/types/iam/user_invite.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["UserInvite"]
+
+
+class UserInvite(BaseModel):
+    status: Optional[str] = None
+    """Status of the invitation."""
+
+    user_id: Optional[int] = None
+    """Invited user ID."""

gcore/types/iam/user_invite_params.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["UserInviteParams", "UserRole"]
+
+
+class UserInviteParams(TypedDict, total=False):
+    client_id: Required[int]
+    """ID of account."""
+
+    email: Required[str]
+    """User email."""
+
+    user_role: Required[UserRole]
+
+    lang: Literal["de", "en", "ru", "zh", "az"]
+    """User's language. Defines language of the control panel and email messages."""
+
+    name: str
+    """User name."""
+
+
+class UserRole(TypedDict, total=False):
+    id: int
+    """Group's ID: Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+    """
+
+    name: Literal[
+        "Users", "Administrators", "Engineers", "Purge and Prefetch only (API)", "Purge and Prefetch only (API+Web)"
+    ]
+    """Group's name."""

gcore/types/iam/user_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["UserListParams"]
+
+
+class UserListParams(TypedDict, total=False):
+    limit: int
+    """The maximum number of items."""
+
+    offset: int
+    """Offset relative to the beginning of list."""

gcore/types/iam/user_update.py

@@ -0,0 +1,104 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["UserUpdate", "ClientAndRole", "Group"]
+
+
+class ClientAndRole(BaseModel):
+    client_company_name: str
+
+    client_id: int
+
+    user_id: int
+    """User's ID."""
+
+    user_roles: List[str]
+    """User role in this client."""
+
+
+class Group(BaseModel):
+    id: Optional[int] = None
+    """Group's ID: Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+    """
+
+    name: Optional[
+        Literal[
+            "Users", "Administrators", "Engineers", "Purge and Prefetch only (API)", "Purge and Prefetch only (API+Web)"
+        ]
+    ] = None
+    """Group's name."""
+
+
+class UserUpdate(BaseModel):
+    id: Optional[int] = None
+    """User's ID."""
+
+    activated: Optional[bool] = None
+    """Email confirmation:
+
+    - `true` – user confirmed the email;
+    - `false` – user did not confirm the email.
+    """
+
+    auth_types: Optional[List[Literal["password", "sso", "github", "google-oauth2"]]] = None
+    """System field. List of auth types available for the account."""
+
+    client: Optional[float] = None
+    """User's account ID."""
+
+    client_and_roles: Optional[List[ClientAndRole]] = None
+    """List of user's clients. User can access to one or more clients."""
+
+    company: Optional[str] = None
+    """User's company."""
+
+    deleted: Optional[bool] = None
+    """Deletion flag. If `true` then user was deleted."""
+
+    email: Optional[str] = None
+    """User's email address."""
+
+    groups: Optional[List[Group]] = None
+    """User's group in the current account. IAM supports 5 groups:
+
+    - Users
+    - Administrators
+    - Engineers
+    - Purge and Prefetch only (API)
+    - Purge and Prefetch only (API+Web)
+    """
+
+    is_active: Optional[bool] = None
+    """User activity flag."""
+
+    lang: Optional[Literal["de", "en", "ru", "zh", "az"]] = None
+    """User's language. Defines language of the control panel and email messages."""
+
+    name: Optional[str] = None
+    """User's name."""
+
+    phone: Optional[str] = None
+    """User's phone."""
+
+    reseller: Optional[int] = None
+    """Services provider ID."""
+
+    sso_auth: Optional[bool] = None
+    """SSO authentication flag. If `true` then user can login via SAML SSO."""
+
+    two_fa: Optional[bool] = None
+    """Two-step verification:
+
+    - `true` – user enabled two-step verification;
+    - `false` – user disabled two-step verification.
+    """
+
+    user_type: Optional[Literal["common", "reseller", "seller"]] = None
+    """User's type."""

gcore/types/iam/user_update_params.py

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Iterable, Optional
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["UserUpdateParams", "Group"]
+
+
+class UserUpdateParams(TypedDict, total=False):
+    auth_types: List[Literal["password", "sso", "github", "google-oauth2"]]
+    """System field. List of auth types available for the account."""
+
+    company: str
+    """User's company."""
+
+    email: str
+    """User's email address."""
+
+    groups: Iterable[Group]
+    """User's group in the current account. IAM supports 5 groups:
+
+    - Users
+    - Administrators
+    - Engineers
+    - Purge and Prefetch only (API)
+    - Purge and Prefetch only (API+Web)
+    """
+
+    lang: Literal["de", "en", "ru", "zh", "az"]
+    """User's language. Defines language of the control panel and email messages."""
+
+    name: Optional[str]
+    """User's name."""
+
+    phone: Optional[str]
+    """User's phone."""
+
+
+class Group(TypedDict, total=False):
+    id: int
+    """Group's ID: Possible values are:
+
+    - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only
+      (API+Web)* 3022 - Purge and Prefetch only (API)
+    """
+
+    name: Literal[
+        "Users", "Administrators", "Engineers", "Purge and Prefetch only (API)", "Purge and Prefetch only (API+Web)"
+    ]
+    """Group's name."""