zrok2-build-debugging 22.0.2000008__py3-none-any.whl

zrok_api/exceptions.py

@@ -0,0 +1,216 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

zrok_api/models/__init__.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+# import models into model package
+from zrok_api.models.access201_response import Access201Response
+from zrok_api.models.access_request import AccessRequest
+from zrok_api.models.access_summary import AccessSummary
+from zrok_api.models.accesses_list import AccessesList
+from zrok_api.models.add_frontend_grant_request import AddFrontendGrantRequest
+from zrok_api.models.add_namespace_frontend_mapping_request import AddNamespaceFrontendMappingRequest
+from zrok_api.models.add_namespace_grant_request import AddNamespaceGrantRequest
+from zrok_api.models.add_organization_member_request import AddOrganizationMemberRequest
+from zrok_api.models.auth_user import AuthUser
+from zrok_api.models.change_password_request import ChangePasswordRequest
+from zrok_api.models.client_version_check_request import ClientVersionCheckRequest
+from zrok_api.models.configuration import Configuration
+from zrok_api.models.create_frontend201_response import CreateFrontend201Response
+from zrok_api.models.create_frontend_request import CreateFrontendRequest
+from zrok_api.models.create_identity201_response import CreateIdentity201Response
+from zrok_api.models.create_identity_request import CreateIdentityRequest
+from zrok_api.models.create_namespace201_response import CreateNamespace201Response
+from zrok_api.models.create_namespace_request import CreateNamespaceRequest
+from zrok_api.models.create_organization201_response import CreateOrganization201Response
+from zrok_api.models.create_organization_request import CreateOrganizationRequest
+from zrok_api.models.create_share_name_request import CreateShareNameRequest
+from zrok_api.models.delete_identity_request import DeleteIdentityRequest
+from zrok_api.models.disable_request import DisableRequest
+from zrok_api.models.enable_request import EnableRequest
+from zrok_api.models.enroll200_response import Enroll200Response
+from zrok_api.models.enroll_request import EnrollRequest
+from zrok_api.models.environment import Environment
+from zrok_api.models.environment_and_resources import EnvironmentAndResources
+from zrok_api.models.environment_summary import EnvironmentSummary
+from zrok_api.models.environments_list import EnvironmentsList
+from zrok_api.models.frontend import Frontend
+from zrok_api.models.get_sparklines200_response import GetSparklines200Response
+from zrok_api.models.get_sparklines_request import GetSparklinesRequest
+from zrok_api.models.invite_request import InviteRequest
+from zrok_api.models.invite_token_generate_request import InviteTokenGenerateRequest
+from zrok_api.models.list_frontend_namespace_mappings200_response_inner import ListFrontendNamespaceMappings200ResponseInner
+from zrok_api.models.list_frontends200_response_inner import ListFrontends200ResponseInner
+from zrok_api.models.list_memberships200_response import ListMemberships200Response
+from zrok_api.models.list_memberships200_response_memberships_inner import ListMemberships200ResponseMembershipsInner
+from zrok_api.models.list_namespaces200_response_inner import ListNamespaces200ResponseInner
+from zrok_api.models.list_organization_members200_response import ListOrganizationMembers200Response
+from zrok_api.models.list_organization_members200_response_members_inner import ListOrganizationMembers200ResponseMembersInner
+from zrok_api.models.list_organizations200_response import ListOrganizations200Response
+from zrok_api.models.list_organizations200_response_organizations_inner import ListOrganizations200ResponseOrganizationsInner
+from zrok_api.models.list_share_namespaces200_response_inner import ListShareNamespaces200ResponseInner
+from zrok_api.models.login_request import LoginRequest
+from zrok_api.models.metrics import Metrics
+from zrok_api.models.metrics_sample import MetricsSample
+from zrok_api.models.name import Name
+from zrok_api.models.name_selection import NameSelection
+from zrok_api.models.overview import Overview
+from zrok_api.models.overview_names_inner import OverviewNamesInner
+from zrok_api.models.ping200_response import Ping200Response
+from zrok_api.models.principal import Principal
+from zrok_api.models.regenerate_account_token200_response import RegenerateAccountToken200Response
+from zrok_api.models.regenerate_account_token_request import RegenerateAccountTokenRequest
+from zrok_api.models.register_request import RegisterRequest
+from zrok_api.models.remote_access_request import RemoteAccessRequest
+from zrok_api.models.remote_share200_response import RemoteShare200Response
+from zrok_api.models.remote_share_request import RemoteShareRequest
+from zrok_api.models.remote_status200_response import RemoteStatus200Response
+from zrok_api.models.remote_status200_response_accesses_inner import RemoteStatus200ResponseAccessesInner
+from zrok_api.models.remote_status200_response_shares_inner import RemoteStatus200ResponseSharesInner
+from zrok_api.models.remote_status200_response_shares_inner_failure import RemoteStatus200ResponseSharesInnerFailure
+from zrok_api.models.remote_unaccess_request import RemoteUnaccessRequest
+from zrok_api.models.remote_unshare_request import RemoteUnshareRequest
+from zrok_api.models.remove_namespace_frontend_mapping_request import RemoveNamespaceFrontendMappingRequest
+from zrok_api.models.remove_organization_member_request import RemoveOrganizationMemberRequest
+from zrok_api.models.reset_password_request import ResetPasswordRequest
+from zrok_api.models.share import Share
+from zrok_api.models.share_http_healthcheck200_response import ShareHttpHealthcheck200Response
+from zrok_api.models.share_http_healthcheck_request import ShareHttpHealthcheckRequest
+from zrok_api.models.share_request import ShareRequest
+from zrok_api.models.share_response import ShareResponse
+from zrok_api.models.share_summary import ShareSummary
+from zrok_api.models.shares_list import SharesList
+from zrok_api.models.spark_data_sample import SparkDataSample
+from zrok_api.models.unaccess_request import UnaccessRequest
+from zrok_api.models.unshare_request import UnshareRequest
+from zrok_api.models.update_access_request import UpdateAccessRequest
+from zrok_api.models.update_frontend_request import UpdateFrontendRequest
+from zrok_api.models.update_namespace_request import UpdateNamespaceRequest
+from zrok_api.models.update_share_name_request import UpdateShareNameRequest
+from zrok_api.models.update_share_request import UpdateShareRequest
+from zrok_api.models.verify200_response import Verify200Response
+from zrok_api.models.verify_request import VerifyRequest
+from zrok_api.models.version_inventory200_response import VersionInventory200Response

