stackit-stackitmarketplace 1.5.0__tar.gz → 1.6.0__tar.gz

{stackit_stackitmarketplace-1.5.0 → stackit_stackitmarketplace-1.6.0}/PKG-INFO

@@ -1,14 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: stackit-stackitmarketplace
-Version: 1.5.0
+Version: 1.6.0
 Summary: STACKIT Marketplace API
 Author: STACKIT Developer Tools
 Author-email: developer-tools@stackit.cloud
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<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
@@ -18,6 +17,8 @@ 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)
+Project-URL: Homepage, https://github.com/stackitcloud/stackit-sdk-python
+Project-URL: Issues, https://github.com/stackitcloud/stackit-sdk-python/issues
 Description-Content-Type: text/markdown
 
 # stackit.stackitmarketplace

{stackit_stackitmarketplace-1.5.0 → stackit_stackitmarketplace-1.6.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "stackit-stackitmarketplace"
 
 [tool.poetry]
 name = "stackit-stackitmarketplace"
-version = "v1.5.0"
+version = "v1.6.0"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]
@@ -20,7 +20,7 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = ">=3.8,<4.0"
+python = ">=3.9,<4.0"
 stackit-core = ">=0.0.1a"
 requests = ">=2.32.3"
 pydantic = ">=2.9.2"

stackit_stackitmarketplace-1.6.0/src/stackit/stackitmarketplace/__init__.py

