ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/discounts.py

@@ -0,0 +1,201 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Discounts API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.assignments import DiscountAssignment
+from ..models.discount import Discount
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["DiscountsResource"]
+
+
+class DiscountsResource(BaseResource):
+    """Operations on OrderCloud Discounts."""
+
+    async def list(
+        self,
+        *,
+        sort_by: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+        filters: Optional[dict[str, Any]] = None,
+    ) -> ListPage[Discount]:
+        """List discounts
+
+        Args:
+            sort_by: Comma-delimited list of fields to sort by.
+            page: Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
+            page_size: Number of results to return per page.
+            filters: An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
+
+        Returns:
+            A paginated list of Discount objects.
+        """
+        params = self._build_list_params(
+            sort_by=sort_by,
+            page=page,
+            page_size=page_size,
+            filters=filters,
+        )
+        resp = await self._http.get("/discounts", **params)
+        return self._parse_list(resp.json(), Discount)
+
+    async def create(
+        self,
+        discount: Union[Discount, dict[str, Any]],
+    ) -> Discount:
+        """Create a discount
+
+        Args:
+            discount: A ``Discount`` model or dict. Required fields: DiscountBreaks.
+
+        Returns:
+            The Discount object.
+        """
+        resp = await self._http.post("/discounts", json=self._serialize(discount))
+        return Discount(**resp.json())
+
+    async def get(
+        self,
+        discount_id: str,
+    ) -> Discount:
+        """Retrieve a discount
+
+        Args:
+            discount_id: ID of the discount.
+
+        Returns:
+            The Discount object.
+        """
+        resp = await self._http.get(f"/discounts/{discount_id}")
+        return Discount(**resp.json())
+
+    async def save(
+        self,
+        discount_id: str,
+        discount: Union[Discount, dict[str, Any]],
+    ) -> Discount:
+        """Create or update a discount
+
+        Args:
+            discount_id: ID of the discount.
+            discount: A ``Discount`` model or dict. Required fields: DiscountBreaks.
+
+        Returns:
+            The Discount object.
+        """
+        resp = await self._http.put(
+            f"/discounts/{discount_id}",
+            json=self._serialize(discount),
+        )
+        return Discount(**resp.json())
+
+    async def delete(
+        self,
+        discount_id: str,
+    ) -> None:
+        """Delete a discount
+
+        Args:
+            discount_id: ID of the discount.
+        """
+        await self._http.delete(f"/discounts/{discount_id}")
+
+    async def patch(
+        self,
+        discount_id: str,
+        partial: dict[str, Any],
+    ) -> Discount:
+        """Partially update a discount
+
+        Args:
+            discount_id: ID of the discount.
+            partial: A dict of fields to update.
+
+        Returns:
+            The Discount object.
+        """
+        resp = await self._http.patch(f"/discounts/{discount_id}", json=partial)
+        return Discount(**resp.json())
+
+    async def delete_assignment(
+        self,
+        discount_id: str,
+        *,
+        buyer_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        buyer_group_id: Optional[str] = None,
+    ) -> None:
+        """Delete a discount assignment
+
+        Args:
+            discount_id: ID of the discount.
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+            buyer_group_id: ID of the buyer group.
+        """
+        _params: dict[str, Any] = {}
+        if buyer_id is not None:
+            _params["buyerID"] = buyer_id
+        if user_group_id is not None:
+            _params["userGroupID"] = user_group_id
+        if buyer_group_id is not None:
+            _params["buyerGroupID"] = buyer_group_id
+        await self._http.delete(f"/discounts/{discount_id}/assignments", **_params)
+
+    async def list_assignments(
+        self,
+        *,
+        discount_id: Optional[str] = None,
+        buyer_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        buyer_group_id: Optional[str] = None,
+        level: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+    ) -> ListPage[DiscountAssignment]:
+        """List discount assignments
+
+        Args:
+            discount_id: ID of the discount.
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+            buyer_group_id: ID of the buyer group.
+            level: Level of the discount assignment. Possible values: Group, Company, BuyerGroup.
+            page: Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
+            page_size: Number of results to return per page.
+
+        Returns:
+            A paginated list of DiscountAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if discount_id is not None:
+            params["discountID"] = discount_id
+        if buyer_id is not None:
+            params["buyerID"] = buyer_id
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        if buyer_group_id is not None:
+            params["buyerGroupID"] = buyer_group_id
+        if level is not None:
+            params["level"] = level
+        resp = await self._http.get("/discounts/assignments", **params)
+        return self._parse_list(resp.json(), DiscountAssignment)
+
+    async def save_assignment(
+        self,
+        discount_assignment: Union[DiscountAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update a discount assignment
+
+        Args:
+            discount_assignment: A ``DiscountAssignment`` model or dict. Required fields: DiscountID.
+        """
+        await self._http.post("/discounts/assignments", json=self._serialize(discount_assignment))