stackit-runcommand 0.0.1a0__py3-none-any.whl

stackit/runcommand/models/command_template_schema.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    STACKIT Run Commands Service API
+
+    API endpoints for the STACKIT Run Commands Service API
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    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, StrictStr
+from typing_extensions import Self
+
+from stackit.runcommand.models.parameters_schema import ParametersSchema
+
+
+class CommandTemplateSchema(BaseModel):
+    """
+    CommandTemplateSchema
+    """
+
+    description: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    os_type: Optional[List[StrictStr]] = Field(default=None, alias="osType")
+    parameter_schema: Optional[ParametersSchema] = Field(default=None, alias="parameterSchema")
+    title: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["description", "name", "osType", "parameterSchema", "title"]
+
+    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 CommandTemplateSchema 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 parameter_schema
+        if self.parameter_schema:
+            _dict["parameterSchema"] = self.parameter_schema.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CommandTemplateSchema 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"),
+                "osType": obj.get("osType"),
+                "parameterSchema": (
+                    ParametersSchema.from_dict(obj["parameterSchema"])
+                    if obj.get("parameterSchema") is not None
+                    else None
+                ),
+                "title": obj.get("title"),
+            }
+        )
+        return _obj

stackit/runcommand/models/commands.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    STACKIT Run Commands Service API
+
+    API endpoints for the STACKIT Run Commands Service API
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    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, StrictInt, StrictStr, field_validator
+from typing_extensions import Self
+
+
+class Commands(BaseModel):
+    """
+    Commands
+    """
+
+    command_template_name: Optional[StrictStr] = Field(default=None, alias="commandTemplateName")
+    command_template_title: Optional[StrictStr] = Field(default=None, alias="commandTemplateTitle")
+    finished_at: Optional[StrictStr] = Field(default=None, alias="finishedAt")
+    id: Optional[StrictInt] = None
+    started_at: Optional[StrictStr] = Field(default=None, alias="startedAt")
+    status: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = [
+        "commandTemplateName",
+        "commandTemplateTitle",
+        "finishedAt",
+        "id",
+        "startedAt",
+        "status",
+    ]
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["pending", "running", "completed", "failed"]):
+            raise ValueError("must be one of enum values ('pending', 'running', 'completed', 'failed')")
+        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 Commands 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 Commands from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "commandTemplateName": obj.get("commandTemplateName"),
+                "commandTemplateTitle": obj.get("commandTemplateTitle"),
+                "finishedAt": obj.get("finishedAt"),
+                "id": obj.get("id"),
+                "startedAt": obj.get("startedAt"),
+                "status": obj.get("status"),
+            }
+        )
+        return _obj

stackit/runcommand/models/create_command_payload.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+"""
+    STACKIT Run Commands Service API
+
+    API endpoints for the STACKIT Run Commands Service API
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    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, StrictStr
+from typing_extensions import Self
+
+
+class CreateCommandPayload(BaseModel):
+    """
+    CreateCommandPayload
+    """
+
+    command_template_name: StrictStr = Field(alias="commandTemplateName")
+    parameters: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["commandTemplateName", "parameters"]
+
+    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 CreateCommandPayload 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 CreateCommandPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"commandTemplateName": obj.get("commandTemplateName"), "parameters": obj.get("parameters")}
+        )
+        return _obj

stackit/runcommand/models/error_response.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+"""
+    STACKIT Run Commands Service API
+
+    API endpoints for the STACKIT Run Commands Service API
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    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, StrictStr
+from typing_extensions import Self
+
+
+class ErrorResponse(BaseModel):
+    """
+    ErrorResponse
+    """
+
+    message: StrictStr = Field(description="Details about the error")
+    status: StrictStr = Field(
+        description="The string representation of the http status code (i.e. Not Found, Bad Request, etc)"
+    )
+    __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 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"), "status": obj.get("status")})
+        return _obj

stackit/runcommand/models/get_commands_response.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    STACKIT Run Commands Service API
+
+    API endpoints for the STACKIT Run Commands Service API
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    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.runcommand.models.commands import Commands
+
+
+class GetCommandsResponse(BaseModel):
+    """
+    GetCommandsResponse
+    """
+
+    items: Optional[List[Commands]] = None
+    __properties: ClassVar[List[str]] = ["items"]
+
+    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 GetCommandsResponse 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 GetCommandsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"items": [Commands.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None}
+        )
+        return _obj

stackit/runcommand/models/model_field.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    STACKIT Run Commands Service API
+
+    API endpoints for the STACKIT Run Commands Service API
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    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, StrictBool, StrictInt, StrictStr
+from typing_extensions import Self
+
+
+class ModelField(BaseModel):
+    """
+    ModelField
+    """
+
+    default: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    max_len: Optional[StrictInt] = Field(default=None, alias="maxLen")
+    min_len: Optional[StrictInt] = Field(default=None, alias="minLen")
+    read_only: Optional[StrictBool] = Field(default=None, alias="readOnly")
+    title: Optional[StrictStr] = None
+    type: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["default", "description", "maxLen", "minLen", "readOnly", "title", "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 ModelField 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 ModelField from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "default": obj.get("default"),
+                "description": obj.get("description"),
+                "maxLen": obj.get("maxLen"),
+                "minLen": obj.get("minLen"),
+                "readOnly": obj.get("readOnly"),
+                "title": obj.get("title"),
+                "type": obj.get("type"),
+            }
+        )
+        return _obj

stackit/runcommand/models/new_command_response.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    STACKIT Run Commands Service API
+
+    API endpoints for the STACKIT Run Commands Service API
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    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, StrictInt
+from typing_extensions import Self
+
+
+class NewCommandResponse(BaseModel):
+    """
+    NewCommandResponse
+    """
+
+    id: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["id"]
+
+    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 NewCommandResponse 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 NewCommandResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"id": obj.get("id")})
+        return _obj