prestashop-webservice 0.3.0__py3-none-any.whl

prestashop_webservice/params.py

@@ -0,0 +1,77 @@
+from dataclasses import dataclass
+from enum import Enum
+
+
+class SortOrder(Enum):
+    ASC = "ASC"
+    DESC = "DESC"
+
+
+@dataclass
+class Sort:
+    field: str
+    order: SortOrder
+
+
+@dataclass
+class Params:
+    """
+    Usage:
+        params = Params(
+            filter={"id_customer": "123"},
+            sort=Sort(field="date_add", order=SortOrder.DESC),
+            display=["id", "total_paid"],
+            limit=10
+        )
+    """
+
+    filter: dict | None = None
+    sort: Sort | None = None
+    display: list[str] | None = None
+    limit: int | None = None
+    date: bool | None = None
+
+    def to_dict(self) -> dict:
+        """Convert Params to a dictionary suitable for query parameters."""
+        params_dict = {}
+
+        # Add filters
+        if self.filter:
+            for key, value in self.filter.items():
+                # If value already has brackets (date ranges), don't add more
+                if isinstance(value, str) and value.startswith("[") and value.endswith("]"):
+                    params_dict[f"filter[{key}]"] = value
+                else:
+                    params_dict[f"filter[{key}]"] = f"[{value}]"
+
+        # Add sorting
+        if self.sort:
+            params_dict["sort"] = f"[{self.sort.field}_{self.sort.order.value}]"
+
+        # Add display fields
+        if self.display:
+            if "full" in self.display:
+                params_dict["display"] = "full"
+            else:
+                params_dict["display"] = f"[{','.join(self.display)}]"
+
+        # Add limit
+        if self.limit is not None:
+            params_dict["limit"] = str(self.limit)
+
+        ## Add date flag
+        if self.date is not None:
+            params_dict["date"] = "1" if self.date else "0"
+
+        return params_dict
+
+    def __hash__(self) -> int:
+        """Custom hash implementation to make Params hashable for caching purposes."""
+        return hash(
+            (
+                frozenset(self.filter.items()) if self.filter else None,
+                (self.sort.field, self.sort.order) if self.sort else None,
+                tuple(self.display) if self.display else None,
+                self.limit,
+            )
+        )

prestashop_webservice/product.py

@@ -0,0 +1,54 @@
+from typing import cast
+
+from prestashop_webservice.base_model import BaseModel
+from prestashop_webservice.models import ProductData
+from prestashop_webservice.params import Params
+
+
+class Product(BaseModel):
+    """Complex queries for products endpoint."""
+
+    _data_class = ProductData
+
+    def get_by_id(self, product_id: str) -> ProductData:
+        """Get product by ID."""
+        return cast(ProductData, self._query(f"products/{product_id}", None, "product"))
+
+    def get_by_category(self, category_id: str, limit: int = 50) -> list[ProductData]:
+        """Get products by category."""
+        params = Params(
+            filter={"id_category_default": category_id},
+            display=["id", "name", "reference", "price", "id_category_default"],
+            limit=limit,
+        )
+        return cast(list[ProductData], self._query("products", params, "products"))
+
+    def get_by_reference(self, reference: str) -> ProductData | None:
+        """Get product by reference."""
+        params = Params(
+            filter={"reference": reference},
+            display=["id", "reference", "name", "price"],
+        )
+        products = cast(list[ProductData], self._query("products", params, "products"))
+        return products[0] if products else None
+
+    def get_active(self, limit: int = 100) -> list[ProductData]:
+        """Get active products."""
+        params = Params(
+            filter={"active": "1"},
+            display=["id", "name", "reference", "active"],
+            limit=limit,
+        )
+        return cast(list[ProductData], self._query("products", params, "products"))
+
+    def get_image_url(self, product_id: str) -> str:
+        """Get the default image URL for a product."""
+        product = self.get_by_id(product_id)
+        img_id = str(product.id_default_image or "").strip()
+        slug = str(product.link_rewrite or "").strip()
+
+        if not (img_id and slug):
+            return ""
+
+        base_url = self.client.base_url
+        return f"{base_url}/{img_id}-large_default/{slug}.jpg"

prestashop_webservice/py.typed

@@ -0,0 +1,2 @@
+# Marker file for PEP 561
+# This file indicates that the package supports type checking

prestashop_webservice/state.py

@@ -0,0 +1,12 @@
+from prestashop_webservice.base_model import BaseModel
+from prestashop_webservice.models import StateData
+
+
+class State(BaseModel):
+    """Complex queries for states endpoint."""
+
+    _data_class = StateData
+
+    def get_by_id(self, state_id: str) -> StateData:
+        """Get state by ID (geographic state/province)."""
+        return self._query(f"states/{state_id}", None, "state")

