ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/users.py

@@ -0,0 +1,254 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Users API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.auth_models import AccessToken, ImpersonateTokenRequest
+from ..models.user import User, UserOrderMoveOption
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["UsersResource"]
+
+
+class UsersResource(BaseResource):
+    """Operations on OrderCloud Users."""
+
+    async def list(
+        self,
+        buyer_id: str,
+        *,
+        user_group_id: Optional[str] = None,
+        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[User]:
+        """List users
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_group_id: ID of the user group.
+            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 User objects.
+        """
+        params = self._build_list_params(
+            search=search,
+            search_on=search_on,
+            sort_by=sort_by,
+            page=page,
+            page_size=page_size,
+            filters=filters,
+        )
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        resp = await self._http.get(f"/buyers/{buyer_id}/users", **params)
+        return self._parse_list(resp.json(), User)
+
+    async def create(
+        self,
+        buyer_id: str,
+        user: Union[User, dict[str, Any]],
+    ) -> User:
+        """Create a user
+
+        Args:
+            buyer_id: ID of the buyer.
+            user: A ``User`` model or dict. Required fields: Username, FirstName, LastName, Email, Active.
+
+        Returns:
+            The User object.
+        """
+        resp = await self._http.post(f"/buyers/{buyer_id}/users", json=self._serialize(user))
+        return User(**resp.json())
+
+    async def get(
+        self,
+        buyer_id: str,
+        user_id: str,
+    ) -> User:
+        """Retrieve a user
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+
+        Returns:
+            The User object.
+        """
+        resp = await self._http.get(f"/buyers/{buyer_id}/users/{user_id}")
+        return User(**resp.json())
+
+    async def save(
+        self,
+        buyer_id: str,
+        user_id: str,
+        user: Union[User, dict[str, Any]],
+    ) -> User:
+        """Create or update a user
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+            user: A ``User`` model or dict. Required fields: Username, FirstName, LastName, Email, Active.
+
+        Returns:
+            The User object.
+        """
+        resp = await self._http.put(
+            f"/buyers/{buyer_id}/users/{user_id}",
+            json=self._serialize(user),
+        )
+        return User(**resp.json())
+
+    async def delete(
+        self,
+        buyer_id: str,
+        user_id: str,
+    ) -> None:
+        """Delete a user
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+        """
+        await self._http.delete(f"/buyers/{buyer_id}/users/{user_id}")
+
+    async def patch(
+        self,
+        buyer_id: str,
+        user_id: str,
+        partial: dict[str, Any],
+    ) -> User:
+        """Partially update a user
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+            partial: A dict of fields to update.
+
+        Returns:
+            The User object.
+        """
+        resp = await self._http.patch(f"/buyers/{buyer_id}/users/{user_id}", json=partial)
+        return User(**resp.json())
+
+    async def get_access_token(
+        self,
+        buyer_id: str,
+        user_id: str,
+        impersonate_token_request: Union[ImpersonateTokenRequest, dict[str, Any]],
+    ) -> AccessToken:
+        """Retrieve a user access token
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+            impersonate_token_request: A ``ImpersonateTokenRequest`` model or dict. Required fields: ClientID, Roles.
+
+        Returns:
+            The AccessToken object.
+        """
+        resp = await self._http.post(
+            f"/buyers/{buyer_id}/users/{user_id}/accesstoken",
+            json=self._serialize(impersonate_token_request),
+        )
+        return AccessToken(**resp.json())
+
+    async def move(
+        self,
+        buyer_id: str,
+        user_id: str,
+        new_buyer_id: str,
+        *,
+        orders: UserOrderMoveOption,
+    ) -> User:
+        """Move a user to a different buyer
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+            new_buyer_id: ID of the new buyer.
+            orders: Orders of the user. Possible values: None, Unsubmitted, All.
+
+        Returns:
+            The User object.
+        """
+        _params: dict[str, Any] = {}
+        if orders is not None:
+            _params["orders"] = orders
+        resp = await self._http.post(
+            f"/buyers/{buyer_id}/users/{user_id}/moveto/{new_buyer_id}", params=_params or None
+        )
+        return User(**resp.json())
+
+    async def revoke_user_tokens(
+        self,
+        buyer_id: str,
+        user_id: str,
+    ) -> None:
+        """Revoke a user tokens
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+        """
+        await self._http.delete(f"/buyers/{buyer_id}/users/{user_id}/tokens")
+
+    async def unlock_user_account(
+        self,
+        buyer_id: str,
+        user_id: str,
+    ) -> None:
+        """Unlock a user account
+
+        Args:
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+        """
+        await self._http.post(f"/buyers/{buyer_id}/users/{user_id}/unlock")
+
+    async def list_across_buyers(
+        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[User]:
+        """List user across 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 User 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("/buyerusers", **params)
+        return self._parse_list(resp.json(), User)

ordercloud/resources/webhooks.py

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

ordercloud/resources/xp_indices.py

@@ -0,0 +1,77 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud XpIndices API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.misc import XpIndex, XpThingType
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["XpIndicesResource"]
+
+
+class XpIndicesResource(BaseResource):
+    """Operations on OrderCloud XpIndices."""
+
+    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[XpIndex]:
+        """List XP indices
+
+        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 XpIndex 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("/xpindices", **params)
+        return self._parse_list(resp.json(), XpIndex)
+
+    async def put(
+        self,
+        xp_index: Union[XpIndex, dict[str, Any]],
+    ) -> None:
+        """Create or update an xp index
+
+        Args:
+            xp_index: A ``XpIndex`` model or dict.
+        """
+        await self._http.put(
+            "/xpindices",
+            json=self._serialize(xp_index),
+        )
+
+    async def delete(
+        self,
+        thing_type: XpThingType,
+        key: str,
+    ) -> None:
+        """Delete a XP index
+
+        Args:
+            thing_type: Thing type of the xp index. Possible values: Address, Variant, Order, OrderReturn, LineItem, CostCenter, CreditCard, Payment, Spec, SpecOption, UserGroup, Company, Category, PriceSchedule, Shipment, SpendingAccount, User, Promotion, ApprovalRule, SellerApprovalRule, Catalog, ProductFacet, MessageSender, InventoryRecord, ProductCollection, Subscription, GroupOrderInvitation, BuyerGroup, Discount.
+            key: Key of the xp index.
+        """
+        await self._http.delete(f"/xpindices/{thing_type}/{key}")

ordercloud/sync_client.py

@@ -0,0 +1,170 @@
+"""Synchronous wrapper around the async OrderCloud client."""
+
+from __future__ import annotations
+
+import asyncio
+import functools
+from collections.abc import Iterator
+from typing import Any, TypeVar
+
+from .config import OrderCloudConfig
+from .middleware import AfterResponse, BeforeRequest
+from .resources.base import BaseResource
+
+T = TypeVar("T")
+
+__all__ = ["SyncOrderCloudClient", "paginate_sync"]
+
+
+class _SyncProxy:
+    """Wraps an async resource, making all async methods synchronous.
+
+    When an attribute is accessed that is a coroutine function, it is
+    wrapped so that calling it runs the coroutine to completion on the
+    client's event loop and returns the result directly.
+    """
+
+    def __init__(self, async_resource: BaseResource, runner: Any) -> None:
+        self._async = async_resource
+        self._run = runner
+
+    def __getattr__(self, name: str) -> Any:
+        attr = getattr(self._async, name)
+        if asyncio.iscoroutinefunction(attr):
+
+            @functools.wraps(attr)
+            def sync_wrapper(*args: Any, **kwargs: Any) -> Any:
+                return self._run(attr(*args, **kwargs))
+
+            return sync_wrapper
+        return attr
+
+
+class SyncOrderCloudClient:
+    """Synchronous client for the OrderCloud API.
+
+    A thin wrapper around ``OrderCloudClient`` that manages its own
+    event loop internally.  All resource methods are available as
+    regular (non-async) calls.
+
+    Usage::
+
+        with SyncOrderCloudClient.create(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        ) as client:
+            products = client.products.list()
+    """
+
+    def __init__(self, config: OrderCloudConfig) -> None:
+        # Import here to avoid circular import at module level.
+        from .client import OrderCloudClient
+
+        self._loop = asyncio.new_event_loop()
+        self._async_client = OrderCloudClient(config)
+
+        # Auto-wrap all resource attributes with sync proxies.
+        for name, value in vars(self._async_client).items():
+            if isinstance(value, BaseResource):
+                object.__setattr__(self, name, _SyncProxy(value, self._run))
+
+    @classmethod
+    def create(
+        cls,
+        *,
+        client_id: str,
+        client_secret: str,
+        base_url: str = "https://api.ordercloud.io/v1",
+        auth_url: str = "https://auth.ordercloud.io/oauth/token",
+        scopes: list[str] | None = None,
+        timeout: float = 30.0,
+        max_retries: int = 0,
+        retry_backoff: float = 0.5,
+    ) -> SyncOrderCloudClient:
+        """Create a client from individual parameters.
+
+        Args:
+            client_id: OAuth2 client ID.
+            client_secret: OAuth2 client secret.
+            base_url: API base URL (default: US production).
+            auth_url: OAuth2 token endpoint.
+            scopes: Requested scopes (default: ``["FullAccess"]``).
+            timeout: HTTP request timeout in seconds.
+            max_retries: Maximum retries on 429/5xx (0 = disabled).
+            retry_backoff: Base delay for exponential backoff.
+
+        Returns:
+            A configured ``SyncOrderCloudClient`` instance.
+        """
+        config = OrderCloudConfig(
+            client_id=client_id,
+            client_secret=client_secret,
+            base_url=base_url,
+            auth_url=auth_url,
+            scopes=tuple(scopes) if scopes else ("FullAccess",),
+            timeout=timeout,
+            max_retries=max_retries,
+            retry_backoff=retry_backoff,
+        )
+        return cls(config)
+
+    def _run(self, coro: Any) -> Any:
+        """Run a coroutine to completion on the internal event loop."""
+        return self._loop.run_until_complete(coro)
+
+    def add_before_request(self, hook: BeforeRequest) -> None:
+        """Register a hook called before each HTTP request."""
+        self._async_client.add_before_request(hook)
+
+    def add_after_response(self, hook: AfterResponse) -> None:
+        """Register a hook called after each HTTP response."""
+        self._async_client.add_after_response(hook)
+
+    def close(self) -> None:
+        """Close the underlying HTTP client and event loop."""
+        self._run(self._async_client.close())
+        self._loop.close()
+
+    def __enter__(self) -> SyncOrderCloudClient:
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()
+
+
+def paginate_sync(
+    list_method: Any,
+    *args: Any,
+    page_size: int = 100,
+    **kwargs: Any,
+) -> Iterator[Any]:
+    """Auto-paginate any sync list method, yielding individual items.
+
+    Works with the sync proxy methods on ``SyncOrderCloudClient``.
+
+    Args:
+        list_method: A bound sync list method (e.g. ``client.products.list``).
+        *args: Positional arguments forwarded to the list method.
+        page_size: Items per page (default 100, the API maximum).
+        **kwargs: Keyword arguments forwarded to the list method.
+
+    Yields:
+        Individual items across all pages.
+
+    Example::
+
+        from ordercloud.sync_client import SyncOrderCloudClient, paginate_sync
+
+        with SyncOrderCloudClient.create(...) as client:
+            for product in paginate_sync(client.products.list, search="widget"):
+                print(product.name)
+    """
+    page = 1
+    kwargs["page_size"] = page_size
+    while True:
+        kwargs["page"] = page
+        result = list_method(*args, **kwargs)
+        yield from result.items
+        if page >= result.meta.total_pages:
+            break
+        page += 1