stackit-stackitmarketplace 0.4.0__tar.gz → 1.1.0__tar.gz

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stackit-stackitmarketplace
-Version: 0.4.0
+Version: 1.1.0
 Summary: STACKIT Marketplace API
 Author: STACKIT Developer Tools
 Author-email: developer-tools@stackit.cloud

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "stackit-stackitmarketplace"
 
 [tool.poetry]
 name = "stackit-stackitmarketplace"
-version = "v0.4.0"
+version = "v1.1.0"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/api/default_api.py

@@ -346,7 +346,7 @@ class DefaultApi:
     @validate_call
     def get_catalog_product(
         self,
-        product_id: Annotated[str, Field(min_length=36, strict=True, max_length=36, description="The product ID.")],
+        product_id: Annotated[str, Field(min_length=10, strict=True, max_length=29, description="The product ID.")],
         locale: Annotated[Optional[StrictStr], Field(description="The language of the response.")] = None,
         _request_timeout: Union[
             None,
@@ -414,7 +414,7 @@ class DefaultApi:
     @validate_call
     def get_catalog_product_with_http_info(
         self,
-        product_id: Annotated[str, Field(min_length=36, strict=True, max_length=36, description="The product ID.")],
+        product_id: Annotated[str, Field(min_length=10, strict=True, max_length=29, description="The product ID.")],
         locale: Annotated[Optional[StrictStr], Field(description="The language of the response.")] = None,
         _request_timeout: Union[
             None,
@@ -482,7 +482,7 @@ class DefaultApi:
     @validate_call
     def get_catalog_product_without_preload_content(
         self,
-        product_id: Annotated[str, Field(min_length=36, strict=True, max_length=36, description="The product ID.")],
+        product_id: Annotated[str, Field(min_length=10, strict=True, max_length=29, description="The product ID.")],
         locale: Annotated[Optional[StrictStr], Field(description="The language of the response.")] = None,
         _request_timeout: Union[
             None,
@@ -1132,7 +1132,7 @@ class DefaultApi:
         sort: Annotated[
             Optional[StrictStr],
             Field(
-                description="Sort the products based on attributes and order (if specified). E.g `name:asc`. The supported attributes are `name`, `price`, and `deliveryMethod`. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name,price:desc`. The order can be ommited to sort by the default order. E.g `name`."
+                description="Sort the products based on attributes and order e.g. `name:asc`. Attributes with scalar types (`createdAt`, `isProductListing`) or keywords (`name`, `deliveryMethod`, `lifecycleState`, `vendor.name`) can be used as sort criteria. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name:asc,price:desc`."
             ),
         ] = None,
         _request_timeout: Union[
@@ -1157,7 +1157,7 @@ class DefaultApi:
         :type locale: str
         :param filter: Filter the products based on attributes. E.g `deliveryMethod eq \"SAAS\"`. The supported attributes are `deliveryMethod`, `priceType`, `category`, `vendorId`, `vendorName`, and `name`. The supported operators are `eq`. Filters can be joined with `and` or `or`.
         :type filter: str
-        :param sort: Sort the products based on attributes and order (if specified). E.g `name:asc`. The supported attributes are `name`, `price`, and `deliveryMethod`. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name,price:desc`. The order can be ommited to sort by the default order. E.g `name`.
+        :param sort: Sort the products based on attributes and order e.g. `name:asc`. Attributes with scalar types (`createdAt`, `isProductListing`) or keywords (`name`, `deliveryMethod`, `lifecycleState`, `vendor.name`) can be used as sort criteria. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name:asc,price:desc`.
         :type sort: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1235,7 +1235,7 @@ class DefaultApi:
         sort: Annotated[
             Optional[StrictStr],
             Field(
-                description="Sort the products based on attributes and order (if specified). E.g `name:asc`. The supported attributes are `name`, `price`, and `deliveryMethod`. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name,price:desc`. The order can be ommited to sort by the default order. E.g `name`."
+                description="Sort the products based on attributes and order e.g. `name:asc`. Attributes with scalar types (`createdAt`, `isProductListing`) or keywords (`name`, `deliveryMethod`, `lifecycleState`, `vendor.name`) can be used as sort criteria. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name:asc,price:desc`."
             ),
         ] = None,
         _request_timeout: Union[
@@ -1260,7 +1260,7 @@ class DefaultApi:
         :type locale: str
         :param filter: Filter the products based on attributes. E.g `deliveryMethod eq \"SAAS\"`. The supported attributes are `deliveryMethod`, `priceType`, `category`, `vendorId`, `vendorName`, and `name`. The supported operators are `eq`. Filters can be joined with `and` or `or`.
         :type filter: str
-        :param sort: Sort the products based on attributes and order (if specified). E.g `name:asc`. The supported attributes are `name`, `price`, and `deliveryMethod`. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name,price:desc`. The order can be ommited to sort by the default order. E.g `name`.
+        :param sort: Sort the products based on attributes and order e.g. `name:asc`. Attributes with scalar types (`createdAt`, `isProductListing`) or keywords (`name`, `deliveryMethod`, `lifecycleState`, `vendor.name`) can be used as sort criteria. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name:asc,price:desc`.
         :type sort: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1338,7 +1338,7 @@ class DefaultApi:
         sort: Annotated[
             Optional[StrictStr],
             Field(
-                description="Sort the products based on attributes and order (if specified). E.g `name:asc`. The supported attributes are `name`, `price`, and `deliveryMethod`. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name,price:desc`. The order can be ommited to sort by the default order. E.g `name`."
+                description="Sort the products based on attributes and order e.g. `name:asc`. Attributes with scalar types (`createdAt`, `isProductListing`) or keywords (`name`, `deliveryMethod`, `lifecycleState`, `vendor.name`) can be used as sort criteria. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name:asc,price:desc`."
             ),
         ] = None,
         _request_timeout: Union[
@@ -1363,7 +1363,7 @@ class DefaultApi:
         :type locale: str
         :param filter: Filter the products based on attributes. E.g `deliveryMethod eq \"SAAS\"`. The supported attributes are `deliveryMethod`, `priceType`, `category`, `vendorId`, `vendorName`, and `name`. The supported operators are `eq`. Filters can be joined with `and` or `or`.
         :type filter: str
-        :param sort: Sort the products based on attributes and order (if specified). E.g `name:asc`. The supported attributes are `name`, `price`, and `deliveryMethod`. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name,price:desc`. The order can be ommited to sort by the default order. E.g `name`.
+        :param sort: Sort the products based on attributes and order e.g. `name:asc`. Attributes with scalar types (`createdAt`, `isProductListing`) or keywords (`name`, `deliveryMethod`, `lifecycleState`, `vendor.name`) can be used as sort criteria. To set the sort order, append `asc` (ascending) or `desc` (descending) to the attribute, e.g. `name:asc`. To sort by multiple attributes, separate them with a comma. E.g `name:asc,price:desc`.
         :type sort: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1501,7 +1501,7 @@ class DefaultApi:
             ),
         ] = None,
         product_id: Annotated[
-            Optional[Annotated[str, Field(min_length=36, strict=True, max_length=36)]],
+            Optional[Annotated[str, Field(min_length=10, strict=True, max_length=29)]],
             Field(description="The product ID."),
         ] = None,
         _request_timeout: Union[
@@ -1514,9 +1514,9 @@ class DefaultApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ListVendorSubscriptionsResponse:
-        """List all subscriptions
+        """List all subscriptions of a project.
 
-        List all subscriptions.
+        List all subscriptions of a project.
 
         :param project_id: The project ID. (required)
         :type project_id: str
@@ -1593,7 +1593,7 @@ class DefaultApi:
             ),
         ] = None,
         product_id: Annotated[
-            Optional[Annotated[str, Field(min_length=36, strict=True, max_length=36)]],
+            Optional[Annotated[str, Field(min_length=10, strict=True, max_length=29)]],
             Field(description="The product ID."),
         ] = None,
         _request_timeout: Union[
@@ -1606,9 +1606,9 @@ class DefaultApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[ListVendorSubscriptionsResponse]:
-        """List all subscriptions
+        """List all subscriptions of a project.
 
-        List all subscriptions.
+        List all subscriptions of a project.
 
         :param project_id: The project ID. (required)
         :type project_id: str
@@ -1685,7 +1685,7 @@ class DefaultApi:
             ),
         ] = None,
         product_id: Annotated[
-            Optional[Annotated[str, Field(min_length=36, strict=True, max_length=36)]],
+            Optional[Annotated[str, Field(min_length=10, strict=True, max_length=29)]],
             Field(description="The product ID."),
         ] = None,
         _request_timeout: Union[
@@ -1698,9 +1698,9 @@ class DefaultApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """List all subscriptions
+        """List all subscriptions of a project.
 
-        List all subscriptions.
+        List all subscriptions of a project.
 
         :param project_id: The project ID. (required)
         :type project_id: str

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/api_client.py

@@ -82,7 +82,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = "OpenAPI-Generator/1.0.0/python"
+        self.user_agent = "stackit-sdk-python/stackitmarketplace"
 
     def __enter__(self):
         return self

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/configuration.py

@@ -1,5 +1,10 @@
 # coding: utf-8
 
+import sys
+
+import os
+
+
 """
     STACKIT Marketplace API
 
@@ -12,8 +17,6 @@
     Do not edit the class manually.
 """  # noqa: E501 docstring might be too long
 
-import os
-
 
 class HostConfiguration:
     def __init__(
@@ -30,6 +33,7 @@ class HostConfiguration:
             "as a function argument instead of being set in the client configuration.\n"
             "Once all services have migrated, the methods to specify the region in the client configuration "
             "will be removed.",
+            file=sys.stderr,
         )
         """Constructor
         """

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/models/catalog_product_detail.py

@@ -76,7 +76,9 @@ class CatalogProductDetail(BaseModel):
     pricing_options: List[CatalogProductPricingOption] = Field(
         description="The list of pricing options.", alias="pricingOptions"
     )
-    product_id: object = Field(alias="productId")
+    product_id: Annotated[str, Field(min_length=10, strict=True, max_length=29)] = Field(
+        description="The user-readable product ID.", alias="productId"
+    )
     summary: StrictStr = Field(description="The short summary of the product.")
     support_faq: Optional[Annotated[str, Field(strict=True, max_length=512)]] = Field(
         default=None, description="The support FAQ URL.", alias="supportFaq"
@@ -132,6 +134,13 @@ class CatalogProductDetail(BaseModel):
             raise ValueError(r"must validate the regular expression /^[a-zA-ZäüöÄÜÖ0-9,.!?()@\/:=\n\t -]+$/")
         return value
 
+    @field_validator("product_id")
+    def product_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z0-9-]{1,20}-[0-9a-f]{8}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z0-9-]{1,20}-[0-9a-f]{8}$/")
+        return value
+
     @field_validator("support_faq")
     def support_faq_validate_regular_expression(cls, value):
         """Validates the regular expression"""

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/models/catalog_product_overview.py

@@ -47,7 +47,9 @@ class CatalogProductOverview(BaseModel):
     lifecycle_state: ProductLifecycleState = Field(alias="lifecycleState")
     logo: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The logo base64 encoded.")
     name: Annotated[str, Field(strict=True, max_length=512)] = Field(description="The name of the product.")
-    product_id: object = Field(alias="productId")
+    product_id: Annotated[str, Field(min_length=10, strict=True, max_length=29)] = Field(
+        description="The user-readable product ID.", alias="productId"
+    )
     summary: Annotated[str, Field(strict=True, max_length=512)] = Field(description="The short summary of the product.")
     vendor: CatalogProductOverviewVendor
     __properties: ClassVar[List[str]] = [
@@ -67,6 +69,13 @@ class CatalogProductOverview(BaseModel):
             raise ValueError(r"must validate the regular expression /^[a-zA-ZäüöÄÜÖ0-9,.!?()@\/:=\n\t -]+$/")
         return value
 
+    @field_validator("product_id")
+    def product_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z0-9-]{1,20}-[0-9a-f]{8}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z0-9-]{1,20}-[0-9a-f]{8}$/")
+        return value
+
     @field_validator("summary")
     def summary_validate_regular_expression(cls, value):
         """Validates the regular expression"""

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/models/inquiry_contact_sales.py

@@ -36,7 +36,9 @@ class InquiryContactSales(BaseModel):
         description="The full name of the contact person.", alias="fullName"
     )
     message: Annotated[str, Field(strict=True, max_length=512)] = Field(description="A custom message.")
-    product_id: object = Field(alias="productId")
+    product_id: Annotated[str, Field(min_length=10, strict=True, max_length=29)] = Field(
+        description="The user-readable product ID.", alias="productId"
+    )
     __properties: ClassVar[List[str]] = ["companyName", "contactEmail", "fullName", "message", "productId"]
 
     @field_validator("company_name")
@@ -60,6 +62,13 @@ class InquiryContactSales(BaseModel):
             raise ValueError(r"must validate the regular expression /^[a-zA-ZäüöÄÜÖ0-9,.!?()@\/:=\n\t -]+$/")
         return value
 
+    @field_validator("product_id")
+    def product_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z0-9-]{1,20}-[0-9a-f]{8}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z0-9-]{1,20}-[0-9a-f]{8}$/")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/models/subscription_product.py

@@ -38,13 +38,18 @@ class SubscriptionProduct(BaseModel):
     lifecycle_state: ProductLifecycleState = Field(alias="lifecycleState")
     price_type: PriceType = Field(alias="priceType")
     pricing_plan: StrictStr = Field(description="Additional price type information.", alias="pricingPlan")
-    product_id: object = Field(alias="productId")
+    product_id: Annotated[str, Field(min_length=10, strict=True, max_length=29)] = Field(
+        description="The user-readable product ID.", alias="productId"
+    )
     product_name: Annotated[str, Field(strict=True, max_length=512)] = Field(
         description="The name of the product.", alias="productName"
     )
     vendor_name: Annotated[str, Field(strict=True, max_length=512)] = Field(
         description="The product's vendor name.", alias="vendorName"
     )
+    vendor_plan_id: Optional[Annotated[str, Field(strict=True)]] = Field(
+        default=None, description="The vendor provided plan ID.", alias="vendorPlanId"
+    )
     vendor_product_id: Optional[Annotated[str, Field(strict=True)]] = Field(
         default=None, description="The vendor provided product ID.", alias="vendorProductId"
     )
@@ -59,10 +64,18 @@ class SubscriptionProduct(BaseModel):
         "productId",
         "productName",
         "vendorName",
+        "vendorPlanId",
         "vendorProductId",
         "vendorWebsiteUrl",
     ]
 
+    @field_validator("product_id")
+    def product_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-z0-9-]{1,20}-[0-9a-f]{8}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-z0-9-]{1,20}-[0-9a-f]{8}$/")
+        return value
+
     @field_validator("product_name")
     def product_name_validate_regular_expression(cls, value):
         """Validates the regular expression"""
@@ -77,6 +90,16 @@ class SubscriptionProduct(BaseModel):
             raise ValueError(r"must validate the regular expression /^[a-zA-ZäüöÄÜÖ0-9,.!?()@\/:=\n\t -]+$/")
         return value
 
+    @field_validator("vendor_plan_id")
+    def vendor_plan_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_+&-]){0,39}$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9](?:[a-zA-Z0-9_+&-]){0,39}$/")
+        return value
+
     @field_validator("vendor_product_id")
     def vendor_product_id_validate_regular_expression(cls, value):
         """Validates the regular expression"""
@@ -153,6 +176,7 @@ class SubscriptionProduct(BaseModel):
                 "productId": obj.get("productId"),
                 "productName": obj.get("productName"),
                 "vendorName": obj.get("vendorName"),
+                "vendorPlanId": obj.get("vendorPlanId"),
                 "vendorProductId": obj.get("vendorProductId"),
                 "vendorWebsiteUrl": obj.get("vendorWebsiteUrl"),
             }

{stackit_stackitmarketplace-0.4.0 → stackit_stackitmarketplace-1.1.0}/src/stackit/stackitmarketplace/models/vendor_subscription.py

@@ -33,10 +33,11 @@ class VendorSubscription(BaseModel):
     """
 
     lifecycle_state: SubscriptionLifecycleState = Field(alias="lifecycleState")
+    organization_id: object = Field(alias="organizationId")
     product: SubscriptionProduct
     project_id: object = Field(alias="projectId")
     subscription_id: object = Field(alias="subscriptionId")
-    __properties: ClassVar[List[str]] = ["lifecycleState", "product", "projectId", "subscriptionId"]
+    __properties: ClassVar[List[str]] = ["lifecycleState", "organizationId", "product", "projectId", "subscriptionId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -92,6 +93,7 @@ class VendorSubscription(BaseModel):
         _obj = cls.model_validate(
             {
                 "lifecycleState": obj.get("lifecycleState"),
+                "organizationId": obj.get("organizationId"),
                 "product": SubscriptionProduct.from_dict(obj["product"]) if obj.get("product") is not None else None,
                 "projectId": obj.get("projectId"),
                 "subscriptionId": obj.get("subscriptionId"),