prestashop_webservice-0.3.0.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: prestashop-webservice
+Version: 0.3.0
+Summary: Webservice client for PrestaShop API
+Author-email: Nestor Villa <nestorvilla@patitasco.com>, Manolo Corte <manolocorte@patitasco.com>
+License: MIT License
+        
+        Copyright (c) 2025 Patitas and Co
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Documentation, https://github.com/patitas-and-co/prestashop-webservice/blob/main/README.md
+Project-URL: Repository, https://github.com/patitas-and-co/prestashop-webservice
+Keywords: prestashop,api,client,webservice,rest
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx
+Requires-Dist: cachetools
+Requires-Dist: loguru
+Requires-Dist: pre-commit
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# PrestaShop Webservice
+
+Python client for PrestaShop API with caching, logging, and type hints.
+
+## Installation
+
+```bash
+pip install prestashop-webservice
+```
+
+## Quick Start
+
+```python
+from prestashop_webservice import Client, Params, Sort, SortOrder
+
+# Initialize client
+client = Client(
+    prestashop_base_url="https://your-store.com/api",
+    prestashop_ws_key="YOUR_API_KEY"
+)
+
+# Simple queries
+order = client.query_order(order_id="123")
+customer = client.query_customer(customer_id="456")
+
+# Advanced queries with parameters
+params = Params(
+    filter={"id_customer": "123"},
+    sort=Sort(field="date_add", order=SortOrder.DESC),
+    display=["id", "total_paid", "reference"],
+    limit=10
+)
+orders = client.query_orders(params=params)
+```
+
+## Features
+
+- 🚀 HTTP client with connection pooling
+- 💾 Automatic caching (24h TTL)
+- 📝 Logging with Loguru
+- 🎯 Full type hints
+- 🔒 Singleton pattern
+
+## Available Methods
+
+- `query_order()`, `query_orders()`, `exists_order()`
+- `query_customer()`, `query_customers()`
+- `query_product()`, `query_address()`, `query_country()`
+- `query_order_carriers()`, `query_order_histories()`, `query_order_state()`
+
+## License
+
+MIT License - See [LICENSE](LICENSE) file for details.

prestashop_webservice-0.3.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+prestashop_webservice/__init__.py,sha256=bO9RuLEm-NZH5rvTocgJLzbhReshGdYpnF_m3ajD4tU,2175
+prestashop_webservice/address.py,sha256=Q7RUL2oN7Y0OCmo68N5n-iSrKbWSJfIrfhiDc44HkhY,1086
+prestashop_webservice/base_model.py,sha256=jLlmoCBPq2i0Yzve5O0fKGjgCAzXoUvhY2pUMS5nAcw,4332
+prestashop_webservice/carrier.py,sha256=Essfzkc347EHLz1JizhkvC8Pld2WDXz8opwgk37iuQ0,1302
+prestashop_webservice/client.py,sha256=JhmDA57jVsMJWlsWf-UnAXQCCrAkm3p3wLbMhc1AqoE,7041
+prestashop_webservice/combination.py,sha256=q-nvpeV4EmZJz1Sgbn9zuQc5PeBS9XPnmPw3ht42HUA,1078
+prestashop_webservice/config.py,sha256=_eW1l-9H4JYf_5ASkYngJOJdCt0M57GtfjjqpuOIlCE,163
+prestashop_webservice/country.py,sha256=u45oqOk2HMGWQK2TRSLeGU1IbY06H0cPqyK_msD___s,1056
+prestashop_webservice/customer.py,sha256=19zdBOwRvY9x5tQVG39dAfjT-bova3KQxL3hLgkxjzY,1579
+prestashop_webservice/customer_message.py,sha256=AHtPEU2ZcaltUE22AbJN5Ng75OjBonGah96FQ5BrCMY,1255
+prestashop_webservice/customer_thread.py,sha256=0EFv7IpyGbj4udBQeqvkJNi-c4aUVI6GZVDXaXLpXy0,1034
+prestashop_webservice/image_product.py,sha256=ISJ_3ZIPInSEmaVRc70sfngoiEpH0Lw4r2cWnZ0nqBw,427
+prestashop_webservice/logger.py,sha256=LMFUQIX7r2BA1LtL2Ryq2I3SR07-UzfuP7TEDeLoVl4,627
+prestashop_webservice/models.py,sha256=gJT37vkw0rcVy8pVNucn9k56hTziBs3pp7XoAwIMP-I,12742
+prestashop_webservice/order.py,sha256=iLtqvoxksxqQhBEpMGk9SIl1Bb-wRW_6-e5K8AionMU,4379
+prestashop_webservice/order_carrier.py,sha256=GNUtQjC21aL0VEetcU5QtvaVq5Ej1qgFbF-m-c_kKLQ,1305
+prestashop_webservice/order_detail.py,sha256=VzJA1YUQGYliC0gb-p_yDcOwVOcvoaDWgCc-GS-wQe8,1125
+prestashop_webservice/order_history.py,sha256=PrmpA31z9DYoVAWjGqcfVEOuNNnHvCYOI4bkMkH9iFI,2330
+prestashop_webservice/order_state.py,sha256=9ponPxriu4YoNNLDEitMuRntItfAVOJxEjIkDwpd0QE,401
+prestashop_webservice/params.py,sha256=KUcqnWVrrGxjghV0LAbrMC3cBhAIA2sjQzm5Ccn8i2c,2166
+prestashop_webservice/product.py,sha256=2XjqpuxmxwmR00D-2hhbtjUdvTAP5oc1jyAAwnnYxD4,2036
+prestashop_webservice/py.typed,sha256=WJtVGe64tcQSssSo4RD7zCf_3u7X2BmFCWDCroWOcaQ,88
+prestashop_webservice/state.py,sha256=Iub8Ooe_dxY-LuUosTDbSxtADicQIT9RRwJz80pZJDc,385
+prestashop_webservice-0.3.0.dist-info/licenses/LICENSE,sha256=mbRCKL3jFTGOJiU0MXMXeRWO439mLko7y5s_f5hQfb0,1071
+prestashop_webservice-0.3.0.dist-info/METADATA,sha256=0TTzHvteRxZt8lxkmJeQojDpkbpfivHF4Ekxhm4NQ1w,3315
+prestashop_webservice-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+prestashop_webservice-0.3.0.dist-info/top_level.txt,sha256=W57_kSLnXlqYufTCGD5fuq6CceW0D_Tcgr5B7LU5wHA,22
+prestashop_webservice-0.3.0.dist-info/RECORD,,

prestashop_webservice-0.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

prestashop_webservice-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Patitas and Co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

prestashop_webservice-0.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+prestashop_webservice