stackit-kms 0.0.1__py3-none-any.whl

stackit/kms/models/key.py

@@ -0,0 +1,150 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictBool,
+    StrictStr,
+    field_validator,
+)
+from typing_extensions import Annotated, Self
+
+from stackit.kms.models.algorithm import Algorithm
+from stackit.kms.models.backend import Backend
+from stackit.kms.models.purpose import Purpose
+
+
+class Key(BaseModel):
+    """
+    Key
+    """
+
+    algorithm: Algorithm
+    backend: Backend
+    created_at: datetime = Field(
+        description="The date and time the creation of the key was triggered.", alias="createdAt"
+    )
+    deletion_date: Optional[datetime] = Field(
+        default=None,
+        description="This date is set when a key is pending deletion and refers to the scheduled date of deletion",
+        alias="deletionDate",
+    )
+    description: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(
+        default=None, description="A user chosen description to distinguish multiple keys."
+    )
+    display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
+        description="The display name to distinguish multiple keys.", alias="displayName"
+    )
+    id: StrictStr = Field(description="A auto generated unique id which identifies the keys.")
+    import_only: Optional[StrictBool] = Field(
+        default=False, description="States whether versions can be created or only imported.", alias="importOnly"
+    )
+    key_ring_id: StrictStr = Field(
+        description="The unique id of the key ring this key is assigned to.", alias="keyRingId"
+    )
+    purpose: Purpose
+    state: StrictStr = Field(description="The current state of the key.")
+    __properties: ClassVar[List[str]] = [
+        "algorithm",
+        "backend",
+        "createdAt",
+        "deletionDate",
+        "description",
+        "displayName",
+        "id",
+        "importOnly",
+        "keyRingId",
+        "purpose",
+        "state",
+    ]
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["active", "version_not_ready", "deleted"]):
+            raise ValueError("must be one of enum values ('active', 'version_not_ready', 'deleted')")
+        return value
+
+    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 Key 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 Key from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "algorithm": obj.get("algorithm"),
+                "backend": obj.get("backend"),
+                "createdAt": obj.get("createdAt"),
+                "deletionDate": obj.get("deletionDate"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "id": obj.get("id"),
+                "importOnly": obj.get("importOnly") if obj.get("importOnly") is not None else False,
+                "keyRingId": obj.get("keyRingId"),
+                "purpose": obj.get("purpose"),
+                "state": obj.get("state"),
+            }
+        )
+        return _obj

stackit/kms/models/key_list.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict
+from typing_extensions import Self
+
+from stackit.kms.models.key import Key
+
+
+class KeyList(BaseModel):
+    """
+    KeyList
+    """
+
+    keys: List[Key]
+    __properties: ClassVar[List[str]] = ["keys"]
+
+    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 KeyList 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in keys (list)
+        _items = []
+        if self.keys:
+            for _item in self.keys:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["keys"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of KeyList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"keys": [Key.from_dict(_item) for _item in obj["keys"]] if obj.get("keys") is not None else None}
+        )
+        return _obj

stackit/kms/models/key_ring.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+
+class KeyRing(BaseModel):
+    """
+    KeyRing
+    """
+
+    created_at: datetime = Field(
+        description="The date and time the creation of the key ring was triggered.", alias="createdAt"
+    )
+    description: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(
+        default=None, description="A user chosen description to distinguish multiple key rings."
+    )
+    display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
+        description="The display name to distinguish multiple key rings.", alias="displayName"
+    )
+    id: StrictStr = Field(description="A auto generated unique id which identifies the key ring.")
+    state: StrictStr = Field(description="The current state of the key ring.")
+    __properties: ClassVar[List[str]] = ["createdAt", "description", "displayName", "id", "state"]
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["active", "deleted"]):
+            raise ValueError("must be one of enum values ('active', 'deleted')")
+        return value
+
+    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 KeyRing 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 KeyRing from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "createdAt": obj.get("createdAt"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "id": obj.get("id"),
+                "state": obj.get("state"),
+            }
+        )
+        return _obj

stackit/kms/models/key_ring_list.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Self
+
+from stackit.kms.models.key_ring import KeyRing
+
+
+class KeyRingList(BaseModel):
+    """
+    KeyRingList
+    """
+
+    key_rings: List[KeyRing] = Field(alias="keyRings")
+    __properties: ClassVar[List[str]] = ["keyRings"]
+
+    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 KeyRingList 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in key_rings (list)
+        _items = []
+        if self.key_rings:
+            for _item in self.key_rings:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["keyRings"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of KeyRingList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "keyRings": (
+                    [KeyRing.from_dict(_item) for _item in obj["keyRings"]] if obj.get("keyRings") is not None else None
+                )
+            }
+        )
+        return _obj

stackit/kms/models/purpose.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+from enum import Enum
+
+from typing_extensions import Self
+
+
+class Purpose(str, Enum):
+    """
+    The purpose of the key.
+    """
+
+    """
+    allowed enum values
+    """
+    SYMMETRIC_ENCRYPT_DECRYPT = "symmetric_encrypt_decrypt"
+    ASYMMETRIC_ENCRYPT_DECRYPT = "asymmetric_encrypt_decrypt"
+    MESSAGE_AUTHENTICATION_CODE = "message_authentication_code"
+    ASYMMETRIC_SIGN_VERIFY = "asymmetric_sign_verify"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Purpose from a JSON string"""
+        return cls(json.loads(json_str))

stackit/kms/models/sign_payload.py

@@ -0,0 +1,81 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBytes, StrictStr
+from typing_extensions import Self
+
+
+class SignPayload(BaseModel):
+    """
+    SignPayload
+    """
+
+    data: Union[StrictBytes, StrictStr] = Field(description="The data that has to be signed. Encoded in base64.")
+    __properties: ClassVar[List[str]] = ["data"]
+
+    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 SignPayload 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 SignPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"data": obj.get("data")})
+        return _obj

stackit/kms/models/signed_data.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBytes, StrictStr
+from typing_extensions import Self
+
+
+class SignedData(BaseModel):
+    """
+    SignedData
+    """
+
+    data: Union[StrictBytes, StrictStr] = Field(description="The data that was signed. Encoded in base64.")
+    signature: Union[StrictBytes, StrictStr] = Field(description="The signature of the data. Encoded in base64.")
+    __properties: ClassVar[List[str]] = ["data", "signature"]
+
+    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 SignedData 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 SignedData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"data": obj.get("data"), "signature": obj.get("signature")})
+        return _obj