vtexpy 0.0.0b38__py3-none-any.whl → 0.0.0b39__py3-none-any.whl

vtex/_api/__init__.py

@@ -1,6 +1,7 @@
 from .catalog import CatalogAPI
 from .checkout import CheckoutAPI
 from .custom import CustomAPI
+from .intelligent_search import IntelligentSearchAPI
 from .license_manager import LicenseManagerAPI
 from .logistics import LogisticsAPI
 from .master_data import MasterDataAPI

vtex/_api/catalog.py

@@ -91,8 +91,8 @@ class CatalogAPI(BaseAPI):
 
     def list_categories(
         self,
-        page: int = LIST_SKU_IDS_START_PAGE,
-        page_size: int = LIST_SKU_IDS_MAX_PAGE_SIZE,
+        page: int = LIST_CATEGORIES_START_PAGE,
+        page_size: int = LIST_CATEGORIES_MAX_PAGE_SIZE,
         **kwargs: Any,
     ) -> VTEXPaginatedItemsResponse[Any, Any]:
         return self._request(

vtex/_api/intelligent_search.py

@@ -0,0 +1,68 @@
+from typing import Any, Literal, Union
+
+from .._constants import (
+    INTELLIGENT_PRODUCT_SEARCH_MAX_PAGE_SIZE,
+    INTELLIGENT_PRODUCT_SEARCH_START_PAGE,
+    MIN_PAGE_SIZE,
+)
+from .._dto import VTEXPaginatedItemsResponse
+from .._sentinels import UNDEFINED, UndefinedSentinel
+from .._types import OrderingDirectionType
+from .._utils import omitting_undefined
+from .base import BaseAPI
+
+
+class IntelligentSearchAPI(BaseAPI):
+    """
+    Client for the Intelligent Search API.
+    https://developers.vtex.com/docs/api-reference/intelligent-search-api
+    """
+
+    ENVIRONMENT = "vtexcommercestable"
+
+    def search_products(
+        self,
+        product_ids: Union[list[str], UndefinedSentinel] = UNDEFINED,
+        sku_ids: Union[list[str], UndefinedSentinel] = UNDEFINED,
+        simulation_behavior: str = "skip",
+        show_sponsored: bool = True,
+        fuzzy: bool = True,
+        operator: Literal["and", "or"] = "and",
+        order_by_field: str = "release",
+        order_by_direction: OrderingDirectionType = "desc",
+        page: int = INTELLIGENT_PRODUCT_SEARCH_START_PAGE,
+        page_size: int = INTELLIGENT_PRODUCT_SEARCH_MAX_PAGE_SIZE,
+        **kwargs: Any,
+    ) -> VTEXPaginatedItemsResponse[Any, Any]:
+        """
+        Search for products in the catalog.
+        """
+        if product_ids and sku_ids:
+            raise ValueError("You can only search by product IDs or SKU IDs, not both.")
+
+        q: Union[str, UndefinedSentinel] = UNDEFINED
+        if isinstance(product_ids, list) and product_ids:
+            q = f"product.id:{';'.join([str(id) for id in product_ids])}"
+        elif isinstance(sku_ids, list) and sku_ids:
+            q = f"sku.id:{';'.join([str(id) for id in sku_ids])}"
+
+        return self._request(
+            method="GET",
+            endpoint="/api/io/_v/api/intelligent-search/product_search/",
+            environment=self.ENVIRONMENT,
+            params=omitting_undefined({
+                "q": q,
+                "simulationBehavior": simulation_behavior,
+                "showSponsored": show_sponsored,
+                "fuzzy": fuzzy,
+                "operator": operator,
+                "sort": f"{order_by_field}:{order_by_direction}",
+                "page": max(page, INTELLIGENT_PRODUCT_SEARCH_START_PAGE),
+                "count": max(
+                    min(page_size, INTELLIGENT_PRODUCT_SEARCH_MAX_PAGE_SIZE),
+                    MIN_PAGE_SIZE,
+                ),
+            }),
+            config=self.client.config.with_overrides(**kwargs),
+            response_class=VTEXPaginatedItemsResponse[Any, Any],
+        )

vtex/_constants.py

@@ -56,6 +56,10 @@ DEFAULT_LOG_5XX = WARNING
 # Generics
 MIN_PAGE_SIZE = 1
 
+# Intelligent Search
+INTELLIGENT_PRODUCT_SEARCH_START_PAGE = 1
+INTELLIGENT_PRODUCT_SEARCH_MAX_PAGE_SIZE = 100
+
 # Catalog
 LIST_SKU_IDS_START_PAGE = 1
 LIST_SKU_IDS_MAX_PAGE_SIZE = 1_000

vtex/_dto.py

@@ -91,6 +91,8 @@ class VTEXItemsResponse(VTEXDataResponse[DataType], Generic[DataType, ItemType])
             items = data["items"]
         elif isinstance(data, dict) and isinstance(data.get("data"), list):
             items = data["data"]
+        elif isinstance(data, dict) and isinstance(data.get("products"), list):
+            items = data["products"]
         else:
             raise ValueError(f"Not a valid items response: {data}")
 
@@ -135,6 +137,11 @@ class VTEXPagination(BaseModel):
             page_size = data["size"]
             pages = data["total_page"]
             page = data["page"]
+        elif isinstance(data, dict) and data.get("pagination"):
+            total = data["records_filtered"]
+            page_size = data["pagination"]["per_page"]
+            pages = data["pagination"]["count"]
+            page = data["pagination"]["current"]["index"]
         elif "rest-content-range" in response_headers:
             request_pagination = request_headers["rest-range"].split("=")[-1].split("-")
             response_pagination = response_headers["rest-content-range"].split(" ")[-1]

vtex/_vtex.py

@@ -9,6 +9,7 @@ if TYPE_CHECKING:
         CatalogAPI,
         CheckoutAPI,
         CustomAPI,
+        IntelligentSearchAPI,
         LicenseManagerAPI,
         LogisticsAPI,
         MasterDataAPI,
@@ -53,6 +54,12 @@ class VTEX:
 
         return CheckoutAPI(client=self)
 
+    @cached_property
+    def intelligent_search(self) -> "IntelligentSearchAPI":
+        from ._api import IntelligentSearchAPI
+
+        return IntelligentSearchAPI(client=self)
+
     @cached_property
     def license_manager(self) -> "LicenseManagerAPI":
         from ._api import LicenseManagerAPI

{vtexpy-0.0.0b38.dist-info → vtexpy-0.0.0b39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vtexpy
-Version: 0.0.0b38
+Version: 0.0.0b39
 Summary: Unofficial VTEX API's Python SDK
 Project-URL: homepage, https://github.com/lvieirajr/vtex-python
 Project-URL: repository, https://github.com/lvieirajr/vtex-python

{vtexpy-0.0.0b38.dist-info → vtexpy-0.0.0b39.dist-info}/RECORD

@@ -1,19 +1,20 @@
 vtex/__init__.py,sha256=SLnqpZa19ISSQ9LDaCVLDAj-OxFlgVkQyEknydu20VU,636
 vtex/_config.py,sha256=EhvVHgby0PY4rdIlKbWsH8y3fugDoxaQCCOLahzQY1w,12301
-vtex/_constants.py,sha256=Oijo8dlWaC9m_liGlqFMWdh0HN7pPtFs75sTA2CjJOA,2047
-vtex/_dto.py,sha256=6CSgQfQp94tA5M9rKxgWf_ftRyoZB804iABIpB5Ff6Y,6479
+vtex/_constants.py,sha256=xf6xlpu9tvtRHGQXPp38WIvw5xQA3DDY8VVuD7Ogpd8,2158
+vtex/_dto.py,sha256=78PamXGpmaSoGzh8yVDGpZPk_NBsPglzFilP8dDDKas,6866
 vtex/_exceptions.py,sha256=dNRhdk6k4capnsUSHPOKsvACwLfG8cwTNXltao3t344,2152
 vtex/_logging.py,sha256=zahPJIk10YvNs6qoNqhUy7OoDG7dr634CPwiGjT0aEk,2246
 vtex/_sentinels.py,sha256=HLkYBJVHTx9GoyACPO1SuINaGlU2YiqOPuFXUa7iG8A,1120
 vtex/_types.py,sha256=xrqHzmrc0IhE5fc1aGf0StCm3BQbVFyk3LG4Hd7Wd2Q,631
 vtex/_utils.py,sha256=GHNxlqBs73KXHN8Aejh7dT9dhFLhBk13EN-9nIEaimk,3413
-vtex/_vtex.py,sha256=IBPVQ__xiQGJEoht4oCnd-pAYKNJDrKoU06yieQL84o,2342
+vtex/_vtex.py,sha256=EzoeKbZl7A3L7h27x8-RwhYh3-TD0snLtfaBR3OSis4,2551
 vtex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vtex/_api/__init__.py,sha256=2OarRhTDq1Oj65v7WkMr3Bi7EAnQMPm2Ypgv9flzE6c,385
+vtex/_api/__init__.py,sha256=MPOCizaeIYfdKr5xv23QuLc3ouyJiYOohUYkwJ19uPk,438
 vtex/_api/base.py,sha256=Pjww58gnM31C7Oo0AC_TNOcqLM8mSmfk2kQfnVyaQnQ,7079
-vtex/_api/catalog.py,sha256=UaVWI9Vhhu6wHejO851hVSDmcLUDtfwcnsGasZGEKiw,4661
+vtex/_api/catalog.py,sha256=vfUHWd6lbRyivszzgIIexJB-bt2mpBLZLfQZAJAcngg,4667
 vtex/_api/checkout.py,sha256=ViFJq2GZRAA6yyjaFC3rz0oMYKxzBIsi8tzGKCWRxQ0,1693
 vtex/_api/custom.py,sha256=3yIwTj1Ikf30oq0GzdNz0P9APYxjBeoRvdlbh0rT9gs,2930
+vtex/_api/intelligent_search.py,sha256=28BbxveOyd-7xaQ_ynxBSNX1H5t9fsOvxnBPllE-OB8,2596
 vtex/_api/license_manager.py,sha256=GAdRpizeGUFem-up-SYNzehs5uBY0elTElJ9bEQUlFo,2805
 vtex/_api/logistics.py,sha256=bd55wipbnql3OFnDCBsjP0-jp7OY6FP10Yz5acOsG2o,5052
 vtex/_api/master_data.py,sha256=HGoWr908iQYb0kzq_KNvKyWKtaNQ9vTv7CXxvKey0AM,2046
@@ -25,7 +26,7 @@ vtex/_api/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vtex/_api/types/catalog.py,sha256=O_qLoiGMyBxRdmxPclbbPobUxJSzViqzHiKf8tgfm_I,394
 vtex/_api/types/generic.py,sha256=m1lFTPeyBNi-K0shvK4uxE5SUyvhTTX_5Ls2VockkdI,344
 vtex/_api/types/license_manager.py,sha256=KYISnKdQ548g6x5cNieoaN6gh9C1LQVFv4sH-II1maI,1015
-vtexpy-0.0.0b38.dist-info/METADATA,sha256=EQBUUi5vJFS_XPvM53nMqvDaYhagsbBi-CIIhD7t5vQ,3408
-vtexpy-0.0.0b38.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-vtexpy-0.0.0b38.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-vtexpy-0.0.0b38.dist-info/RECORD,,
+vtexpy-0.0.0b39.dist-info/METADATA,sha256=iyWH9ndOiB63tQmiBNdRKhWmLn8FGdSXvMynocuP0NM,3408
+vtexpy-0.0.0b39.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+vtexpy-0.0.0b39.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+vtexpy-0.0.0b39.dist-info/RECORD,,