ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/spending_accounts.py

@@ -0,0 +1,227 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud SpendingAccounts API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.assignments import SpendingAccountAssignment
+from ..models.misc import PartyType
+from ..models.spending_account import SpendingAccount
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["SpendingAccountsResource"]
+
+
+class SpendingAccountsResource(BaseResource):
+    """Operations on OrderCloud SpendingAccounts."""
+
+    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[SpendingAccount]:
+        """List spending accounts
+
+        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 SpendingAccount 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}/spendingaccounts", **params)
+        return self._parse_list(resp.json(), SpendingAccount)
+
+    async def create(
+        self,
+        buyer_id: str,
+        spending_account: Union[SpendingAccount, dict[str, Any]],
+    ) -> SpendingAccount:
+        """Create a spending account
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account: A ``SpendingAccount`` model or dict. Required fields: Name, Balance.
+
+        Returns:
+            The SpendingAccount object.
+        """
+        resp = await self._http.post(
+            f"/buyers/{buyer_id}/spendingaccounts", json=self._serialize(spending_account)
+        )
+        return SpendingAccount(**resp.json())
+
+    async def get(
+        self,
+        buyer_id: str,
+        spending_account_id: str,
+    ) -> SpendingAccount:
+        """Retrieve a spending account
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account_id: ID of the spending account.
+
+        Returns:
+            The SpendingAccount object.
+        """
+        resp = await self._http.get(f"/buyers/{buyer_id}/spendingaccounts/{spending_account_id}")
+        return SpendingAccount(**resp.json())
+
+    async def save(
+        self,
+        buyer_id: str,
+        spending_account_id: str,
+        spending_account: Union[SpendingAccount, dict[str, Any]],
+    ) -> SpendingAccount:
+        """Create or update a spending account
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account_id: ID of the spending account.
+            spending_account: A ``SpendingAccount`` model or dict. Required fields: Name, Balance.
+
+        Returns:
+            The SpendingAccount object.
+        """
+        resp = await self._http.put(
+            f"/buyers/{buyer_id}/spendingaccounts/{spending_account_id}",
+            json=self._serialize(spending_account),
+        )
+        return SpendingAccount(**resp.json())
+
+    async def delete(
+        self,
+        buyer_id: str,
+        spending_account_id: str,
+    ) -> None:
+        """Delete a spending account
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account_id: ID of the spending account.
+        """
+        await self._http.delete(f"/buyers/{buyer_id}/spendingaccounts/{spending_account_id}")
+
+    async def patch(
+        self,
+        buyer_id: str,
+        spending_account_id: str,
+        partial: dict[str, Any],
+    ) -> SpendingAccount:
+        """Partially update a spending account
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account_id: ID of the spending account.
+            partial: A dict of fields to update.
+
+        Returns:
+            The SpendingAccount object.
+        """
+        resp = await self._http.patch(
+            f"/buyers/{buyer_id}/spendingaccounts/{spending_account_id}", json=partial
+        )
+        return SpendingAccount(**resp.json())
+
+    async def delete_assignment(
+        self,
+        buyer_id: str,
+        spending_account_id: str,
+        *,
+        user_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+    ) -> None:
+        """Delete a spending account assignment
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account_id: ID of the spending account.
+            user_id: ID of the user.
+            user_group_id: ID of the user group.
+        """
+        _params: dict[str, Any] = {}
+        if user_id is not None:
+            _params["userID"] = user_id
+        if user_group_id is not None:
+            _params["userGroupID"] = user_group_id
+        await self._http.delete(
+            f"/buyers/{buyer_id}/spendingaccounts/{spending_account_id}/assignments", **_params
+        )
+
+    async def list_assignments(
+        self,
+        buyer_id: str,
+        *,
+        spending_account_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        level: Optional[PartyType] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+    ) -> ListPage[SpendingAccountAssignment]:
+        """List spending account assignments
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account_id: ID of the spending account.
+            user_id: ID of the user.
+            user_group_id: ID of the user group.
+            level: Level of the spending account assignment. Possible values: User, 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 SpendingAccountAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if spending_account_id is not None:
+            params["spendingAccountID"] = spending_account_id
+        if user_id is not None:
+            params["userID"] = user_id
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        if level is not None:
+            params["level"] = level
+        resp = await self._http.get(f"/buyers/{buyer_id}/spendingaccounts/assignments", **params)
+        return self._parse_list(resp.json(), SpendingAccountAssignment)
+
+    async def save_assignment(
+        self,
+        buyer_id: str,
+        spending_account_assignment: Union[SpendingAccountAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update a spending account assignment
+
+        Args:
+            buyer_id: ID of the buyer.
+            spending_account_assignment: A ``SpendingAccountAssignment`` model or dict. Required fields: SpendingAccountID.
+        """
+        await self._http.post(
+            f"/buyers/{buyer_id}/spendingaccounts/assignments",
+            json=self._serialize(spending_account_assignment),
+        )

ordercloud/resources/subscription_integrations.py

@@ -0,0 +1,65 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud SubscriptionIntegrations API resource."""
+
+from __future__ import annotations
+from typing import Any, Union
+
+from ..models.subscription import SubscriptionIntegration
+from .base import BaseResource
+
+__all__ = ["SubscriptionIntegrationsResource"]
+
+
+class SubscriptionIntegrationsResource(BaseResource):
+    """Operations on OrderCloud SubscriptionIntegrations."""
+
+    async def get(
+        self,
+    ) -> SubscriptionIntegration:
+        """Retrieve a subscription integration
+
+        Returns:
+            The SubscriptionIntegration object.
+        """
+        resp = await self._http.get("/integrations/subscription")
+        return SubscriptionIntegration(**resp.json())
+
+    async def save(
+        self,
+        subscription_integration: Union[SubscriptionIntegration, dict[str, Any]],
+    ) -> SubscriptionIntegration:
+        """Create or update a subscription integration
+
+        Args:
+            subscription_integration: A ``SubscriptionIntegration`` model or dict. Required fields: ApiClientID, HashKey.
+
+        Returns:
+            The SubscriptionIntegration object.
+        """
+        resp = await self._http.put(
+            "/integrations/subscription",
+            json=self._serialize(subscription_integration),
+        )
+        return SubscriptionIntegration(**resp.json())
+
+    async def delete(
+        self,
+    ) -> None:
+        """Delete a subscription integration"""
+        await self._http.delete("/integrations/subscription")
+
+    async def patch(
+        self,
+        partial: dict[str, Any],
+    ) -> SubscriptionIntegration:
+        """Partially update a subscription integration
+
+        Args:
+            partial: A dict of fields to update.
+
+        Returns:
+            The SubscriptionIntegration object.
+        """
+        resp = await self._http.patch("/integrations/subscription", json=partial)
+        return SubscriptionIntegration(**resp.json())

ordercloud/resources/subscription_items.py

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

ordercloud/resources/subscriptions.py

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