feat(product_catalog): filter by locality (#1036)

Author: scaleway-bot

scaleway-async/scaleway_async/product_catalog/v2alpha1/api.py

@@ -11,6 +11,7 @@
     ListPublicCatalogProductsRequestProductType,
     ListPublicCatalogProductsResponse,
     PublicCatalogProduct,
+    PublicCatalogProductLocality,
 )
 from .marshalling import (
     unmarshal_ListPublicCatalogProductsResponse,
@@ -28,13 +29,15 @@ async def list_public_catalog_products(
         product_types: Optional[
             List[ListPublicCatalogProductsRequestProductType]
         ] = None,
+        locality: Optional[PublicCatalogProductLocality] = None,
     ) -> ListPublicCatalogProductsResponse:
         """
         List all available products.
         List all available products in the Scaleway catalog. Returns a complete list of products with their corresponding description, locations, prices and properties. You can define the `page` number and `page_size` for your query in the request.
         :param page: Number of the page. Value must be greater or equal to 1.
         :param page_size: The number of products per page. Value must be greater or equal to 1.
         :param product_types: The list of filtered product categories.
+        :param locality: The locality of the products to filter by. If not set, all localities are returned.
         :return: :class:`ListPublicCatalogProductsResponse <ListPublicCatalogProductsResponse>`
 
         Usage:
@@ -47,6 +50,7 @@ async def list_public_catalog_products(
             "GET",
             "/product-catalog/v2alpha1/public-catalog/products",
             params={
+                "locality": locality,
                 "page": page,
                 "page_size": page_size or self.client.default_page_size,
                 "product_types": product_types,
@@ -64,13 +68,15 @@ async def list_public_catalog_products_all(
         product_types: Optional[
             List[ListPublicCatalogProductsRequestProductType]
         ] = None,
+        locality: Optional[PublicCatalogProductLocality] = None,
     ) -> List[PublicCatalogProduct]:
         """
         List all available products.
         List all available products in the Scaleway catalog. Returns a complete list of products with their corresponding description, locations, prices and properties. You can define the `page` number and `page_size` for your query in the request.
         :param page: Number of the page. Value must be greater or equal to 1.
         :param page_size: The number of products per page. Value must be greater or equal to 1.
         :param product_types: The list of filtered product categories.
+        :param locality: The locality of the products to filter by. If not set, all localities are returned.
         :return: :class:`List[PublicCatalogProduct] <List[PublicCatalogProduct]>`
 
         Usage:
@@ -87,5 +93,6 @@ async def list_public_catalog_products_all(
                 "page": page,
                 "page_size": page_size,
                 "product_types": product_types,
+                "locality": locality,
             },
         )

scaleway-async/scaleway_async/product_catalog/v2alpha1/types.py

@@ -432,3 +432,8 @@ class PublicCatalogApiListPublicCatalogProductsRequest:
     """
     The list of filtered product categories.
     """
+
+    locality: Optional[PublicCatalogProductLocality]
+    """
+    The locality of the products to filter by. If not set, all localities are returned.
+    """

scaleway/scaleway/product_catalog/v2alpha1/api.py

@@ -11,6 +11,7 @@
     ListPublicCatalogProductsRequestProductType,
     ListPublicCatalogProductsResponse,
     PublicCatalogProduct,
+    PublicCatalogProductLocality,
 )
 from .marshalling import (
     unmarshal_ListPublicCatalogProductsResponse,
@@ -28,13 +29,15 @@ def list_public_catalog_products(
         product_types: Optional[
             List[ListPublicCatalogProductsRequestProductType]
         ] = None,
+        locality: Optional[PublicCatalogProductLocality] = None,
     ) -> ListPublicCatalogProductsResponse:
         """
         List all available products.
         List all available products in the Scaleway catalog. Returns a complete list of products with their corresponding description, locations, prices and properties. You can define the `page` number and `page_size` for your query in the request.
         :param page: Number of the page. Value must be greater or equal to 1.
         :param page_size: The number of products per page. Value must be greater or equal to 1.
         :param product_types: The list of filtered product categories.
+        :param locality: The locality of the products to filter by. If not set, all localities are returned.
         :return: :class:`ListPublicCatalogProductsResponse <ListPublicCatalogProductsResponse>`
 
         Usage:
@@ -47,6 +50,7 @@ def list_public_catalog_products(
             "GET",
             "/product-catalog/v2alpha1/public-catalog/products",
             params={
+                "locality": locality,
                 "page": page,
                 "page_size": page_size or self.client.default_page_size,
                 "product_types": product_types,
@@ -64,13 +68,15 @@ def list_public_catalog_products_all(
         product_types: Optional[
             List[ListPublicCatalogProductsRequestProductType]
         ] = None,
+        locality: Optional[PublicCatalogProductLocality] = None,
     ) -> List[PublicCatalogProduct]:
         """
         List all available products.
         List all available products in the Scaleway catalog. Returns a complete list of products with their corresponding description, locations, prices and properties. You can define the `page` number and `page_size` for your query in the request.
         :param page: Number of the page. Value must be greater or equal to 1.
         :param page_size: The number of products per page. Value must be greater or equal to 1.
         :param product_types: The list of filtered product categories.
+        :param locality: The locality of the products to filter by. If not set, all localities are returned.
         :return: :class:`List[PublicCatalogProduct] <List[PublicCatalogProduct]>`
 
         Usage:
@@ -87,5 +93,6 @@ def list_public_catalog_products_all(
                 "page": page,
                 "page_size": page_size,
                 "product_types": product_types,
+                "locality": locality,
             },
         )

scaleway/scaleway/product_catalog/v2alpha1/types.py

@@ -432,3 +432,8 @@ class PublicCatalogApiListPublicCatalogProductsRequest:
     """
     The list of filtered product categories.
     """
+
+    locality: Optional[PublicCatalogProductLocality]
+    """
+    The locality of the products to filter by. If not set, all localities are returned.
+    """