ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/suppliers.py

@@ -0,0 +1,190 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Suppliers API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.supplier import Supplier, SupplierBuyer
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["SuppliersResource"]
+
+
+class SuppliersResource(BaseResource):
+    """Operations on OrderCloud Suppliers."""
+
+    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[Supplier]:
+        """List suppliers
+
+        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 Supplier 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("/suppliers", **params)
+        return self._parse_list(resp.json(), Supplier)
+
+    async def create(
+        self,
+        supplier: Union[Supplier, dict[str, Any]],
+    ) -> Supplier:
+        """Create a supplier
+
+        Args:
+            supplier: A ``Supplier`` model or dict. Required fields: Name.
+
+        Returns:
+            The Supplier object.
+        """
+        resp = await self._http.post("/suppliers", json=self._serialize(supplier))
+        return Supplier(**resp.json())
+
+    async def get(
+        self,
+        supplier_id: str,
+    ) -> Supplier:
+        """Retrieve a supplier
+
+        Args:
+            supplier_id: ID of the supplier.
+
+        Returns:
+            The Supplier object.
+        """
+        resp = await self._http.get(f"/suppliers/{supplier_id}")
+        return Supplier(**resp.json())
+
+    async def save(
+        self,
+        supplier_id: str,
+        supplier: Union[Supplier, dict[str, Any]],
+    ) -> Supplier:
+        """Create or update a supplier
+
+        Args:
+            supplier_id: ID of the supplier.
+            supplier: A ``Supplier`` model or dict. Required fields: Name.
+
+        Returns:
+            The Supplier object.
+        """
+        resp = await self._http.put(
+            f"/suppliers/{supplier_id}",
+            json=self._serialize(supplier),
+        )
+        return Supplier(**resp.json())
+
+    async def delete(
+        self,
+        supplier_id: str,
+    ) -> None:
+        """Delete a supplier
+
+        Args:
+            supplier_id: ID of the supplier.
+        """
+        await self._http.delete(f"/suppliers/{supplier_id}")
+
+    async def patch(
+        self,
+        supplier_id: str,
+        partial: dict[str, Any],
+    ) -> Supplier:
+        """Partially update a supplier
+
+        Args:
+            supplier_id: ID of the supplier.
+            partial: A dict of fields to update.
+
+        Returns:
+            The Supplier object.
+        """
+        resp = await self._http.patch(f"/suppliers/{supplier_id}", json=partial)
+        return Supplier(**resp.json())
+
+    async def list_buyers(
+        self,
+        supplier_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[SupplierBuyer]:
+        """List supplier buyers
+
+        Args:
+            supplier_id: ID of the supplier.
+            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 SupplierBuyer 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"/suppliers/{supplier_id}/buyers", **params)
+        return self._parse_list(resp.json(), SupplierBuyer)
+
+    async def save_buyer(
+        self,
+        supplier_id: str,
+        buyer_id: str,
+    ) -> None:
+        """Create or update a supplier buyer
+
+        Args:
+            supplier_id: ID of the supplier.
+            buyer_id: ID of the buyer.
+        """
+        await self._http.put(f"/suppliers/{supplier_id}/buyers/{buyer_id}")
+
+    async def delete_buyer(
+        self,
+        supplier_id: str,
+        buyer_id: str,
+    ) -> None:
+        """Delete a supplier buyer
+
+        Args:
+            supplier_id: ID of the supplier.
+            buyer_id: ID of the buyer.
+        """
+        await self._http.delete(f"/suppliers/{supplier_id}/buyers/{buyer_id}")

ordercloud/resources/tracking_events.py