@@ -0,0 +1,186 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    STACKIT Marketplace API
+
+    API to manage STACKIT Marketplace.
+
+    The version of the OpenAPI document: 1
+    Contact: marketplace@stackit.cloud
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "DefaultApi",
+    "ApiResponse",
+    "ApiClient",
+    "HostConfiguration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "ApproveSubscriptionPayload",
+    "Assets",
+    "BecomeVendor",
+    "CatalogPricingOptionHighlight",
+    "CatalogProductDetail",
+    "CatalogProductDetailsVendor",
+    "CatalogProductFacetsValueInner",
+    "CatalogProductHighlight",
+    "CatalogProductOverview",
+    "CatalogProductOverviewVendor",
+    "CatalogProductPricingOption",
+    "CatalogProductSupportResource",
+    "CatalogProductVendorTerms",
+    "ContactSales",
+    "DeliveryMethod",
+    "ErrorResponse",
+    "InquiriesCreateInquiryPayload",
+    "InquiryBecomeVendor",
+    "InquiryContactSales",
+    "InquiryFormType",
+    "InquiryRegisterTesting",
+    "InquirySuggestProduct",
+    "ListCatalogProductsResponse",
+    "ListVendorSubscriptionsResponse",
+    "LocalizedVersion",
+    "NoticePeriod",
+    "OfferType",
+    "PriceType",
+    "PricingOptionUnit",
+    "ProductLifecycleState",
+    "RegisterTesting",
+    "ResolveCustomerPayload",
+    "ServiceCertificate",
+    "SubscriptionLifecycleState",
+    "SubscriptionProduct",
+    "SuggestProduct",
+    "VendorSubscription",
+]
+
+# import apis into sdk package
+from stackit.stackitmarketplace.api.default_api import DefaultApi as DefaultApi
+from stackit.stackitmarketplace.api_client import ApiClient as ApiClient
+
+# import ApiClient
+from stackit.stackitmarketplace.api_response import ApiResponse as ApiResponse
+from stackit.stackitmarketplace.configuration import (
+    HostConfiguration as HostConfiguration,
+)
+from stackit.stackitmarketplace.exceptions import ApiAttributeError as ApiAttributeError
+from stackit.stackitmarketplace.exceptions import ApiException as ApiException
+from stackit.stackitmarketplace.exceptions import ApiKeyError as ApiKeyError
+from stackit.stackitmarketplace.exceptions import ApiTypeError as ApiTypeError
+from stackit.stackitmarketplace.exceptions import ApiValueError as ApiValueError
+from stackit.stackitmarketplace.exceptions import OpenApiException as OpenApiException
+
+# import models into sdk package
+from stackit.stackitmarketplace.models.approve_subscription_payload import (
+    ApproveSubscriptionPayload as ApproveSubscriptionPayload,
+)
+from stackit.stackitmarketplace.models.assets import Assets as Assets
+from stackit.stackitmarketplace.models.become_vendor import BecomeVendor as BecomeVendor
+from stackit.stackitmarketplace.models.catalog_pricing_option_highlight import (
+    CatalogPricingOptionHighlight as CatalogPricingOptionHighlight,
+)
+from stackit.stackitmarketplace.models.catalog_product_detail import (
+    CatalogProductDetail as CatalogProductDetail,
+)
+from stackit.stackitmarketplace.models.catalog_product_details_vendor import (
+    CatalogProductDetailsVendor as CatalogProductDetailsVendor,
+)
+from stackit.stackitmarketplace.models.catalog_product_facets_value_inner import (
+    CatalogProductFacetsValueInner as CatalogProductFacetsValueInner,
+)
+from stackit.stackitmarketplace.models.catalog_product_highlight import (
+    CatalogProductHighlight as CatalogProductHighlight,
+)
+from stackit.stackitmarketplace.models.catalog_product_overview import (
+    CatalogProductOverview as CatalogProductOverview,
+)
+from stackit.stackitmarketplace.models.catalog_product_overview_vendor import (
+    CatalogProductOverviewVendor as CatalogProductOverviewVendor,
+)
+from stackit.stackitmarketplace.models.catalog_product_pricing_option import (
+    CatalogProductPricingOption as CatalogProductPricingOption,
+)
+from stackit.stackitmarketplace.models.catalog_product_support_resource import (
+    CatalogProductSupportResource as CatalogProductSupportResource,
+)
+from stackit.stackitmarketplace.models.catalog_product_vendor_terms import (
+    CatalogProductVendorTerms as CatalogProductVendorTerms,
+)
+from stackit.stackitmarketplace.models.contact_sales import ContactSales as ContactSales
+from stackit.stackitmarketplace.models.delivery_method import (
+    DeliveryMethod as DeliveryMethod,
+)
+from stackit.stackitmarketplace.models.error_response import (
+    ErrorResponse as ErrorResponse,
+)
+from stackit.stackitmarketplace.models.inquiries_create_inquiry_payload import (
+    InquiriesCreateInquiryPayload as InquiriesCreateInquiryPayload,
+)
+from stackit.stackitmarketplace.models.inquiry_become_vendor import (
+    InquiryBecomeVendor as InquiryBecomeVendor,
+)
+from stackit.stackitmarketplace.models.inquiry_contact_sales import (
+    InquiryContactSales as InquiryContactSales,
+)
+from stackit.stackitmarketplace.models.inquiry_form_type import (
+    InquiryFormType as InquiryFormType,
+)
+from stackit.stackitmarketplace.models.inquiry_register_testing import (
+    InquiryRegisterTesting as InquiryRegisterTesting,
+)
+from stackit.stackitmarketplace.models.inquiry_suggest_product import (
+    InquirySuggestProduct as InquirySuggestProduct,
+)
+from stackit.stackitmarketplace.models.list_catalog_products_response import (
+    ListCatalogProductsResponse as ListCatalogProductsResponse,
+)
+from stackit.stackitmarketplace.models.list_vendor_subscriptions_response import (
+    ListVendorSubscriptionsResponse as ListVendorSubscriptionsResponse,
+)
+from stackit.stackitmarketplace.models.localized_version import (
+    LocalizedVersion as LocalizedVersion,
+)
+from stackit.stackitmarketplace.models.notice_period import NoticePeriod as NoticePeriod
+from stackit.stackitmarketplace.models.offer_type import OfferType as OfferType
+from stackit.stackitmarketplace.models.price_type import PriceType as PriceType
+from stackit.stackitmarketplace.models.pricing_option_unit import (
+    PricingOptionUnit as PricingOptionUnit,
+)
+from stackit.stackitmarketplace.models.product_lifecycle_state import (
+    ProductLifecycleState as ProductLifecycleState,
+)
+from stackit.stackitmarketplace.models.register_testing import (
+    RegisterTesting as RegisterTesting,
+)
+from stackit.stackitmarketplace.models.resolve_customer_payload import (
+    ResolveCustomerPayload as ResolveCustomerPayload,
+)
+from stackit.stackitmarketplace.models.service_certificate import (
+    ServiceCertificate as ServiceCertificate,
+)
+from stackit.stackitmarketplace.models.subscription_lifecycle_state import (
+    SubscriptionLifecycleState as SubscriptionLifecycleState,
+)
+from stackit.stackitmarketplace.models.subscription_product import (
+    SubscriptionProduct as SubscriptionProduct,
+)
+from stackit.stackitmarketplace.models.suggest_product import (
+    SuggestProduct as SuggestProduct,
+)
+from stackit.stackitmarketplace.models.vendor_subscription import (
+    VendorSubscription as VendorSubscription,
+)

