prestashop-webservice 0.3.0__py3-none-any.whl

prestashop_webservice/models.py

@@ -0,0 +1,448 @@
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass
+class OrderData:
+    """Order resource data."""
+
+    id: int
+    # Core fields
+    id_customer: int | None = None
+    id_cart: int | None = None
+    id_currency: int | None = None
+    id_lang: int | None = None
+    id_address_delivery: int | None = None
+    id_address_invoice: int | None = None
+    id_carrier: int | None = None
+    id_shop: int | None = None
+    id_shop_group: int | None = None
+    current_state: int | None = None
+    reference: str | None = None
+    secure_key: str | None = None
+    payment: str | None = None
+    module: str | None = None
+    # Totals
+    total_paid: str | None = None
+    total_paid_tax_incl: str | None = None
+    total_paid_tax_excl: str | None = None
+    total_paid_real: str | None = None
+    total_products: str | None = None
+    total_products_wt: str | None = None
+    total_shipping: str | None = None
+    total_shipping_tax_incl: str | None = None
+    total_shipping_tax_excl: str | None = None
+    total_discounts: str | None = None
+    total_discounts_tax_incl: str | None = None
+    total_discounts_tax_excl: str | None = None
+    total_wrapping: str | None = None
+    total_wrapping_tax_incl: str | None = None
+    total_wrapping_tax_excl: str | None = None
+    # Other fields
+    carrier_tax_rate: str | None = None
+    conversion_rate: str | None = None
+    round_mode: int | None = None
+    round_type: int | None = None
+    invoice_number: str | None = None
+    invoice_date: str | None = None
+    delivery_number: str | None = None
+    delivery_date: str | None = None
+    shipping_number: str | None = None
+    note: str | None = None
+    valid: int | None = None
+    date_add: str | None = None
+    date_upd: str | None = None
+    associations: dict[str, Any] | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class CustomerData:
+    """Customer resource data."""
+
+    id: int
+    # Core fields
+    id_default_group: int | None = None
+    id_lang: int | None = None
+    id_shop: int | None = None
+    id_shop_group: int | None = None
+    email: str | None = None
+    firstname: str | None = None
+    lastname: str | None = None
+    active: int | None = None
+    date_add: str | None = None
+    date_upd: str | None = None
+    # Optional fields
+    id_gender: int | None = None
+    birthday: str | None = None
+    newsletter: int | None = None
+    optin: int | None = None
+    website: str | None = None
+    company: str | None = None
+    siret: str | None = None
+    ape: str | None = None
+    outstanding_allow_amount: str | None = None
+    max_payment_days: int | None = None
+    note: str | None = None
+    secure_key: str | None = None
+    # Extra fields from API
+    passwd: str | None = None
+    last_passwd_gen: str | None = None
+    newsletter_date_add: str | None = None
+    reset_password_validity: str | None = None
+    associations: dict[str, Any] | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class ProductData:
+    """Product resource data."""
+
+    id: int
+    # Core fields
+    id_manufacturer: int | None = None
+    id_supplier: int | None = None
+    id_category_default: int | None = None
+    id_shop_default: int | None = None
+    id_tax_rules_group: int | None = None
+    id_default_image: int | None = None  # Default product image
+    id_default_combination: int | None = None  # Default product combination
+    reference: str | None = None
+    name: str | None = None
+    manufacturer_name: str | None = None
+    price: str | None = None
+    active: int | None = None
+    date_add: str | None = None
+    date_upd: str | None = None
+    # Optional fields
+    ean13: str | None = None
+    isbn: str | None = None
+    upc: str | None = None
+    mpn: str | None = None
+    supplier_reference: str | None = None
+    location: str | None = None
+    width: str | None = None
+    height: str | None = None
+    depth: str | None = None
+    weight: str | None = None
+    quantity: int | None = None
+    description: str | None = None
+    description_short: str | None = None
+    available_for_order: int | None = None
+    condition: str | None = None
+    show_price: int | None = None
+    indexed: int | None = None
+    visibility: str | None = None
+    cache_default_attribute: int | None = None
+    advanced_stock_management: int | None = None
+    available_date: str | None = None
+    type: str | None = None
+    state: int | None = None
+    # Extra fields from API
+    additional_shipping_cost: str | None = None
+    ecotax: str | None = None
+    link_rewrite: str | None = None
+    meta_description: str | None = None
+    meta_title: str | None = None  # Meta title for SEO
+    minimal_quantity: int | None = None  # Minimum purchase quantity
+    pack_stock_type: int | None = None  # Stock type for packs
+    position_in_category: int | None = None
+    product_type: str | None = None
+    redirect_type: str | None = None  # Redirect type (404, etc)
+    unit_price: str | None = None
+    unit_price_ratio: str | None = None
+    wholesale_price: str | None = None
+    additional_delivery_times: int | None = None  # Delivery times option
+    associations: dict[str, Any] | None = None
+    cache_is_pack: int | None = None
+    low_stock_threshold: int | None = None
+    unity: str | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class AddressData:
+    """Address resource data."""
+
+    id: int
+    # All fields optional except id
+    id_customer: int | None = None
+    id_country: int | None = None
+    alias: str | None = None
+    lastname: str | None = None
+    firstname: str | None = None
+    address1: str | None = None
+    city: str | None = None
+    postcode: str | None = None
+    date_add: str | None = None
+    date_upd: str | None = None
+    id_manufacturer: int | None = None
+    id_supplier: int | None = None
+    id_warehouse: int | None = None
+    id_state: int | None = None
+    company: str | None = None
+    vat_number: str | None = None
+    address2: str | None = None
+    phone: str | None = None
+    phone_mobile: str | None = None
+    dni: str | None = None
+    deleted: int | None = None
+    other: str | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class CountryData:
+    """Country resource data."""
+
+    id: int
+    # All fields optional except id
+    id_zone: int | None = None
+    iso_code: str | None = None
+    name: str | None = None
+    active: int | None = None
+    call_prefix: int | None = None
+    contains_states: int | None = None
+    need_identification_number: int | None = None
+    need_zip_code: int | None = None
+    zip_code_format: str | None = None
+    display_tax_label: int | None = None
+    id_currency: int | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class CarrierData:
+    """Carrier resource data."""
+
+    id: int
+    deleted: int | None = None
+    is_module: int | None = None
+    id_tax_rules_group: int | None = None
+    id_reference: int | None = None
+    name: str | None = None
+    active: int | None = None
+    is_free: int | None = None
+    url: str | None = None
+    shipping_handling: int | None = None
+    shipping_external: int | None = None
+    range_behavior: int | None = None
+    shipping_method: int | None = None
+    max_width: int | None = None
+    max_height: int | None = None
+    max_depth: int | None = None
+    max_weight: str | None = None
+    grade: int | None = None
+    external_module_name: str | None = None
+    need_range: int | None = None
+    position: int | None = None
+    delay: str | dict[str, Any] | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class OrderCarrierData:
+    """Order carrier resource data."""
+
+    id: int
+    # All fields optional except id
+    id_order: int | None = None
+    id_carrier: int | None = None
+    id_order_invoice: int | None = None
+    weight: str | None = None
+    shipping_cost_tax_excl: str | None = None
+    shipping_cost_tax_incl: str | None = None
+    tracking_number: str | None = None
+    date_add: str | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class OrderHistoryData:
+    """Order history resource data."""
+
+    id: int
+    # All fields optional except id
+    id_order: int | None = None
+    id_order_state: int | None = None
+    id_employee: int | None = None
+    date_add: str | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class OrderStateData:
+    """Order state resource data."""
+
+    id: int
+    # All fields optional except id
+    name: str | None = None
+    color: str | None = None
+    unremovable: int | None = None
+    send_email: int | None = None
+    module_name: str | None = None
+    invoice: int | None = None
+    # Extra from API
+    template: str | None = None
+    # Fields that may not come
+    deleted: int | None = None
+    delivery: int | None = None
+    hidden: int | None = None
+    logable: int | None = None
+    paid: int | None = None
+    pdf_delivery: int | None = None
+    pdf_invoice: int | None = None
+    shipped: int | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class StateData:
+    """State/Province resource data."""
+
+    id: int
+    # All fields optional except id
+    id_country: int | None = None
+    id_zone: int | None = None
+    name: str | None = None
+    iso_code: str | None = None
+    active: int | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class ImageProductData:
+    """Product image resource data."""
+
+    id: int
+    # All fields optional except id
+    id_product: int | None = None
+    position: int | None = None
+    cover: int | None = None
+    legend: str | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class CombinationData:
+    """Combination resource data."""
+
+    id: int
+    # All fields optional except id
+    id_product: int | None = None
+    ean13: str | None = None
+    reference: str | None = None
+    wholesale_price: str | None = None
+    price: str | None = None
+    ecotax: str | None = None
+    weight: str | None = None
+    unit_price_impact: str | None = None
+    minimal_quantity: int | None = None
+    low_stock_threshold: int | None = None
+    default_on: int | None = None
+    available_date: str | None = None
+    associations: dict[str, Any] | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class CustomerMessageData:
+    """Customer message resource data."""
+
+    id: int
+    id_customer_thread: int | None = None
+    id_employee: int | None = None
+    message: str | None = None
+    file_name: str | None = None
+    ip_address: str | None = None
+    user_agent: str | None = None
+    date_add: str | None = None
+    date_upd: str | None = None
+    private: int | None = None
+    read: int | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class OrderDetailData:
+    """Order detail resource data."""
+
+    id: int
+    id_order: int | None = None
+    product_id: int | None = None
+    product_attribute_id: int | None = None
+    product_name: str | None = None
+    product_quantity: int | None = None
+    product_price: str | None = None
+    product_reference: str | None = None
+    total_price_tax_incl: str | None = None
+    total_price_tax_excl: str | None = None
+    unit_price_tax_incl: str | None = None
+    unit_price_tax_excl: str | None = None
+    original_product_price: str | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass
+
+
+@dataclass
+class CustomerThreadData:
+    """Customer thread resource data."""
+
+    id: int
+    id_shop: int | None = None
+    id_lang: int | None = None
+    id_contact: int | None = None
+    id_customer: int | None = None
+    id_order: int | None = None
+    id_product: int | None = None
+    status: str | None = None
+    email: str | None = None
+    token: str | None = None
+    date_add: str | None = None
+    date_upd: str | None = None
+    associations: dict[str, Any] | None = None
+
+    def __post_init__(self, **kwargs):
+        """Ignore extra fields from API."""
+        pass

