stackit-auditlog 0.1.0__py3-none-any.whl

stackit/auditlog/models/audit_log_entry_response.py

@@ -0,0 +1,239 @@
+# coding: utf-8
+
+"""
+    Audit Log API
+
+    API Endpoints to retrieve recorded actions and resulting changes in the system.  ### Documentation The user documentation with explanations how to use the api can be found  [here](https://docs.stackit.cloud/stackit/en/retrieve-audit-log-per-api-request-134415907.html).  ### Audit Logging Changes on organizations, folders and projects and respective cloud resources are logged and collected in the audit  log.  ### API Constraints The audit log API allows to download messages from the last 90 days. The maximum duration that can be queried at  once is 24 hours. Requests are rate limited - the current maximum is 60 requests per minute.
+
+    The version of the OpenAPI document: 2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+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
+
+from stackit.auditlog.models.audit_log_entry_context_response import (
+    AuditLogEntryContextResponse,
+)
+from stackit.auditlog.models.audit_log_entry_initiator_response import (
+    AuditLogEntryInitiatorResponse,
+)
+from stackit.auditlog.models.audit_log_entry_request_response import (
+    AuditLogEntryRequestResponse,
+)
+from stackit.auditlog.models.audit_log_entry_service_account_delegation_info_response import (
+    AuditLogEntryServiceAccountDelegationInfoResponse,
+)
+
+
+class AuditLogEntryResponse(BaseModel):
+    """
+    AuditLogEntryResponse
+    """  # noqa: E501
+
+    context: Optional[AuditLogEntryContextResponse] = None
+    correlation_id: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=255)]] = Field(
+        default=None,
+        description="Unique ID which identifies the request from the sender point of view.",
+        alias="correlationId",
+    )
+    details: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="Additional information about the event that is not part of the request or response. May contain arbitrary data.",
+    )
+    event_name: Annotated[str, Field(min_length=1, strict=True, max_length=255)] = Field(
+        description="Name of the operation this event represents.", alias="eventName"
+    )
+    event_source: StrictStr = Field(
+        description="The service in which the causing event was handled.", alias="eventSource"
+    )
+    event_time_stamp: datetime = Field(
+        description="Timestamp at which the event was triggered.", alias="eventTimeStamp"
+    )
+    event_type: StrictStr = Field(
+        description='Type that can be assigned to the event. For example, an event "Organization created" can be assigned to the type ADMIN_EVENT',
+        alias="eventType",
+    )
+    event_version: StrictStr = Field(description="Version of the log event format.", alias="eventVersion")
+    id: StrictStr = Field(description="Unique ID generated by the audit log.")
+    initiator: AuditLogEntryInitiatorResponse
+    received_time_stamp: datetime = Field(
+        description="Timestamp at which the event was received by the audit log.", alias="receivedTimeStamp"
+    )
+    region: StrictStr = Field(description="Region from which the event has been emitted.")
+    request: AuditLogEntryRequestResponse
+    resource_id: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=255)]] = Field(
+        default=None, description="Unique id of the resource that is target of the operation", alias="resourceId"
+    )
+    resource_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=255)]] = Field(
+        default=None, description="Name of the resource that is target of the operation", alias="resourceName"
+    )
+    result: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="Object representing the change resulting from this event. May be omitted if no change has been applied. May contain arbitrary data.",
+    )
+    service_account_delegation_info: Optional[AuditLogEntryServiceAccountDelegationInfoResponse] = Field(
+        default=None, alias="serviceAccountDelegationInfo"
+    )
+    severity: StrictStr = Field(description="The severity of this request.")
+    source_ip_address: StrictStr = Field(
+        description="IP address that the request was made from", alias="sourceIpAddress"
+    )
+    user_agent: Annotated[str, Field(min_length=1, strict=True, max_length=255)] = Field(
+        description="Agent through which the request was made from (e.g. Portal, CLI, SDK, ...) ", alias="userAgent"
+    )
+    visibility: StrictStr = Field(
+        description="PUBLIC for entries that are intended for end users, while PRIVATE entries can only be viewed with system privileges."
+    )
+    __properties: ClassVar[List[str]] = [
+        "context",
+        "correlationId",
+        "details",
+        "eventName",
+        "eventSource",
+        "eventTimeStamp",
+        "eventType",
+        "eventVersion",
+        "id",
+        "initiator",
+        "receivedTimeStamp",
+        "region",
+        "request",
+        "resourceId",
+        "resourceName",
+        "result",
+        "serviceAccountDelegationInfo",
+        "severity",
+        "sourceIpAddress",
+        "userAgent",
+        "visibility",
+    ]
+
+    @field_validator("event_type")
+    def event_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ADMIN_ACTIVITY", "SYSTEM_EVENT", "POLICY_DENIED"]):
+            raise ValueError("must be one of enum values ('ADMIN_ACTIVITY', 'SYSTEM_EVENT', 'POLICY_DENIED')")
+        return value
+
+    @field_validator("severity")
+    def severity_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["INFO", "ERROR"]):
+            raise ValueError("must be one of enum values ('INFO', 'ERROR')")
+        return value
+
+    @field_validator("visibility")
+    def visibility_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["PUBLIC", "PRIVATE"]):
+            raise ValueError("must be one of enum values ('PUBLIC', 'PRIVATE')")
+        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 AuditLogEntryResponse 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 context
+        if self.context:
+            _dict["context"] = self.context.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of initiator
+        if self.initiator:
+            _dict["initiator"] = self.initiator.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of request
+        if self.request:
+            _dict["request"] = self.request.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of service_account_delegation_info
+        if self.service_account_delegation_info:
+            _dict["serviceAccountDelegationInfo"] = self.service_account_delegation_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AuditLogEntryResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "context": (
+                    AuditLogEntryContextResponse.from_dict(obj["context"]) if obj.get("context") is not None else None
+                ),
+                "correlationId": obj.get("correlationId"),
+                "details": obj.get("details"),
+                "eventName": obj.get("eventName"),
+                "eventSource": obj.get("eventSource"),
+                "eventTimeStamp": obj.get("eventTimeStamp"),
+                "eventType": obj.get("eventType"),
+                "eventVersion": obj.get("eventVersion"),
+                "id": obj.get("id"),
+                "initiator": (
+                    AuditLogEntryInitiatorResponse.from_dict(obj["initiator"])
+                    if obj.get("initiator") is not None
+                    else None
+                ),
+                "receivedTimeStamp": obj.get("receivedTimeStamp"),
+                "region": obj.get("region"),
+                "request": (
+                    AuditLogEntryRequestResponse.from_dict(obj["request"]) if obj.get("request") is not None else None
+                ),
+                "resourceId": obj.get("resourceId"),
+                "resourceName": obj.get("resourceName"),
+                "result": obj.get("result"),
+                "serviceAccountDelegationInfo": (
+                    AuditLogEntryServiceAccountDelegationInfoResponse.from_dict(obj["serviceAccountDelegationInfo"])
+                    if obj.get("serviceAccountDelegationInfo") is not None
+                    else None
+                ),
+                "severity": obj.get("severity"),
+                "sourceIpAddress": obj.get("sourceIpAddress"),
+                "userAgent": obj.get("userAgent"),
+                "visibility": obj.get("visibility"),
+            }
+        )
+        return _obj

stackit/auditlog/models/audit_log_entry_service_account_delegation_info_response.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Audit Log API
+
+    API Endpoints to retrieve recorded actions and resulting changes in the system.  ### Documentation The user documentation with explanations how to use the api can be found  [here](https://docs.stackit.cloud/stackit/en/retrieve-audit-log-per-api-request-134415907.html).  ### Audit Logging Changes on organizations, folders and projects and respective cloud resources are logged and collected in the audit  log.  ### API Constraints The audit log API allows to download messages from the last 90 days. The maximum duration that can be queried at  once is 24 hours. Requests are rate limited - the current maximum is 60 requests per minute.
+
+    The version of the OpenAPI document: 2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+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.auditlog.models.service_account_delegation_info_principal_response import (
+    ServiceAccountDelegationInfoPrincipalResponse,
+)
+
+
+class AuditLogEntryServiceAccountDelegationInfoResponse(BaseModel):
+    """
+    Information about service account delegation
+    """  # noqa: E501
+
+    principals: List[ServiceAccountDelegationInfoPrincipalResponse] = Field(
+        description="Delegation chain for the service account"
+    )
+    __properties: ClassVar[List[str]] = ["principals"]
+
+    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 AuditLogEntryServiceAccountDelegationInfoResponse 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 principals (list)
+        _items = []
+        if self.principals:
+            for _item in self.principals:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["principals"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AuditLogEntryServiceAccountDelegationInfoResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "principals": (
+                    [ServiceAccountDelegationInfoPrincipalResponse.from_dict(_item) for _item in obj["principals"]]
+                    if obj.get("principals") is not None
+                    else None
+                )
+            }
+        )
+        return _obj

stackit/auditlog/models/error_response.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Audit Log API
+
+    API Endpoints to retrieve recorded actions and resulting changes in the system.  ### Documentation The user documentation with explanations how to use the api can be found  [here](https://docs.stackit.cloud/stackit/en/retrieve-audit-log-per-api-request-134415907.html).  ### Audit Logging Changes on organizations, folders and projects and respective cloud resources are logged and collected in the audit  log.  ### API Constraints The audit log API allows to download messages from the last 90 days. The maximum duration that can be queried at  once is 24 hours. Requests are rate limited - the current maximum is 60 requests per minute.
+
+    The version of the OpenAPI document: 2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing_extensions import Self
+
+
+class ErrorResponse(BaseModel):
+    """
+    ErrorResponse
+    """  # noqa: E501
+
+    message: Optional[StrictStr] = Field(default=None, description="Description of the error.")
+    path: Optional[StrictStr] = Field(default=None, description="Path which was called.")
+    status: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Http status code.")
+    timestamp: Optional[datetime] = Field(default=None, description="Timestamp at which the error occurred.")
+    __properties: ClassVar[List[str]] = ["message", "path", "status", "timestamp"]
+
+    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 ErrorResponse 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 ErrorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "message": obj.get("message"),
+                "path": obj.get("path"),
+                "status": obj.get("status"),
+                "timestamp": obj.get("timestamp"),
+            }
+        )
+        return _obj

stackit/auditlog/models/gateway_error_response.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    Audit Log API
+
+    API Endpoints to retrieve recorded actions and resulting changes in the system.  ### Documentation The user documentation with explanations how to use the api can be found  [here](https://docs.stackit.cloud/stackit/en/retrieve-audit-log-per-api-request-134415907.html).  ### Audit Logging Changes on organizations, folders and projects and respective cloud resources are logged and collected in the audit  log.  ### API Constraints The audit log API allows to download messages from the last 90 days. The maximum duration that can be queried at  once is 24 hours. Requests are rate limited - the current maximum is 60 requests per minute.
+
+    The version of the OpenAPI document: 2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing_extensions import Self
+
+
+class GatewayErrorResponse(BaseModel):
+    """
+    GatewayErrorResponse
+    """  # noqa: E501
+
+    message: Optional[StrictStr] = Field(default=None, description="Description of the error.")
+    status: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Http status code.")
+    __properties: ClassVar[List[str]] = ["message", "status"]
+
+    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 GatewayErrorResponse 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 GatewayErrorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"message": obj.get("message"), "status": obj.get("status")})
+        return _obj

stackit/auditlog/models/list_audit_log_entries_response.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    Audit Log API
+
+    API Endpoints to retrieve recorded actions and resulting changes in the system.  ### Documentation The user documentation with explanations how to use the api can be found  [here](https://docs.stackit.cloud/stackit/en/retrieve-audit-log-per-api-request-134415907.html).  ### Audit Logging Changes on organizations, folders and projects and respective cloud resources are logged and collected in the audit  log.  ### API Constraints The audit log API allows to download messages from the last 90 days. The maximum duration that can be queried at  once is 24 hours. Requests are rate limited - the current maximum is 60 requests per minute.
+
+    The version of the OpenAPI document: 2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing_extensions import Self
+
+from stackit.auditlog.models.audit_log_entry_response import AuditLogEntryResponse
+
+
+class ListAuditLogEntriesResponse(BaseModel):
+    """
+    ListAuditLogEntriesResponse
+    """  # noqa: E501
+
+    cursor: Optional[StrictStr] = Field(default=None, description="Optional cursor if more entries are available")
+    items: Optional[List[AuditLogEntryResponse]] = None
+    limit: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=50, description="Maximum amount of entries requested."
+    )
+    __properties: ClassVar[List[str]] = ["cursor", "items", "limit"]
+
+    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 ListAuditLogEntriesResponse 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 items (list)
+        _items = []
+        if self.items:
+            for _item in self.items:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["items"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ListAuditLogEntriesResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "cursor": obj.get("cursor"),
+                "items": (
+                    [AuditLogEntryResponse.from_dict(_item) for _item in obj["items"]]
+                    if obj.get("items") is not None
+                    else None
+                ),
+                "limit": obj.get("limit") if obj.get("limit") is not None else 50,
+            }
+        )
+        return _obj