ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/impersonation_configs.py

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

ordercloud/resources/incrementors.py

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

ordercloud/resources/integration_events.py

@@ -0,0 +1,203 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud IntegrationEvents API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.integration import IntegrationEvent
+from ..models.misc import OrderDirection
+from ..models.order import OrderShipMethodSelection, OrderWorksheet
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["IntegrationEventsResource"]
+
+
+class IntegrationEventsResource(BaseResource):
+    """Operations on OrderCloud IntegrationEvents."""
+
+    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[IntegrationEvent]:
+        """List integration 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 IntegrationEvent 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("/integrationEvents", **params)
+        return self._parse_list(resp.json(), IntegrationEvent)
+
+    async def create(
+        self,
+        integration_event: Union[IntegrationEvent, dict[str, Any]],
+    ) -> IntegrationEvent:
+        """Create an integration event
+
+        Args:
+            integration_event: A ``IntegrationEvent`` model or dict. Required fields: CustomImplementationUrl, Name, HashKey.
+
+        Returns:
+            The IntegrationEvent object.
+        """
+        resp = await self._http.post("/integrationEvents", json=self._serialize(integration_event))
+        return IntegrationEvent(**resp.json())
+
+    async def get(
+        self,
+        integration_event_id: str,
+    ) -> IntegrationEvent:
+        """Retrieve an integration event
+
+        Args:
+            integration_event_id: ID of the integration event.
+
+        Returns:
+            The IntegrationEvent object.
+        """
+        resp = await self._http.get(f"/integrationEvents/{integration_event_id}")
+        return IntegrationEvent(**resp.json())
+
+    async def save(
+        self,
+        integration_event_id: str,
+        integration_event: Union[IntegrationEvent, dict[str, Any]],
+    ) -> IntegrationEvent:
+        """Create or update an integration event
+
+        Args:
+            integration_event_id: ID of the integration event.
+            integration_event: A ``IntegrationEvent`` model or dict. Required fields: CustomImplementationUrl, Name, HashKey.
+
+        Returns:
+            The IntegrationEvent object.
+        """
+        resp = await self._http.put(
+            f"/integrationEvents/{integration_event_id}",
+            json=self._serialize(integration_event),
+        )
+        return IntegrationEvent(**resp.json())
+
+    async def delete(
+        self,
+        integration_event_id: str,
+    ) -> None:
+        """Delete an integration event
+
+        Args:
+            integration_event_id: ID of the integration event.
+        """
+        await self._http.delete(f"/integrationEvents/{integration_event_id}")
+
+    async def patch(
+        self,
+        integration_event_id: str,
+        partial: dict[str, Any],
+    ) -> IntegrationEvent:
+        """Partially update an integration event
+
+        Args:
+            integration_event_id: ID of the integration event.
+            partial: A dict of fields to update.
+
+        Returns:
+            The IntegrationEvent object.
+        """
+        resp = await self._http.patch(f"/integrationEvents/{integration_event_id}", json=partial)
+        return IntegrationEvent(**resp.json())
+
+    async def calculate(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+    ) -> OrderWorksheet:
+        """Calculate an order
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+
+        Returns:
+            The OrderWorksheet object.
+        """
+        resp = await self._http.post(f"/orders/{direction}/{order_id}/calculate")
+        return OrderWorksheet(**resp.json())
+
+    async def estimate_shipping(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+    ) -> OrderWorksheet:
+        """Estimate shipping cost
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+
+        Returns:
+            The OrderWorksheet object.
+        """
+        resp = await self._http.post(f"/orders/{direction}/{order_id}/estimateshipping")
+        return OrderWorksheet(**resp.json())
+
+    async def select_shipmethods(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+        order_ship_method_selection: Union[OrderShipMethodSelection, dict[str, Any]],
+    ) -> OrderWorksheet:
+        """Select a ship method
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+            order_ship_method_selection: A ``OrderShipMethodSelection`` model or dict.
+
+        Returns:
+            The OrderWorksheet object.
+        """
+        resp = await self._http.post(
+            f"/orders/{direction}/{order_id}/shipmethods",
+            json=self._serialize(order_ship_method_selection),
+        )
+        return OrderWorksheet(**resp.json())
+
+    async def get_worksheet(
+        self,
+        direction: OrderDirection,
+        order_id: str,
+    ) -> OrderWorksheet:
+        """Get a single order worksheet
+
+        Args:
+            direction: Direction of the order, from the current user's perspective.
+            order_id: ID of the order.
+
+        Returns:
+            The OrderWorksheet object.
+        """
+        resp = await self._http.get(f"/orders/{direction}/{order_id}/worksheet")
+        return OrderWorksheet(**resp.json())

ordercloud/resources/inventory_integrations.py

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