stackit-intake 0.1.0__py3-none-any.whl

stackit/intake/models/list_intake_runners_response.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.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, StrictStr
+from typing_extensions import Self
+
+from stackit.intake.models.intake_runner_response import IntakeRunnerResponse
+
+
+class ListIntakeRunnersResponse(BaseModel):
+    """
+    ListIntakeRunnersResponse
+    """  # noqa: E501
+
+    intake_runners: List[IntakeRunnerResponse] = Field(alias="intakeRunners")
+    next_page_token: Optional[StrictStr] = Field(
+        default=None, description="A token to retrieve the next page of results.", alias="nextPageToken"
+    )
+    __properties: ClassVar[List[str]] = ["intakeRunners", "nextPageToken"]
+
+    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 ListIntakeRunnersResponse 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 intake_runners (list)
+        _items = []
+        if self.intake_runners:
+            for _item in self.intake_runners:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["intakeRunners"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ListIntakeRunnersResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "intakeRunners": (
+                    [IntakeRunnerResponse.from_dict(_item) for _item in obj["intakeRunners"]]
+                    if obj.get("intakeRunners") is not None
+                    else None
+                ),
+                "nextPageToken": obj.get("nextPageToken"),
+            }
+        )
+        return _obj

stackit/intake/models/list_intake_users_response.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.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, StrictStr
+from typing_extensions import Self
+
+from stackit.intake.models.intake_user_response import IntakeUserResponse
+
+
+class ListIntakeUsersResponse(BaseModel):
+    """
+    ListIntakeUsersResponse
+    """  # noqa: E501
+
+    intake_users: List[IntakeUserResponse] = Field(alias="intakeUsers")
+    next_page_token: Optional[StrictStr] = Field(
+        default=None, description="A token to retrieve the next page of results.", alias="nextPageToken"
+    )
+    __properties: ClassVar[List[str]] = ["intakeUsers", "nextPageToken"]
+
+    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 ListIntakeUsersResponse 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 intake_users (list)
+        _items = []
+        if self.intake_users:
+            for _item in self.intake_users:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["intakeUsers"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ListIntakeUsersResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "intakeUsers": (
+                    [IntakeUserResponse.from_dict(_item) for _item in obj["intakeUsers"]]
+                    if obj.get("intakeUsers") is not None
+                    else None
+                ),
+                "nextPageToken": obj.get("nextPageToken"),
+            }
+        )
+        return _obj

stackit/intake/models/list_intakes_response.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.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, StrictStr
+from typing_extensions import Self
+
+from stackit.intake.models.intake_response import IntakeResponse
+
+
+class ListIntakesResponse(BaseModel):
+    """
+    ListIntakesResponse
+    """  # noqa: E501
+
+    intakes: List[IntakeResponse]
+    next_page_token: Optional[StrictStr] = Field(
+        default=None, description="A token to retrieve the next page of results.", alias="nextPageToken"
+    )
+    __properties: ClassVar[List[str]] = ["intakes", "nextPageToken"]
+
+    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 ListIntakesResponse 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 intakes (list)
+        _items = []
+        if self.intakes:
+            for _item in self.intakes:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["intakes"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ListIntakesResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "intakes": (
+                    [IntakeResponse.from_dict(_item) for _item in obj["intakes"]]
+                    if obj.get("intakes") is not None
+                    else None
+                ),
+                "nextPageToken": obj.get("nextPageToken"),
+            }
+        )
+        return _obj

stackit/intake/models/update_intake_payload.py

@@ -0,0 +1,115 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.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, StrictStr
+from typing_extensions import Annotated, Self
+
+from stackit.intake.models.intake_catalog_patch import IntakeCatalogPatch
+
+
+class UpdateIntakePayload(BaseModel):
+    """
+    UpdateIntakePayload
+    """  # noqa: E501
+
+    catalog: Optional[IntakeCatalogPatch] = None
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The description is a longer text chosen by the user to provide more context for the resource.",
+    )
+    display_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None,
+        description="The display name is a short name chosen by the user to identify the resource.",
+        alias="displayName",
+    )
+    intake_runner_id: StrictStr = Field(
+        description="The unique id of the intake runner this intake should run on.", alias="intakeRunnerId"
+    )
+    labels: Optional[Dict[str, StrictStr]] = Field(
+        default=None,
+        description="Labels are key-value pairs associated with the resource. To update labels:   - Provide a new set of key-value pairs to replace the existing labels.   - Send empty object `{}` to remove all labels.   - Omit this field to leave the labels unchanged. ",
+    )
+    __properties: ClassVar[List[str]] = ["catalog", "description", "displayName", "intakeRunnerId", "labels"]
+
+    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 UpdateIntakePayload 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 catalog
+        if self.catalog:
+            _dict["catalog"] = self.catalog.to_dict()
+        # set to None if labels (nullable) is None
+        # and model_fields_set contains the field
+        if self.labels is None and "labels" in self.model_fields_set:
+            _dict["labels"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateIntakePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "catalog": IntakeCatalogPatch.from_dict(obj["catalog"]) if obj.get("catalog") is not None else None,
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "intakeRunnerId": obj.get("intakeRunnerId"),
+                "labels": obj.get("labels"),
+            }
+        )
+        return _obj