{stackit_stackitmarketplace-1.5.0 → stackit_stackitmarketplace-1.6.0}/src/stackit/stackitmarketplace/api/default_api.py

@@ -10,7 +10,7 @@
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
-"""  # noqa: E501 docstring might be too long
+"""  # noqa: E501
 
 from typing import Any, Dict, List, Optional, Tuple, Union
 
@@ -109,7 +109,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._approve_subscription_serialize(
             project_id=project_id,
@@ -183,7 +183,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._approve_subscription_serialize(
             project_id=project_id,
@@ -257,7 +257,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._approve_subscription_serialize(
             project_id=project_id,
@@ -298,7 +298,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -386,7 +386,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._get_catalog_product_serialize(
             product_id=product_id,
@@ -454,7 +454,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._get_catalog_product_serialize(
             product_id=product_id,
@@ -522,7 +522,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._get_catalog_product_serialize(
             product_id=product_id,
@@ -561,7 +561,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -643,7 +643,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._get_vendor_subscription_serialize(
             project_id=project_id,
@@ -713,7 +713,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._get_vendor_subscription_serialize(
             project_id=project_id,
@@ -783,7 +783,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._get_vendor_subscription_serialize(
             project_id=project_id,
@@ -822,7 +822,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -897,7 +897,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._inquiries_create_inquiry_serialize(
             inquiries_create_inquiry_payload=inquiries_create_inquiry_payload,
@@ -961,7 +961,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._inquiries_create_inquiry_serialize(
             inquiries_create_inquiry_payload=inquiries_create_inquiry_payload,
@@ -1025,7 +1025,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._inquiries_create_inquiry_serialize(
             inquiries_create_inquiry_payload=inquiries_create_inquiry_payload,
@@ -1062,7 +1062,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1179,7 +1179,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._list_catalog_products_serialize(
             cursor=cursor,
@@ -1282,7 +1282,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._list_catalog_products_serialize(
             cursor=cursor,
@@ -1385,7 +1385,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._list_catalog_products_serialize(
             cursor=cursor,
@@ -1429,7 +1429,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1546,7 +1546,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._list_vendor_subscriptions_serialize(
             project_id=project_id,
@@ -1638,7 +1638,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._list_vendor_subscriptions_serialize(
             project_id=project_id,
@@ -1730,7 +1730,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._list_vendor_subscriptions_serialize(
             project_id=project_id,
@@ -1772,7 +1772,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1860,7 +1860,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._resolve_customer_serialize(
             project_id=project_id,
@@ -1928,7 +1928,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._resolve_customer_serialize(
             project_id=project_id,
@@ -1996,7 +1996,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._resolve_customer_serialize(
             project_id=project_id,
@@ -2035,7 +2035,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -2123,7 +2123,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._vendors_subscriptions_reject_serialize(
             project_id=project_id,
@@ -2193,7 +2193,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._vendors_subscriptions_reject_serialize(
             project_id=project_id,
@@ -2263,7 +2263,7 @@ class DefaultApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """  # noqa: E501 docstring might be too long
+        """  # noqa: E501
 
         _param = self._vendors_subscriptions_reject_serialize(
             project_id=project_id,
@@ -2302,7 +2302,7 @@ class DefaultApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters

{stackit_stackitmarketplace-1.5.0 → stackit_stackitmarketplace-1.6.0}/src/stackit/stackitmarketplace/api_client.py

@@ -10,7 +10,7 @@
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
-"""  # noqa: E501 docstring might be too long
+"""  # noqa: E501
 
 import datetime
 import json
@@ -332,6 +332,10 @@ class ApiClient:
             else:
                 obj_dict = obj.__dict__
 
+        if isinstance(obj_dict, list):
+            # here we handle instances that can either be a list or something else, and only became a real list by calling to_dict() # noqa: E501
+            return self.sanitize_for_serialization(obj_dict)
+
         return {key: self.sanitize_for_serialization(val) for key, val in obj_dict.items()}
 
     def deserialize(self, response_text: str, response_type: str, content_type: Optional[str]):
@@ -351,12 +355,12 @@ class ApiClient:
                 data = json.loads(response_text)
             except ValueError:
                 data = response_text
-        elif content_type.startswith("application/json"):
+        elif re.match(r"^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)", content_type, re.IGNORECASE):
             if response_text == "":
                 data = ""
             else:
                 data = json.loads(response_text)
-        elif content_type.startswith("text/plain"):
+        elif re.match(r"^text\/[a-z.+-]+\s*(;|$)", content_type, re.IGNORECASE):
             data = response_text
         else:
             raise ApiException(status=0, reason="Unsupported content type: {0}".format(content_type))
@@ -458,7 +462,7 @@ class ApiClient:
             if k in collection_formats:
                 collection_format = collection_formats[k]
                 if collection_format == "multi":
-                    new_params.extend((k, str(value)) for value in v)
+                    new_params.extend((k, quote(str(value))) for value in v)
                 else:
                     if collection_format == "ssv":
                         delimiter = " "
@@ -474,7 +478,10 @@ class ApiClient:
 
         return "&".join(["=".join(map(str, item)) for item in new_params])
 
-    def files_parameters(self, files: Dict[str, Union[str, bytes]]):
+    def files_parameters(
+        self,
+        files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]],
+    ):
         """Builds form parameters.
 
         :param files: File parameters.
@@ -489,6 +496,12 @@ class ApiClient:
             elif isinstance(v, bytes):
                 filename = k
                 filedata = v
+            elif isinstance(v, tuple):
+                filename, filedata = v
+            elif isinstance(v, list):
+                for file_param in v:
+                    params.extend(self.files_parameters({k: file_param}))
+                continue
             else:
                 raise ValueError("Unsupported file value")
             mimetype = mimetypes.guess_type(filename)[0] or "application/octet-stream"

{stackit_stackitmarketplace-1.5.0 → stackit_stackitmarketplace-1.6.0}/src/stackit/stackitmarketplace/configuration.py

@@ -1,10 +1,5 @@
 # coding: utf-8
 
-import sys
-
-import os
-
-
 """
     STACKIT Marketplace API
 
@@ -15,7 +10,29 @@ import os
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
-"""  # noqa: E501 docstring might be too long
+"""  # noqa: E501
+
+import sys
+from typing import Dict, List, Optional, TypedDict
+
+from typing_extensions import NotRequired
+
+import os
+
+
+ServerVariablesT = Dict[str, str]
+
+
+class HostSettingVariable(TypedDict):
+    description: str
+    default_value: str
+    enum_values: List[str]
+
+
+class HostSetting(TypedDict):
+    url: str
+    description: str
+    variables: NotRequired[Dict[str, HostSettingVariable]]
 
 
 class HostConfiguration:
@@ -54,7 +71,7 @@ class HostConfiguration:
         """Ignore operation servers
         """
 
-    def get_host_settings(self):
+    def get_host_settings(self) -> List[HostSetting]:
         """Gets an array of host settings
 
         :return: An array of host settings
@@ -72,7 +89,12 @@ class HostConfiguration:
             }
         ]
 
-    def get_host_from_settings(self, index, variables=None, servers=None):
+    def get_host_from_settings(
+        self,
+        index: Optional[int],
+        variables: Optional[ServerVariablesT] = None,
+        servers: Optional[List[HostSetting]] = None,
+    ) -> str:
         """Gets host URL based on the index and variables
         :param index: array index of the host settings
         :param variables: hash of variable and the corresponding value
@@ -112,7 +134,7 @@ class HostConfiguration:
                 and variables.get(variable_name) is not None
             ):
                 raise ValueError(
-                    "this API does not support setting a region in the the client configuration, "
+                    "this API does not support setting a region in the client configuration, "
                     "please check if the region can be specified as a function parameter"
                 )
             used_value = variables.get(variable_name, variable["default_value"])
@@ -131,12 +153,12 @@ class HostConfiguration:
         return url
 
     @property
-    def host(self):
+    def host(self) -> str:
         """Return generated host."""
         return self.get_host_from_settings(self.server_index, variables=self.server_variables)
 
     @host.setter
-    def host(self, value):
+    def host(self, value: str) -> None:
         """Fix base path."""
         self._base_path = value
         self.server_index = None