stackit-serviceenablement 0.0.1a0__py3-none-any.whl

stackit/serviceenablement/models/list_service_status200_response.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    STACKIT Service Enablement API
+
+    STACKIT Service Enablement API
+
+    The version of the OpenAPI document: 1.1
+    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.serviceenablement.models.service_status import ServiceStatus
+
+
+class ListServiceStatus200Response(BaseModel):
+    """
+    ListServiceStatus200Response
+    """
+
+    items: Optional[List[ServiceStatus]] = None
+    next_cursor: Optional[StrictStr] = Field(default=None, alias="nextCursor")
+    __properties: ClassVar[List[str]] = ["items", "nextCursor"]
+
+    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 ListServiceStatus200Response 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 ListServiceStatus200Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "items": (
+                    [ServiceStatus.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None
+                ),
+                "nextCursor": obj.get("nextCursor"),
+            }
+        )
+        return _obj

stackit/serviceenablement/models/parameters.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    STACKIT Service Enablement API
+
+    STACKIT Service Enablement API
+
+    The version of the OpenAPI document: 1.1
+    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.serviceenablement.models.parameters_general import ParametersGeneral
+
+
+class Parameters(BaseModel):
+    """
+    service parameters
+    """
+
+    general: Optional[ParametersGeneral] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["general"]
+
+    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 Parameters 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of general
+        if self.general:
+            _dict["general"] = self.general.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Parameters from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"general": ParametersGeneral.from_dict(obj["general"]) if obj.get("general") is not None else None}
+        )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

stackit/serviceenablement/models/parameters_general.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    STACKIT Service Enablement API
+
+    STACKIT Service Enablement API
+
+    The version of the OpenAPI document: 1.1
+    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, field_validator
+from typing_extensions import Self
+
+
+class ParametersGeneral(BaseModel):
+    """
+    ParametersGeneral
+    """
+
+    organization_id: Optional[StrictStr] = Field(default=None, alias="organizationId")
+    project_name: Optional[StrictStr] = Field(default=None, alias="projectName")
+    project_scope: Optional[StrictStr] = Field(default="PUBLIC", alias="projectScope")
+    __properties: ClassVar[List[str]] = ["organizationId", "projectName", "projectScope"]
+
+    @field_validator("project_scope")
+    def project_scope_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["SCHWARZ", "PUBLIC"]):
+            raise ValueError("must be one of enum values ('SCHWARZ', 'PUBLIC')")
+        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 ParametersGeneral 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 ParametersGeneral from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "organizationId": obj.get("organizationId"),
+                "projectName": obj.get("projectName"),
+                "projectScope": obj.get("projectScope") if obj.get("projectScope") is not None else "PUBLIC",
+            }
+        )
+        return _obj

stackit/serviceenablement/models/service_status.py

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+"""
+    STACKIT Service Enablement API
+
+    STACKIT Service Enablement API
+
+    The version of the OpenAPI document: 1.1
+    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, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.serviceenablement.models.action_error import ActionError
+from stackit.serviceenablement.models.dependencies import Dependencies
+from stackit.serviceenablement.models.parameters import Parameters
+
+
+class ServiceStatus(BaseModel):
+    """
+    ServiceStatus
+    """
+
+    dependencies: Optional[Dependencies] = None
+    enablement: Optional[StrictStr] = "REQUEST"
+    error: Optional[ActionError] = None
+    labels: Optional[Dict[str, StrictStr]] = None
+    lifecycle: Optional[StrictStr] = "FLEX"
+    parameters: Optional[Parameters] = None
+    scope: Optional[StrictStr] = "PUBLIC"
+    service_id: Optional[Annotated[str, Field(min_length=10, strict=True, max_length=255)]] = Field(
+        default=None, description="the id of the service", alias="serviceId"
+    )
+    state: Optional[StrictStr] = Field(default="ENABLED", description="the state of a service within a project")
+    __properties: ClassVar[List[str]] = [
+        "dependencies",
+        "enablement",
+        "error",
+        "labels",
+        "lifecycle",
+        "parameters",
+        "scope",
+        "serviceId",
+        "state",
+    ]
+
+    @field_validator("enablement")
+    def enablement_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["REQUEST", "AUTO"]):
+            raise ValueError("must be one of enum values ('REQUEST', 'AUTO')")
+        return value
+
+    @field_validator("lifecycle")
+    def lifecycle_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["FLEX", "PROJECT"]):
+            raise ValueError("must be one of enum values ('FLEX', 'PROJECT')")
+        return value
+
+    @field_validator("scope")
+    def scope_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["PRIVATE", "PUBLIC"]):
+            raise ValueError("must be one of enum values ('PRIVATE', 'PUBLIC')")
+        return value
+
+    @field_validator("service_id")
+    def service_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][a-zA-Z0-9._-]{1,254}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9][a-zA-Z0-9._-]{1,254}$/")
+        return value
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["ENABLED", "ENABLING", "DISABLED", "DISABLING"]):
+            raise ValueError("must be one of enum values ('ENABLED', 'ENABLING', 'DISABLED', 'DISABLING')")
+        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 ServiceStatus 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 dependencies
+        if self.dependencies:
+            _dict["dependencies"] = self.dependencies.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of error
+        if self.error:
+            _dict["error"] = self.error.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of parameters
+        if self.parameters:
+            _dict["parameters"] = self.parameters.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServiceStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "dependencies": (
+                    Dependencies.from_dict(obj["dependencies"]) if obj.get("dependencies") is not None else None
+                ),
+                "enablement": obj.get("enablement") if obj.get("enablement") is not None else "REQUEST",
+                "error": ActionError.from_dict(obj["error"]) if obj.get("error") is not None else None,
+                "labels": obj.get("labels"),
+                "lifecycle": obj.get("lifecycle") if obj.get("lifecycle") is not None else "FLEX",
+                "parameters": Parameters.from_dict(obj["parameters"]) if obj.get("parameters") is not None else None,
+                "scope": obj.get("scope") if obj.get("scope") is not None else "PUBLIC",
+                "serviceId": obj.get("serviceId"),
+                "state": obj.get("state") if obj.get("state") is not None else "ENABLED",
+            }
+        )
+        return _obj

stackit/serviceenablement/rest.py

@@ -0,0 +1,148 @@
+# coding: utf-8
+
+"""
+    STACKIT Service Enablement API
+
+    STACKIT Service Enablement API
+
+    The version of the OpenAPI document: 1.1
+    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.serviceenablement.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_serviceenablement-0.0.1a0.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: stackit-serviceenablement
+Version: 0.0.1a0
+Summary: STACKIT Service Enablement 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.serviceenablement
+STACKIT Service Enablement 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-serviceenablement
+```
+
+Then import the package:
+```python
+import stackit.serviceenablement
+```
+
+## 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.