@@ -0,0 +1,130 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud TrackingEvents API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.integration import TrackingEvent
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["TrackingEventsResource"]
+
+
+class TrackingEventsResource(BaseResource):
+    """Operations on OrderCloud TrackingEvents."""
+
+    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[TrackingEvent]:
+        """List tracking events
+
+        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 TrackingEvent 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("/integrations/trackingEvents", **params)
+        return self._parse_list(resp.json(), TrackingEvent)
+
+    async def create(
+        self,
+        tracking_event: Union[TrackingEvent, dict[str, Any]],
+    ) -> TrackingEvent:
+        """Create a tracking event
+
+        Args:
+            tracking_event: A ``TrackingEvent`` model or dict. Required fields: EventType, ClientID, Name, DeliveryConfigID.
+
+        Returns:
+            The TrackingEvent object.
+        """
+        resp = await self._http.post(
+            "/integrations/trackingEvents", json=self._serialize(tracking_event)
+        )
+        return TrackingEvent(**resp.json())
+
+    async def get(
+        self,
+        event_id: str,
+    ) -> TrackingEvent:
+        """Retrieve a tracking event
+
+        Args:
+            event_id: ID of the event.
+
+        Returns:
+            The TrackingEvent object.
+        """
+        resp = await self._http.get(f"/integrations/trackingEvents/{event_id}")
+        return TrackingEvent(**resp.json())
+
+    async def save(
+        self,
+        event_id: str,
+        tracking_event: Union[TrackingEvent, dict[str, Any]],
+    ) -> TrackingEvent:
+        """Create or update a tracking event
+
+        Args:
+            event_id: ID of the event.
+            tracking_event: A ``TrackingEvent`` model or dict. Required fields: EventType, ClientID, Name, DeliveryConfigID.
+
+        Returns:
+            The TrackingEvent object.
+        """
+        resp = await self._http.put(
+            f"/integrations/trackingEvents/{event_id}",
+            json=self._serialize(tracking_event),
+        )
+        return TrackingEvent(**resp.json())
+
+    async def delete(
+        self,
+        event_id: str,
+    ) -> None:
+        """Delete a tracking event
+
+        Args:
+            event_id: ID of the event.
+        """
+        await self._http.delete(f"/integrations/trackingEvents/{event_id}")
+
+    async def patch(
+        self,
+        event_id: str,
+        partial: dict[str, Any],
+    ) -> TrackingEvent:
+        """Partially update a tracking event
+
+        Args:
+            event_id: ID of the event.
+            partial: A dict of fields to update.
+
+        Returns:
+            The TrackingEvent object.
+        """
+        resp = await self._http.patch(f"/integrations/trackingEvents/{event_id}", json=partial)
+        return TrackingEvent(**resp.json())

ordercloud/resources/user_groups.py

@@ -0,0 +1,210 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud UserGroups API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.assignments import UserGroupAssignment
+from ..models.user_group import UserGroup
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["UserGroupsResource"]
+
+
+class UserGroupsResource(BaseResource):
+    """Operations on OrderCloud UserGroups."""
+
+    async def list(
+        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[UserGroup]:
+        """List user groups
+
+        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 UserGroup 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}/usergroups", **params)
+        return self._parse_list(resp.json(), UserGroup)
+
+    async def create(
+        self,
+        buyer_id: str,
+        user_group: Union[UserGroup, dict[str, Any]],
+    ) -> UserGroup:
+        """Create a user group
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group: A ``UserGroup`` model or dict. Required fields: Name.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.post(
+            f"/buyers/{buyer_id}/usergroups", json=self._serialize(user_group)
+        )
+        return UserGroup(**resp.json())
+
+    async def get(
+        self,
+        buyer_id: str,
+        user_group_id: str,
+    ) -> UserGroup:
+        """Retrieve a user group
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.get(f"/buyers/{buyer_id}/usergroups/{user_group_id}")
+        return UserGroup(**resp.json())
+
+    async def save(
+        self,
+        buyer_id: str,
+        user_group_id: str,
+        user_group: Union[UserGroup, dict[str, Any]],
+    ) -> UserGroup:
+        """Create or update a user group
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+            user_group: A ``UserGroup`` model or dict. Required fields: Name.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.put(
+            f"/buyers/{buyer_id}/usergroups/{user_group_id}",
+            json=self._serialize(user_group),
+        )
+        return UserGroup(**resp.json())
+
+    async def delete(
+        self,
+        buyer_id: str,
+        user_group_id: str,
+    ) -> None:
+        """Delete a user group
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+        """
+        await self._http.delete(f"/buyers/{buyer_id}/usergroups/{user_group_id}")
+
+    async def patch(
+        self,
+        buyer_id: str,
+        user_group_id: str,
+        partial: dict[str, Any],
+    ) -> UserGroup:
+        """Partially update a user group
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+            partial: A dict of fields to update.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.patch(
+            f"/buyers/{buyer_id}/usergroups/{user_group_id}", json=partial
+        )
+        return UserGroup(**resp.json())
+
+    async def delete_user_assignment(
+        self,
+        buyer_id: str,
+        user_group_id: str,
+        user_id: str,
+    ) -> None:
+        """Delete a user group user assignment
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+            user_id: ID of the user.
+        """
+        await self._http.delete(
+            f"/buyers/{buyer_id}/usergroups/{user_group_id}/assignments/{user_id}"
+        )
+
+    async def list_user_assignments(
+        self,
+        buyer_id: str,
+        *,
+        user_group_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+    ) -> ListPage[UserGroupAssignment]:
+        """List user group user assignments
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+            user_id: ID of the user.
+            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 UserGroupAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        if user_id is not None:
+            params["userID"] = user_id
+        resp = await self._http.get(f"/buyers/{buyer_id}/usergroups/assignments", **params)
+        return self._parse_list(resp.json(), UserGroupAssignment)
+
+    async def save_user_assignment(
+        self,
+        buyer_id: str,
+        user_group_assignment: Union[UserGroupAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update a user group user assignment
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_assignment: A ``UserGroupAssignment`` model or dict. Required fields: UserGroupID, UserID.
+        """
+        await self._http.post(
+            f"/buyers/{buyer_id}/usergroups/assignments",
+            json=self._serialize(user_group_assignment),
+        )