stackit-authorization 0.0.1a0__py3-none-any.whl

stackit/authorization/models/permission.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    STACKIT Membership API
+
+    The Membership API is used to manage memberships, roles and permissions of STACKIT resources, like projects, folders, organizations and other resources.
+
+    The version of the OpenAPI document: 2.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
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from typing_extensions import Annotated, Self
+
+
+class Permission(BaseModel):
+    """
+    Permission
+    """
+
+    description: Annotated[str, Field(min_length=1, strict=True, max_length=255)]
+    name: Annotated[str, Field(strict=True, max_length=255)]
+    __properties: ClassVar[List[str]] = ["description", "name"]
+
+    @field_validator("name")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z](?:-?\.?[a-z]){1,63}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z](?:-?\.?[a-z]){1,63}$/")
+        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 Permission 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 Permission from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"description": obj.get("description"), "name": obj.get("name")})
+        return _obj

stackit/authorization/models/remove_members_payload.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    STACKIT Membership API
+
+    The Membership API is used to manage memberships, roles and permissions of STACKIT resources, like projects, folders, organizations and other resources.
+
+    The version of the OpenAPI document: 2.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
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.authorization.models.member import Member
+
+
+class RemoveMembersPayload(BaseModel):
+    """
+    RemoveMembersPayload
+    """
+
+    force_remove: Optional[StrictBool] = Field(default=None, alias="forceRemove")
+    members: List[Member]
+    resource_type: Annotated[str, Field(strict=True)] = Field(alias="resourceType")
+    __properties: ClassVar[List[str]] = ["forceRemove", "members", "resourceType"]
+
+    @field_validator("resource_type")
+    def resource_type_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z](?:-?[a-z]){1,63}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z](?:-?[a-z]){1,63}$/")
+        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 RemoveMembersPayload 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 members (list)
+        _items = []
+        if self.members:
+            for _item in self.members:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["members"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RemoveMembersPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "forceRemove": obj.get("forceRemove"),
+                "members": (
+                    [Member.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None
+                ),
+                "resourceType": obj.get("resourceType"),
+            }
+        )
+        return _obj

stackit/authorization/models/role.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    STACKIT Membership API
+
+    The Membership API is used to manage memberships, roles and permissions of STACKIT resources, like projects, folders, organizations and other resources.
+
+    The version of the OpenAPI document: 2.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
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.authorization.models.permission import Permission
+
+
+class Role(BaseModel):
+    """
+    Role
+    """
+
+    description: Annotated[str, Field(strict=True, max_length=255)]
+    id: Optional[Annotated[str, Field(strict=True)]] = None
+    name: Annotated[str, Field(strict=True)]
+    permissions: List[Permission]
+    __properties: ClassVar[List[str]] = ["description", "id", "name", "permissions"]
+
+    @field_validator("id")
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^([a-zA-Z0-9\/_|\-=+]{1,})$", value):
+            raise ValueError(r"must validate the regular expression /^([a-zA-Z0-9\/_|\-=+]{1,})$/")
+        return value
+
+    @field_validator("name")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z](?:-?\.?[a-z]){1,63}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z](?:-?\.?[a-z]){1,63}$/")
+        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 Role 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 permissions (list)
+        _items = []
+        if self.permissions:
+            for _item in self.permissions:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["permissions"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Role from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "description": obj.get("description"),
+                "id": obj.get("id"),
+                "name": obj.get("name"),
+                "permissions": (
+                    [Permission.from_dict(_item) for _item in obj["permissions"]]
+                    if obj.get("permissions") is not None
+                    else None
+                ),
+            }
+        )
+        return _obj

