ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/buyers.py

@@ -0,0 +1,164 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Buyers API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.buyer import Buyer, BuyerSupplier
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["BuyersResource"]
+
+
+class BuyersResource(BaseResource):
+    """Operations on OrderCloud Buyers."""
+
+    async def list(
+        self,
+        *,
+        search: Optional[str] = None,
+        search_on: Optional[str] = None,
+        sort_by: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+        filters: Optional[dict[str, Any]] = None,
+    ) -> ListPage[Buyer]:
+        """List buyers
+
+        Args:
+            search: Word or phrase to search for.
+            search_on: Comma-delimited list of fields to search on.
+            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 Buyer objects.
+        """
+        params = self._build_list_params(
+            search=search,
+            search_on=search_on,
+            sort_by=sort_by,
+            page=page,
+            page_size=page_size,
+            filters=filters,
+        )
+        resp = await self._http.get("/buyers", **params)
+        return self._parse_list(resp.json(), Buyer)
+
+    async def create(
+        self,
+        buyer: Union[Buyer, dict[str, Any]],
+    ) -> Buyer:
+        """Create a buyer
+
+        Args:
+            buyer: A ``Buyer`` model or dict. Required fields: Name.
+
+        Returns:
+            The Buyer object.
+        """
+        resp = await self._http.post("/buyers", json=self._serialize(buyer))
+        return Buyer(**resp.json())
+
+    async def get(
+        self,
+        buyer_id: str,
+    ) -> Buyer:
+        """Retrieve a buyer
+
+        Args:
+            buyer_id: ID of the buyer.
+
+        Returns:
+            The Buyer object.
+        """
+        resp = await self._http.get(f"/buyers/{buyer_id}")
+        return Buyer(**resp.json())
+
+    async def save(
+        self,
+        buyer_id: str,
+        buyer: Union[Buyer, dict[str, Any]],
+    ) -> Buyer:
+        """Create or update a buyer
+
+        Args:
+            buyer_id: ID of the buyer.
+            buyer: A ``Buyer`` model or dict. Required fields: Name.
+
+        Returns:
+            The Buyer object.
+        """
+        resp = await self._http.put(
+            f"/buyers/{buyer_id}",
+            json=self._serialize(buyer),
+        )
+        return Buyer(**resp.json())
+
+    async def delete(
+        self,
+        buyer_id: str,
+    ) -> None:
+        """Delete a buyer
+
+        Args:
+            buyer_id: ID of the buyer.
+        """
+        await self._http.delete(f"/buyers/{buyer_id}")
+
+    async def patch(
+        self,
+        buyer_id: str,
+        partial: dict[str, Any],
+    ) -> Buyer:
+        """Partially update a buyer
+
+        Args:
+            buyer_id: ID of the buyer.
+            partial: A dict of fields to update.
+
+        Returns:
+            The Buyer object.
+        """
+        resp = await self._http.patch(f"/buyers/{buyer_id}", json=partial)
+        return Buyer(**resp.json())
+
+    async def list_buyer_sellers(
+        self,
+        buyer_id: str,
+        *,
+        search: Optional[str] = None,
+        search_on: Optional[str] = None,
+        sort_by: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+        filters: Optional[dict[str, Any]] = None,
+    ) -> ListPage[BuyerSupplier]:
+        """List sellers this buyer can purchase from
+
+        Args:
+            buyer_id: ID of the buyer.
+            search: Word or phrase to search for.
+            search_on: Comma-delimited list of fields to search on.
+            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 BuyerSupplier objects.
+        """
+        params = self._build_list_params(
+            search=search,
+            search_on=search_on,
+            sort_by=sort_by,
+            page=page,
+            page_size=page_size,
+            filters=filters,
+        )
+        resp = await self._http.get(f"/buyers/{buyer_id}/sellers", **params)
+        return self._parse_list(resp.json(), BuyerSupplier)