prestashop_webservice/order.py

@@ -0,0 +1,114 @@
+from prestashop_webservice.base_model import BaseModel
+from prestashop_webservice.models import OrderData
+from prestashop_webservice.params import Params
+
+
+class Order(BaseModel):
+    """Complex queries for orders endpoint."""
+
+    _data_class = OrderData
+
+    def get_by_id(self, order_id: str) -> OrderData:
+        """Get order by ID."""
+        return self._query(f"orders/{order_id}", None, "order")
+
+    def exists(self, order_id: str) -> bool:
+        """Check if order exists by ID."""
+        try:
+            self.get_by_id(order_id)
+            return True
+        except Exception:
+            return False
+
+    def get_by_reference(self, reference: str) -> OrderData | None:
+        """Get order by reference."""
+        params = Params(
+            filter={"reference": reference},
+            display=["id", "reference", "total_paid", "current_state", "id_customer"],
+        )
+        orders: list[OrderData] = self._query("orders", params, "orders")
+        return orders[0] if orders else None
+
+    def get_by_customer(self, customer_id: str, limit: int = 999) -> list[OrderData]:
+        """Get all orders for a customer."""
+        params = Params(
+            filter={"id_customer": customer_id},
+            display=["id", "id_customer", "date_add", "total_paid", "reference"],
+            limit=limit,
+        )
+        return self._query("orders", params, "orders")
+
+    def get_latest_by_customer(self, customer_id: str) -> OrderData | None:
+        """Get the most recent order for a customer."""
+        params = Params(
+            filter={"id_customer": customer_id},
+            display=["id", "id_customer", "date_add", "total_paid", "reference"],
+            limit=1,
+        )
+        orders: list[OrderData] = self._query("orders", params, "orders")
+        return orders[0] if orders else None
+
+    def get_recent(self, limit: int = 10) -> list[OrderData]:
+        """Get recent orders."""
+        params = Params(
+            display=["id", "reference", "total_paid", "date_add", "id_customer"],
+            limit=limit,
+        )
+        return self._query("orders", params, "orders")  # type: ignore
+
+    def get_by_status(self, status_id: str, limit: int = 100) -> list[OrderData]:
+        """Get orders by status."""
+        params = Params(
+            filter={"current_state": status_id},
+            display=["id", "current_state", "reference", "date_add"],
+            limit=limit,
+        )
+        return self._query("orders", params, "orders")
+
+    def get_shipped_orders(
+        self, start_date: str = "2025-11-10", end_date: str = "3500-12-11"
+    ) -> list[OrderData]:
+        """Get orders with shipped status."""
+        params = Params(
+            filter={"current_state": "4", "date_add": f"[{start_date},{end_date}]"},
+            display=["id", "shipping_number"],
+            date=True,
+        )
+        return self._query("orders", params, "orders")
+
+    def get_total_wrapping(self, order_id: str) -> str | None:
+        """Get total wrapping (donation) for an order."""
+        order = self.get_by_id(order_id)
+        return order.total_wrapping
+
+    def get_total_shipping(self, order_id: str) -> str | None:
+        """Get total shipping cost for an order."""
+        order = self.get_by_id(order_id)
+        return order.total_shipping
+
+    def get_total_discounts(self, order_id: str) -> str | None:
+        """Get total discounts for an order."""
+        order = self.get_by_id(order_id)
+        return order.total_discounts
+
+    def get_all_orders_since(
+        self, start_date: str = "2025-11-10", end_date: str = "3500-12-11"
+    ) -> list[OrderData]:
+        """Get all orders since a specific date."""
+        params = Params(
+            filter={"date_add": f"[{start_date},{end_date}]"},
+            display=["id", "reference", "date_add", "current_state", "total_paid"],
+            date=True,
+        )
+        return self._query("orders", params, "orders")
+
+    def get_orders_available_at_pickup_point(
+        self, start_date: str = "2025-11-10", end_date: str = "3500-12-11"
+    ) -> list[OrderData]:
+        """Get orders with shipped status."""
+        params = Params(
+            filter={"current_state": "41", "date_add": f"[{start_date},{end_date}]"},
+            display=["id", "shipping_number"],
+            date=True,
+        )
+        return self._query("orders", params, "orders")