stackit/intake/models/update_intake_runner_payload.py

@@ -0,0 +1,118 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.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, StrictInt, StrictStr
+from typing_extensions import Annotated, Self
+
+
+class UpdateIntakeRunnerPayload(BaseModel):
+    """
+    UpdateIntakeRunnerPayload
+    """  # noqa: E501
+
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The description is a longer text chosen by the user to provide more context for the resource.",
+    )
+    display_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None,
+        description="The display name is a short name chosen by the user to identify the resource.",
+        alias="displayName",
+    )
+    labels: Optional[Dict[str, StrictStr]] = Field(
+        default=None,
+        description="Labels are key-value pairs associated with the resource. To update labels:   - Provide a new set of key-value pairs to replace the existing labels.   - Send empty object `{}` to remove all labels.   - Omit this field to leave the labels unchanged. ",
+    )
+    max_message_size_ki_b: StrictInt = Field(
+        description="The maximum size of a message in kibibytes (1 KiB = 1024 bytes).", alias="maxMessageSizeKiB"
+    )
+    max_messages_per_hour: StrictInt = Field(
+        description="The maximum number of messages per hour.", alias="maxMessagesPerHour"
+    )
+    __properties: ClassVar[List[str]] = [
+        "description",
+        "displayName",
+        "labels",
+        "maxMessageSizeKiB",
+        "maxMessagesPerHour",
+    ]
+
+    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 UpdateIntakeRunnerPayload 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,
+        )
+        # set to None if labels (nullable) is None
+        # and model_fields_set contains the field
+        if self.labels is None and "labels" in self.model_fields_set:
+            _dict["labels"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateIntakeRunnerPayload 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"),
+                "displayName": obj.get("displayName"),
+                "labels": obj.get("labels"),
+                "maxMessageSizeKiB": obj.get("maxMessageSizeKiB"),
+                "maxMessagesPerHour": obj.get("maxMessagesPerHour"),
+            }
+        )
+        return _obj

stackit/intake/models/update_intake_user_payload.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.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, StrictStr
+from typing_extensions import Annotated, Self
+
+from stackit.intake.models.user_type import UserType
+
+
+class UpdateIntakeUserPayload(BaseModel):
+    """
+    UpdateIntakeUserPayload
+    """  # noqa: E501
+
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The description is a longer text chosen by the user to provide more context for the resource.",
+    )
+    display_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None,
+        description="The display name is a short name chosen by the user to identify the resource.",
+        alias="displayName",
+    )
+    labels: Optional[Dict[str, StrictStr]] = Field(
+        default=None,
+        description="Labels are key-value pairs associated with the resource. To update labels:   - Provide a new set of key-value pairs to replace the existing labels.   - Send empty object `{}` to remove all labels.   - Omit this field to leave the labels unchanged. ",
+    )
+    password: Optional[Annotated[str, Field(strict=True, max_length=128)]] = Field(
+        default=None, description="A password chosen by the user."
+    )
+    type: Optional[UserType] = UserType.INTAKE
+    __properties: ClassVar[List[str]] = ["description", "displayName", "labels", "password", "type"]
+
+    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 UpdateIntakeUserPayload 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,
+        )
+        # set to None if labels (nullable) is None
+        # and model_fields_set contains the field
+        if self.labels is None and "labels" in self.model_fields_set:
+            _dict["labels"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateIntakeUserPayload 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"),
+                "displayName": obj.get("displayName"),
+                "labels": obj.get("labels"),
+                "password": obj.get("password"),
+                "type": obj.get("type") if obj.get("type") is not None else UserType.INTAKE,
+            }
+        )
+        return _obj

stackit/intake/models/user_type.py

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+from enum import Enum
+
+from typing_extensions import Self
+
+
+class UserType(str, Enum):
+    """
+    Type of user, 'intake' allows writing to the Intake, 'dead-letter' allows reading from the dead-letter queue
+    """
+
+    """
+    allowed enum values
+    """
+    INTAKE = "intake"
+    DEAD_MINUS_LETTER = "dead-letter"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of UserType from a JSON string"""
+        return cls(json.loads(json_str))