ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/order_syncs.py

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