prestashop_webservice/order_carrier.py

@@ -0,0 +1,33 @@
+from prestashop_webservice.base_model import BaseModel
+from prestashop_webservice.models import OrderCarrierData
+from prestashop_webservice.params import Params
+
+
+class OrderCarrier(BaseModel):
+    """Complex queries for order_carriers endpoint."""
+
+    _data_class = OrderCarrierData
+
+    def get_by_order(self, order_id: str) -> list[OrderCarrierData]:
+        """Get carriers for a specific order."""
+        params = Params(
+            filter={"id_order": order_id},
+            display=["id", "id_order", "tracking_number"],
+        )
+        return self._query("order_carriers", params, "order_carriers")
+
+    def get_by_tracking(self, tracking: str) -> list[OrderCarrierData]:
+        """Find order carriers by tracking number."""
+        params = Params(
+            filter={"tracking_number": tracking},
+            display=["id", "id_order", "tracking_number"],
+        )
+        result = self._query("order_carriers", params, "order_carriers")
+        return result if result is not None else []
+
+    def get_latest_by_tracking(self, tracking: str) -> OrderCarrierData | None:
+        """Get the most recent order carrier by tracking number."""
+        carriers = self.get_by_tracking(tracking)
+        if not carriers:
+            return None
+        return max(carriers, key=lambda r: r.id)