zrok_api/models/access201_response.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Access201Response(BaseModel):
+    """
+    Access201Response
+    """ # noqa: E501
+    frontend_token: Optional[StrictStr] = Field(default=None, alias="frontendToken")
+    backend_mode: Optional[StrictStr] = Field(default=None, alias="backendMode")
+    __properties: ClassVar[List[str]] = ["frontendToken", "backendMode"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Access201Response from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Access201Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "frontendToken": obj.get("frontendToken"),
+            "backendMode": obj.get("backendMode")
+        })
+        return _obj
+
+

zrok_api/models/access_request.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AccessRequest(BaseModel):
+    """
+    AccessRequest
+    """ # noqa: E501
+    env_zid: Optional[StrictStr] = Field(default=None, alias="envZId")
+    share_token: Optional[StrictStr] = Field(default=None, alias="shareToken")
+    bind_address: Optional[StrictStr] = Field(default=None, alias="bindAddress")
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["envZId", "shareToken", "bindAddress", "description"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AccessRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AccessRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "envZId": obj.get("envZId"),
+            "shareToken": obj.get("shareToken"),
+            "bindAddress": obj.get("bindAddress"),
+            "description": obj.get("description")
+        })
+        return _obj
+
+

zrok_api/models/access_summary.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AccessSummary(BaseModel):
+    """
+    AccessSummary
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    frontend_token: Optional[StrictStr] = Field(default=None, alias="frontendToken")
+    env_zid: Optional[StrictStr] = Field(default=None, alias="envZId")
+    share_token: Optional[StrictStr] = Field(default=None, alias="shareToken")
+    backend_mode: Optional[StrictStr] = Field(default=None, alias="backendMode")
+    bind_address: Optional[StrictStr] = Field(default=None, alias="bindAddress")
+    description: Optional[StrictStr] = None
+    limited: Optional[StrictBool] = None
+    created_at: Optional[StrictInt] = Field(default=None, alias="createdAt")
+    updated_at: Optional[StrictInt] = Field(default=None, alias="updatedAt")
+    __properties: ClassVar[List[str]] = ["id", "frontendToken", "envZId", "shareToken", "backendMode", "bindAddress", "description", "limited", "createdAt", "updatedAt"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AccessSummary from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AccessSummary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "frontendToken": obj.get("frontendToken"),
+            "envZId": obj.get("envZId"),
+            "shareToken": obj.get("shareToken"),
+            "backendMode": obj.get("backendMode"),
+            "bindAddress": obj.get("bindAddress"),
+            "description": obj.get("description"),
+            "limited": obj.get("limited"),
+            "createdAt": obj.get("createdAt"),
+            "updatedAt": obj.get("updatedAt")
+        })
+        return _obj
+
+