ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/payments.py

@@ -0,0 +1,176 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Payments API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.misc import OrderDirection
+from ..models.payment import Payment, PaymentTransaction
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["PaymentsResource"]
+
+
+class PaymentsResource(BaseResource):
+    """Operations on OrderCloud Payments."""
+
+    async def list(
+        self,
+        direction: OrderDirection,
+        order_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[Payment]:
+        """List payments
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            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 Payment 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"/orders/{direction}/{order_id}/payments", **params)
+        return self._parse_list(resp.json(), Payment)
+
+    async def create(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+        payment: Union[Payment, dict[str, Any]],
+    ) -> Payment:
+        """Create a payment
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            payment: A ``Payment`` model or dict.
+
+        Returns:
+            The Payment object.
+        """
+        resp = await self._http.post(
+            f"/orders/{direction}/{order_id}/payments", json=self._serialize(payment)
+        )
+        return Payment(**resp.json())
+
+    async def get(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+        payment_id: str,
+    ) -> Payment:
+        """Retrieve a payment
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            payment_id: ID of the payment.
+
+        Returns:
+            The Payment object.
+        """
+        resp = await self._http.get(f"/orders/{direction}/{order_id}/payments/{payment_id}")
+        return Payment(**resp.json())
+
+    async def delete(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+        payment_id: str,
+    ) -> None:
+        """Delete a payment
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            payment_id: ID of the payment.
+        """
+        await self._http.delete(f"/orders/{direction}/{order_id}/payments/{payment_id}")
+
+    async def patch(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+        payment_id: str,
+        partial: dict[str, Any],
+    ) -> Payment:
+        """Partially update a payment
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            payment_id: ID of the payment.
+            partial: A dict of fields to update.
+
+        Returns:
+            The Payment object.
+        """
+        resp = await self._http.patch(
+            f"/orders/{direction}/{order_id}/payments/{payment_id}", json=partial
+        )
+        return Payment(**resp.json())
+
+    async def create_transaction(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+        payment_id: str,
+        payment_transaction: Union[PaymentTransaction, dict[str, Any]],
+    ) -> Payment:
+        """Create a payment transaction
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            payment_id: ID of the payment.
+            payment_transaction: A ``PaymentTransaction`` model or dict. Required fields: Type, DateExecuted.
+
+        Returns:
+            The Payment object.
+        """
+        resp = await self._http.post(
+            f"/orders/{direction}/{order_id}/payments/{payment_id}/transactions",
+            json=self._serialize(payment_transaction),
+        )
+        return Payment(**resp.json())
+
+    async def delete_transaction(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+        payment_id: str,
+        transaction_id: str,
+    ) -> None:
+        """Delete a payment transaction
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            payment_id: ID of the payment.
+            transaction_id: ID of the transaction.
+        """
+        await self._http.delete(
+            f"/orders/{direction}/{order_id}/payments/{payment_id}/transactions/{transaction_id}"
+        )

ordercloud/resources/price_schedules.py

@@ -0,0 +1,164 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud PriceSchedules API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.price_schedule import PriceBreak, PriceSchedule
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["PriceSchedulesResource"]
+
+
+class PriceSchedulesResource(BaseResource):
+    """Operations on OrderCloud PriceSchedules."""
+
+    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[PriceSchedule]:
+        """List price schedules
+
+        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 PriceSchedule 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("/priceschedules", **params)
+        return self._parse_list(resp.json(), PriceSchedule)
+
+    async def create(
+        self,
+        price_schedule: Union[PriceSchedule, dict[str, Any]],
+    ) -> PriceSchedule:
+        """Create a price schedule
+
+        Args:
+            price_schedule: A ``PriceSchedule`` model or dict. Required fields: Name.
+
+        Returns:
+            The PriceSchedule object.
+        """
+        resp = await self._http.post("/priceschedules", json=self._serialize(price_schedule))
+        return PriceSchedule(**resp.json())
+
+    async def get(
+        self,
+        price_schedule_id: str,
+    ) -> PriceSchedule:
+        """Retrieve a price schedule
+
+        Args:
+            price_schedule_id: ID of the price schedule.
+
+        Returns:
+            The PriceSchedule object.
+        """
+        resp = await self._http.get(f"/priceschedules/{price_schedule_id}")
+        return PriceSchedule(**resp.json())
+
+    async def save(
+        self,
+        price_schedule_id: str,
+        price_schedule: Union[PriceSchedule, dict[str, Any]],
+    ) -> PriceSchedule:
+        """Create or update a price schedule
+
+        Args:
+            price_schedule_id: ID of the price schedule.
+            price_schedule: A ``PriceSchedule`` model or dict. Required fields: Name.
+
+        Returns:
+            The PriceSchedule object.
+        """
+        resp = await self._http.put(
+            f"/priceschedules/{price_schedule_id}",
+            json=self._serialize(price_schedule),
+        )
+        return PriceSchedule(**resp.json())
+
+    async def delete(
+        self,
+        price_schedule_id: str,
+    ) -> None:
+        """Delete a price schedule
+
+        Args:
+            price_schedule_id: ID of the price schedule.
+        """
+        await self._http.delete(f"/priceschedules/{price_schedule_id}")
+
+    async def patch(
+        self,
+        price_schedule_id: str,
+        partial: dict[str, Any],
+    ) -> PriceSchedule:
+        """Partially update a price schedule
+
+        Args:
+            price_schedule_id: ID of the price schedule.
+            partial: A dict of fields to update.
+
+        Returns:
+            The PriceSchedule object.
+        """
+        resp = await self._http.patch(f"/priceschedules/{price_schedule_id}", json=partial)
+        return PriceSchedule(**resp.json())
+
+    async def save_price_break(
+        self,
+        price_schedule_id: str,
+        price_break: Union[PriceBreak, dict[str, Any]],
+    ) -> PriceSchedule:
+        """Create or update a price schedule price break
+
+        Args:
+            price_schedule_id: ID of the price schedule.
+            price_break: A ``PriceBreak`` model or dict. Required fields: Quantity, Price.
+
+        Returns:
+            The PriceSchedule object.
+        """
+        resp = await self._http.post(
+            f"/priceschedules/{price_schedule_id}/PriceBreaks", json=self._serialize(price_break)
+        )
+        return PriceSchedule(**resp.json())
+
+    async def delete_price_break(
+        self,
+        price_schedule_id: str,
+        *,
+        quantity: Optional[int],
+    ) -> None:
+        """Delete a price schedule price break
+
+        Args:
+            price_schedule_id: ID of the price schedule.
+            quantity: Quantity of the price schedule.
+        """
+        _params: dict[str, Any] = {}
+        if quantity is not None:
+            _params["quantity"] = quantity
+        await self._http.delete(f"/priceschedules/{price_schedule_id}/PriceBreaks", **_params)

ordercloud/resources/product_collections.py

@@ -0,0 +1,116 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud ProductCollections API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional
+
+from ..models.misc import SearchType
+from ..models.product_collection import ProductCollection, ProductCollectionProduct
+from ..models.shared import ListPage, MetaWithFacets
+from .base import BaseResource
+
+__all__ = ["ProductCollectionsResource"]
+
+
+class ProductCollectionsResource(BaseResource):
+    """Operations on OrderCloud ProductCollections."""
+
+    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[ProductCollection]:
+        """List product collections
+
+        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 ProductCollection 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}/productcollections", **params)
+        return self._parse_list(resp.json(), ProductCollection)
+
+    async def get(
+        self,
+        buyer_id: str,
+        product_collection_id: str,
+    ) -> ProductCollection:
+        """Retrieve a product collection
+
+        Args:
+            buyer_id: ID of the buyer.
+            product_collection_id: ID of the product collection.
+
+        Returns:
+            The ProductCollection object.
+        """
+        resp = await self._http.get(
+            f"/buyers/{buyer_id}/productcollections/{product_collection_id}"
+        )
+        return ProductCollection(**resp.json())
+
+    async def list_entries(
+        self,
+        buyer_id: str,
+        product_collection_id: str,
+        *,
+        search: Optional[str] = None,
+        search_on: Optional[str] = None,
+        search_type: Optional[SearchType] = None,
+        sort_by: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+        filters: Optional[dict[str, Any]] = None,
+    ) -> ListPage[ProductCollectionProduct]:
+        """List product collection entries
+
+        Args:
+            buyer_id: ID of the buyer.
+            product_collection_id: ID of the product collection.
+            search: Word or phrase to search for.
+            search_on: Comma-delimited list of fields to search on.
+            search_type: Type of search to perform.
+            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 ProductCollectionProduct 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 search_type is not None:
+            params["searchType"] = search_type
+        resp = await self._http.get(
+            f"/buyers/{buyer_id}/productcollections/{product_collection_id}/products", **params
+        )
+        return self._parse_list(resp.json(), ProductCollectionProduct, meta_cls=MetaWithFacets)

ordercloud/resources/product_facets.py

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

ordercloud/resources/product_syncs.py

@@ -0,0 +1,76 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud ProductSyncs API resource."""
+
+from __future__ import annotations
+from typing import Any, Union
+
+from ..models.sync import ProductSyncConfig, SyncProduct
+from .base import BaseResource
+
+__all__ = ["ProductSyncsResource"]
+
+
+class ProductSyncsResource(BaseResource):
+    """Operations on OrderCloud ProductSyncs."""
+
+    async def get(
+        self,
+    ) -> ProductSyncConfig:
+        """Retrieve a product sync
+
+        Returns:
+            The ProductSyncConfig object.
+        """
+        resp = await self._http.get("/integrations/productsync")
+        return ProductSyncConfig(**resp.json())
+
+    async def save(
+        self,
+        product_sync_config: Union[ProductSyncConfig, dict[str, Any]],
+    ) -> ProductSyncConfig:
+        """Create or update a product sync
+
+        Args:
+            product_sync_config: A ``ProductSyncConfig`` model or dict. Required fields: SyncProductChanged, SyncProductDeleted, DeliveryConfigID.
+
+        Returns:
+            The ProductSyncConfig object.
+        """
+        resp = await self._http.put(
+            "/integrations/productsync",
+            json=self._serialize(product_sync_config),
+        )
+        return ProductSyncConfig(**resp.json())
+
+    async def delete(
+        self,
+    ) -> None:
+        """Delete a product sync"""
+        await self._http.delete("/integrations/productsync")
+
+    async def patch(
+        self,
+        partial: dict[str, Any],
+    ) -> ProductSyncConfig:
+        """Partially update a product sync
+
+        Args:
+            partial: A dict of fields to update.
+
+        Returns:
+            The ProductSyncConfig object.
+        """
+        resp = await self._http.patch("/integrations/productsync", json=partial)
+        return ProductSyncConfig(**resp.json())
+
+    async def sync(
+        self,
+        sync_product: Union[SyncProduct, dict[str, Any]],
+    ) -> None:
+        """Sync a product
+
+        Args:
+            sync_product: A ``SyncProduct`` model or dict. Required fields: ProductID.
+        """
+        await self._http.post("/integrations/productsync/sync", json=self._serialize(sync_product))