stackit-runcommand 0.0.1a0__py3-none-any.whl

stackit/runcommand/models/parameters_schema.py

@@ -0,0 +1,89 @@
+# 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.properties import Properties
+
+
+class ParametersSchema(BaseModel):
+    """
+    ParametersSchema
+    """
+
+    properties: Optional[Properties] = None
+    __properties: ClassVar[List[str]] = ["properties"]
+
+    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 ParametersSchema 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 properties
+        if self.properties:
+            _dict["properties"] = self.properties.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ParametersSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"properties": Properties.from_dict(obj["properties"]) if obj.get("properties") is not None else None}
+        )
+        return _obj

stackit/runcommand/models/properties.py

@@ -0,0 +1,112 @@
+# 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.model_field import ModelField
+
+
+class Properties(BaseModel):
+    """
+    Properties
+    """
+
+    confirm_password: Optional[ModelField] = Field(default=None, alias="ConfirmPassword")
+    password: Optional[ModelField] = Field(default=None, alias="Password")
+    script: Optional[ModelField] = Field(default=None, alias="Script")
+    username: Optional[ModelField] = Field(default=None, alias="Username")
+    required: Optional[List[StrictStr]] = None
+    type: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["ConfirmPassword", "Password", "Script", "Username", "required", "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 Properties 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 confirm_password
+        if self.confirm_password:
+            _dict["ConfirmPassword"] = self.confirm_password.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of password
+        if self.password:
+            _dict["Password"] = self.password.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of script
+        if self.script:
+            _dict["Script"] = self.script.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of username
+        if self.username:
+            _dict["Username"] = self.username.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Properties from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "ConfirmPassword": (
+                    ModelField.from_dict(obj["ConfirmPassword"]) if obj.get("ConfirmPassword") is not None else None
+                ),
+                "Password": ModelField.from_dict(obj["Password"]) if obj.get("Password") is not None else None,
+                "Script": ModelField.from_dict(obj["Script"]) if obj.get("Script") is not None else None,
+                "Username": ModelField.from_dict(obj["Username"]) if obj.get("Username") is not None else None,
+                "required": obj.get("required"),
+                "type": obj.get("type"),
+            }
+        )
+        return _obj

stackit/runcommand/rest.py