stackit/authorization/models/roles_response.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    STACKIT Membership API
+
+    The Membership API is used to manage memberships, roles and permissions of STACKIT resources, like projects, folders, organizations and other resources.
+
+    The version of the OpenAPI document: 2.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
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.authorization.models.role import Role
+
+
+class RolesResponse(BaseModel):
+    """
+    RolesResponse
+    """
+
+    resource_id: Annotated[str, Field(strict=True)] = Field(alias="resourceId")
+    resource_type: Annotated[str, Field(strict=True)] = Field(alias="resourceType")
+    roles: List[Role]
+    __properties: ClassVar[List[str]] = ["resourceId", "resourceType", "roles"]
+
+    @field_validator("resource_id")
+    def resource_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^([a-zA-Z0-9\/_|\-=+@.]{1,})$", value):
+            raise ValueError(r"must validate the regular expression /^([a-zA-Z0-9\/_|\-=+@.]{1,})$/")
+        return value
+
+    @field_validator("resource_type")
+    def resource_type_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z](?:-?[a-z]){1,63}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z](?:-?[a-z]){1,63}$/")
+        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 RolesResponse 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 roles (list)
+        _items = []
+        if self.roles:
+            for _item in self.roles:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["roles"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RolesResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "resourceId": obj.get("resourceId"),
+                "resourceType": obj.get("resourceType"),
+                "roles": [Role.from_dict(_item) for _item in obj["roles"]] if obj.get("roles") is not None else None,
+            }
+        )
+        return _obj

stackit/authorization/models/user_membership.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    STACKIT Membership API
+
+    The Membership API is used to manage memberships, roles and permissions of STACKIT resources, like projects, folders, organizations and other resources.
+
+    The version of the OpenAPI document: 2.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
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from typing_extensions import Annotated, Self
+
+
+class UserMembership(BaseModel):
+    """
+    UserMembership
+    """
+
+    resource_id: Annotated[str, Field(strict=True)] = Field(alias="resourceId")
+    resource_type: Annotated[str, Field(strict=True)] = Field(alias="resourceType")
+    role: Annotated[str, Field(strict=True)]
+    subject: Annotated[str, Field(strict=True, max_length=255)]
+    __properties: ClassVar[List[str]] = ["resourceId", "resourceType", "role", "subject"]
+
+    @field_validator("resource_id")
+    def resource_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^([a-zA-Z0-9\/_|\-=+@.]{1,})$", value):
+            raise ValueError(r"must validate the regular expression /^([a-zA-Z0-9\/_|\-=+@.]{1,})$/")
+        return value
+
+    @field_validator("resource_type")
+    def resource_type_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z](?:-?[a-z]){1,63}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z](?:-?[a-z]){1,63}$/")
+        return value
+
+    @field_validator("role")
+    def role_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z](?:-?\.?[a-z]){1,63}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z](?:-?\.?[a-z]){1,63}$/")
+        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 UserMembership 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 UserMembership from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "resourceId": obj.get("resourceId"),
+                "resourceType": obj.get("resourceType"),
+                "role": obj.get("role"),
+                "subject": obj.get("subject"),
+            }
+        )
+        return _obj

stackit/authorization/models/user_permission.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    STACKIT Membership API
+
+    The Membership API is used to manage memberships, roles and permissions of STACKIT resources, like projects, folders, organizations and other resources.
+
+    The version of the OpenAPI document: 2.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
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.authorization.models.existing_permission import ExistingPermission
+
+
+class UserPermission(BaseModel):
+    """
+    UserPermission
+    """
+
+    permissions: List[ExistingPermission]
+    resource_id: Annotated[str, Field(strict=True)] = Field(alias="resourceId")
+    resource_type: Annotated[str, Field(strict=True)] = Field(alias="resourceType")
+    __properties: ClassVar[List[str]] = ["permissions", "resourceId", "resourceType"]
+
+    @field_validator("resource_id")
+    def resource_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^([a-zA-Z0-9\/_|\-=+@.]{1,})$", value):
+            raise ValueError(r"must validate the regular expression /^([a-zA-Z0-9\/_|\-=+@.]{1,})$/")
+        return value
+
+    @field_validator("resource_type")
+    def resource_type_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z](?:-?[a-z]){1,63}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z](?:-?[a-z]){1,63}$/")
+        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 UserPermission 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 permissions (list)
+        _items = []
+        if self.permissions:
+            for _item in self.permissions:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["permissions"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserPermission from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "permissions": (
+                    [ExistingPermission.from_dict(_item) for _item in obj["permissions"]]
+                    if obj.get("permissions") is not None
+                    else None
+                ),
+                "resourceId": obj.get("resourceId"),
+                "resourceType": obj.get("resourceType"),
+            }
+        )
+        return _obj