prestashop_webservice/order_detail.py

@@ -0,0 +1,28 @@
+from prestashop_webservice.base_model import BaseModel
+from prestashop_webservice.models import OrderDetailData
+from prestashop_webservice.params import Params
+
+
+class OrderDetail(BaseModel):
+    """Complex queries for order_details endpoint."""
+
+    _data_class = OrderDetailData
+
+    def get_by_id(self, order_detail_id: str) -> OrderDetailData:
+        """Get order detail by ID."""
+        return self._query(f"order_details/{order_detail_id}", None, "order_detail")
+
+    def get_by_order(self, order_id: str) -> list[OrderDetailData]:
+        """Get details (products) for a specific order."""
+        params = Params(filter={"id_order": order_id}, display=["full"])
+        return self._query("order_details", params, "order_details")
+
+    def get_by_orders(self, order_ids: list[str]) -> list[OrderDetailData]:
+        """Get details for multiple orders."""
+        if not order_ids:
+            return []
+
+        orders_filter_value = "|".join(order_ids)
+
+        params = Params(filter={"id_order": f"[{orders_filter_value}]"}, display=["full"])
+        return self._query("order_details", params, "order_details")

prestashop_webservice/order_history.py

@@ -0,0 +1,57 @@
+from prestashop_webservice.base_model import BaseModel
+from prestashop_webservice.logger import logger
+from prestashop_webservice.models import OrderHistoryData
+from prestashop_webservice.params import Params
+
+
+class OrderHistory(BaseModel):
+    """Complex queries for order_histories endpoint."""
+
+    _data_class = OrderHistoryData
+
+    def get_by_order(self, order_id: str) -> list[OrderHistoryData]:
+        """Get history for a specific order."""
+        params = Params(
+            filter={"id_order": order_id},
+            display=["id", "id_order", "id_order_state", "date_add"],
+        )
+        return self._query("order_histories", params, "order_histories")
+
+    def get_recent_changes(self, limit: int = 20) -> list[OrderHistoryData]:
+        """Get recent order status changes."""
+        params = Params(
+            display=["id", "id_order", "id_order_state", "date_add"],
+            limit=limit,
+        )
+        return self._query("order_histories", params, "order_histories")
+
+    def get_by_status(self, status_id: str, limit: int = 100) -> list[OrderHistoryData]:
+        """Get order histories by status."""
+        params = Params(
+            filter={"id_order_state": status_id},
+            display=["id", "id_order", "id_order_state"],
+            limit=limit,
+        )
+        return self._query("order_histories", params, "order_histories")
+
+    def create(self, order_id: str, order_state_id: str, date_add: str | None = None) -> bool:
+        xml_payload = f"""<?xml version="1.0" encoding="UTF-8"?>
+        <prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
+            <order_history>
+                <id_order>{order_id}</id_order>
+                <id_order_state>{order_state_id}</id_order_state>"""
+        if date_add:
+            xml_payload += f"\n                <date_add>{date_add}</date_add>"
+        xml_payload += """
+            </order_history>
+        </prestashop>"""
+
+        logger.debug(f"Creating order history for order {order_id} with state {order_state_id}")
+
+        try:
+            self.client.post("order_histories", xml_payload)
+            logger.info(f"Order {order_id} status updated to {order_state_id}")
+            return True
+        except Exception as e:
+            logger.error(f"Failed to update order {order_id}: {e}")
+            return False

prestashop_webservice/order_state.py

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