@@ -0,0 +1,149 @@
+# 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
+
+import io
+import json
+import re
+
+import requests
+from stackit.core.authorization import Authorization
+from stackit.core.configuration import Configuration
+
+from stackit.runcommand.exceptions import ApiException, ApiValueError
+
+
+RESTResponseType = requests.Response
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status_code
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.content
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+    def __init__(self, config: Configuration) -> None:
+        self.session = config.custom_http_session if config.custom_http_session else requests.Session()
+        authorization = Authorization(config)
+        self.session.auth = authorization.auth_method
+
+    def request(self, method, url, headers=None, body=None, post_params=None, _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        if method not in ["GET", "HEAD", "DELETE", "POST", "PUT", "PATCH", "OPTIONS"]:
+            raise ValueError("Method %s not allowed", method)
+
+        if post_params and body:
+            raise ApiValueError("body parameter cannot be used with post_params parameter.")
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
+
+                # no content type provided or payload is json
+                content_type = headers.get("Content-Type")
+                if not content_type or re.search("json", content_type, re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                    )
+                elif content_type == "application/x-www-form-urlencoded":
+                    r = self.session.request(
+                        method,
+                        url,
+                        params=post_params,
+                        headers=headers,
+                    )
+                elif content_type == "multipart/form-data":
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers["Content-Type"]
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a, b) for a, b in post_params]
+                    r = self.session.request(
+                        method,
+                        url,
+                        files=post_params,
+                        headers=headers,
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=body,
+                        headers=headers,
+                    )
+                elif headers["Content-Type"] == "text/plain" and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.session.request(method, url, data=request_body, headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.session.request(
+                    method,
+                    url,
+                    params={},
+                    headers=headers,
+                )
+        except requests.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

stackit_runcommand-0.0.1a0.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: stackit-runcommand
+Version: 0.0.1a0
+Summary: STACKIT Run Commands Service API
+Author: STACKIT Developer Tools
+Author-email: developer-tools@stackit.cloud
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pydantic (>=2.9.2)
+Requires-Dist: python-dateutil (>=2.9.0.post0)
+Requires-Dist: requests (>=2.32.3)
+Requires-Dist: stackit-core (>=0.0.1a)
+Description-Content-Type: text/markdown
+
+# stackit.runcommand
+API endpoints for the STACKIT Run Commands Service API
+
+
+This package is part of the STACKIT Python SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.
+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install stackit-runcommand
+```
+
+Then import the package:
+```python
+import stackit.runcommand
+```
+
+## Getting Started
+
+[Examples](https://github.com/stackitcloud/stackit-sdk-python/tree/main/examples) for the usage of the package can be found in the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.

stackit_runcommand-0.0.1a0.dist-info/RECORD

@@ -0,0 +1,25 @@
+stackit/runcommand/__init__.py,sha256=OF8dCJm8dLHGxj-_IANtFbaseL0ufOyV2fDBmv7x4po,1734
+stackit/runcommand/api/__init__.py,sha256=O-WDFpOgx6B55T02W-JUoG02zuSKFHZcszlw16eLV04,105
+stackit/runcommand/api/default_api.py,sha256=r-VaNCCLnH2_HrOI9-fNPELkFswyADbkPUDKOivEr24,58467
+stackit/runcommand/api_client.py,sha256=_NA5aYHQ0WNSDuFBMP1GdY97DiYuRNPj6F-sUYP6yUg,22729
+stackit/runcommand/api_response.py,sha256=HRYkVqMNIlfODacTQPTbiVj2YdcnutpQrKJdeAoCSpM,642
+stackit/runcommand/configuration.py,sha256=gqWKibB_vkiGmBSAQ7Nu8gpnAHWrSHLIa9swAQ36hyI,3861
+stackit/runcommand/exceptions.py,sha256=lGPHNHUnPFhdXVi0w8gdSM1UUYRqOQM4OCWwA1B50Qc,5952
+stackit/runcommand/models/__init__.py,sha256=-HIBaDzfhB2RBWD4B3L16Ft-k5dm2lTHXA80H3et5j4,1268
+stackit/runcommand/models/command_details.py,sha256=fYVMOKVxDXduObQ2TXIo9jvAjQ24FRflAWddkaXga5c,4047
+stackit/runcommand/models/command_template.py,sha256=Pxz1U0PQ6vG0rYTGXX8GSaewBVnJIwNyDlRnsAjgDrI,2634
+stackit/runcommand/models/command_template_response.py,sha256=3QQaqRUW0bAUHfb8WJnR0YhVxxwCo44vj_v73ihe3YQ,3061
+stackit/runcommand/models/command_template_schema.py,sha256=SXkQBGWYVWpND_nclXqYFbBI4gPQjfZfildp6uXFxpE,3465
+stackit/runcommand/models/commands.py,sha256=Fl_X9djiI3TvEEOEpU8VcVbThQ9H9I5Ud4RRpSKKRtU,3675
+stackit/runcommand/models/create_command_payload.py,sha256=83bzNAnkKufKqa7wLLIZCIVUBZtPemtRsxeJvXSN0m4,2673
+stackit/runcommand/models/error_response.py,sha256=3GkbqbG7PE7KDjFNpaIXcAKueJbwkrAlkZnhJCOkzx8,2661
+stackit/runcommand/models/get_commands_response.py,sha256=skVJu0vEdU1QrVsmuDopjKqeAhewFeWxDZcMIpKPCqU,2906
+stackit/runcommand/models/model_field.py,sha256=Gt9hG0_XWgZP8M94Jw17Hxi80kPYRT8TwXYXJybimRE,3191
+stackit/runcommand/models/new_command_response.py,sha256=mH3ocI-svEGqt19p2Q4gMtcw4LI5pvmTmZQNNmCxE78,2441
+stackit/runcommand/models/parameters_schema.py,sha256=N1xmtLZ3kUceZKkdO1b53zkTLi9y3WdrASvKMYAgg14,2780
+stackit/runcommand/models/properties.py,sha256=HwkgILzcTzsf7m7nIGaH7UCqPC-vLYUCNZPjHDCOGfQ,4213
+stackit/runcommand/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+stackit/runcommand/rest.py,sha256=a0X2D3GMynQZrdWxcNmHhpiYeo_-4-YW79k5YG5mb0U,5835
+stackit_runcommand-0.0.1a0.dist-info/METADATA,sha256=enE8FMEGuDc_8xYnueandM8hRIUKaSriYkklRYiVzio,1509
+stackit_runcommand-0.0.1a0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+stackit_runcommand-0.0.1a0.dist-info/RECORD,,

stackit_runcommand-0.0.1a0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any