ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/message_senders.py

@@ -0,0 +1,261 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud MessageSenders API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.assignments import MessageCCListenerAssignment, MessageSenderAssignment
+from ..models.message_sender import MessageSender
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["MessageSendersResource"]
+
+
+class MessageSendersResource(BaseResource):
+    """Operations on OrderCloud MessageSenders."""
+
+    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[MessageSender]:
+        """List message senders
+
+        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 MessageSender 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("/messagesenders", **params)
+        return self._parse_list(resp.json(), MessageSender)
+
+    async def create(
+        self,
+        message_sender: Union[MessageSender, dict[str, Any]],
+    ) -> MessageSender:
+        """Create a message sender
+
+        Args:
+            message_sender: A ``MessageSender`` model or dict. Required fields: Name, MessageTypes, DeliveryConfigID.
+
+        Returns:
+            The MessageSender object.
+        """
+        resp = await self._http.post("/messagesenders", json=self._serialize(message_sender))
+        return MessageSender(**resp.json())
+
+    async def get(
+        self,
+        message_sender_id: str,
+    ) -> MessageSender:
+        """Retrieve a message sender
+
+        Args:
+            message_sender_id: ID of the message sender.
+
+        Returns:
+            The MessageSender object.
+        """
+        resp = await self._http.get(f"/messagesenders/{message_sender_id}")
+        return MessageSender(**resp.json())
+
+    async def save(
+        self,
+        message_sender_id: str,
+        message_sender: Union[MessageSender, dict[str, Any]],
+    ) -> MessageSender:
+        """Create or update a message sender
+
+        Args:
+            message_sender_id: ID of the message sender.
+            message_sender: A ``MessageSender`` model or dict. Required fields: Name, MessageTypes, DeliveryConfigID.
+
+        Returns:
+            The MessageSender object.
+        """
+        resp = await self._http.put(
+            f"/messagesenders/{message_sender_id}",
+            json=self._serialize(message_sender),
+        )
+        return MessageSender(**resp.json())
+
+    async def delete(
+        self,
+        message_sender_id: str,
+    ) -> None:
+        """Delete a message sender
+
+        Args:
+            message_sender_id: ID of the message sender.
+        """
+        await self._http.delete(f"/messagesenders/{message_sender_id}")
+
+    async def patch(
+        self,
+        message_sender_id: str,
+        partial: dict[str, Any],
+    ) -> MessageSender:
+        """Partially update a message sender
+
+        Args:
+            message_sender_id: ID of the message sender.
+            partial: A dict of fields to update.
+
+        Returns:
+            The MessageSender object.
+        """
+        resp = await self._http.patch(f"/messagesenders/{message_sender_id}", json=partial)
+        return MessageSender(**resp.json())
+
+    async def delete_assignment(
+        self,
+        message_sender_id: str,
+        *,
+        buyer_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        supplier_id: Optional[str] = None,
+    ) -> None:
+        """Delete a message sender assignment
+
+        Args:
+            message_sender_id: ID of the message sender.
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+            user_group_id: ID of the user group.
+            supplier_id: ID of the supplier.
+        """
+        _params: dict[str, Any] = {}
+        if buyer_id is not None:
+            _params["buyerID"] = buyer_id
+        if user_id is not None:
+            _params["userID"] = user_id
+        if user_group_id is not None:
+            _params["userGroupID"] = user_group_id
+        if supplier_id is not None:
+            _params["supplierID"] = supplier_id
+        await self._http.delete(f"/messagesenders/{message_sender_id}/assignments", **_params)
+
+    async def list_assignments(
+        self,
+        *,
+        buyer_id: Optional[str] = None,
+        message_sender_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        level: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+        supplier_id: Optional[str] = None,
+    ) -> ListPage[MessageSenderAssignment]:
+        """List message sender assignments
+
+        Args:
+            buyer_id: ID of the buyer.
+            message_sender_id: ID of the message sender.
+            user_group_id: ID of the user group.
+            level: Level of the message sender assignment. Possible values: 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.
+            supplier_id: ID of the supplier.
+
+        Returns:
+            A paginated list of MessageSenderAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if buyer_id is not None:
+            params["buyerID"] = buyer_id
+        if message_sender_id is not None:
+            params["messageSenderID"] = message_sender_id
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        if level is not None:
+            params["level"] = level
+        if supplier_id is not None:
+            params["supplierID"] = supplier_id
+        resp = await self._http.get("/messagesenders/assignments", **params)
+        return self._parse_list(resp.json(), MessageSenderAssignment)
+
+    async def save_assignment(
+        self,
+        message_sender_assignment: Union[MessageSenderAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update a message sender assignment
+
+        Args:
+            message_sender_assignment: A ``MessageSenderAssignment`` model or dict. Required fields: MessageSenderID.
+        """
+        await self._http.post(
+            "/messagesenders/assignments", json=self._serialize(message_sender_assignment)
+        )
+
+    async def list_cc_listener_assignments(
+        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[MessageCCListenerAssignment]:
+        """List message sender cc listener assignments
+
+        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 MessageCCListenerAssignment 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("/messagesenders/CCListenerAssignments", **params)
+        return self._parse_list(resp.json(), MessageCCListenerAssignment)
+
+    async def save_cc_listener_assignment(
+        self,
+        message_cc_listener_assignment: Union[MessageCCListenerAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update a message sender cc listener assignment
+
+        Args:
+            message_cc_listener_assignment: A ``MessageCCListenerAssignment`` model or dict. Required fields: MessageSenderAssignment, MessageType.
+        """
+        await self._http.post(
+            "/messagesenders/CCListenerAssignments",
+            json=self._serialize(message_cc_listener_assignment),
+        )

ordercloud/resources/open_id_connects.py

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

ordercloud/resources/order_returns.py

@@ -0,0 +1,306 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud OrderReturns API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.order import ApprovalInfo
+from ..models.order_return import OrderReturn, OrderReturnApproval
+from ..models.user import User
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["OrderReturnsResource"]
+
+
+class OrderReturnsResource(BaseResource):
+    """Operations on OrderCloud OrderReturns."""
+
+    async def list(
+        self,
+        *,
+        approvable: Optional[bool] = 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[OrderReturn]:
+        """List order returns
+
+        Args:
+            approvable: Only returns orders awaiting the user's approval if true.
+            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 OrderReturn 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 approvable is not None:
+            params["approvable"] = approvable
+        resp = await self._http.get("/orderreturns", **params)
+        return self._parse_list(resp.json(), OrderReturn)
+
+    async def create(
+        self,
+        order_return: Union[OrderReturn, dict[str, Any]],
+    ) -> OrderReturn:
+        """Create an order return
+
+        Args:
+            order_return: A ``OrderReturn`` model or dict. Required fields: OrderID.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.post("/orderreturns", json=self._serialize(order_return))
+        return OrderReturn(**resp.json())
+
+    async def get(
+        self,
+        return_id: str,
+    ) -> OrderReturn:
+        """Retrieve an order return
+
+        Args:
+            return_id: ID of the return.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.get(f"/orderreturns/{return_id}")
+        return OrderReturn(**resp.json())
+
+    async def save(
+        self,
+        return_id: str,
+        order_return: Union[OrderReturn, dict[str, Any]],
+    ) -> OrderReturn:
+        """Create or update an order return
+
+        Args:
+            return_id: ID of the return.
+            order_return: A ``OrderReturn`` model or dict. Required fields: OrderID.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.put(
+            f"/orderreturns/{return_id}",
+            json=self._serialize(order_return),
+        )
+        return OrderReturn(**resp.json())
+
+    async def delete(
+        self,
+        return_id: str,
+    ) -> None:
+        """Delete an order return
+
+        Args:
+            return_id: ID of the return.
+        """
+        await self._http.delete(f"/orderreturns/{return_id}")
+
+    async def patch(
+        self,
+        return_id: str,
+        partial: dict[str, Any],
+    ) -> OrderReturn:
+        """Partially update an order return
+
+        Args:
+            return_id: ID of the return.
+            partial: A dict of fields to update.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.patch(f"/orderreturns/{return_id}", json=partial)
+        return OrderReturn(**resp.json())
+
+    async def list_approvals(
+        self,
+        return_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[OrderReturnApproval]:
+        """List order return approvals
+
+        Args:
+            return_id: ID of the return.
+            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 OrderReturnApproval 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"/orderreturns/{return_id}/approvals", **params)
+        return self._parse_list(resp.json(), OrderReturnApproval)
+
+    async def approve(
+        self,
+        return_id: str,
+        approval_info: Union[ApprovalInfo, dict[str, Any]],
+    ) -> OrderReturn:
+        """Approve an order return
+
+        Args:
+            return_id: ID of the return.
+            approval_info: A ``ApprovalInfo`` model or dict.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.post(
+            f"/orderreturns/{return_id}/approve", json=self._serialize(approval_info)
+        )
+        return OrderReturn(**resp.json())
+
+    async def cancel(
+        self,
+        return_id: str,
+    ) -> OrderReturn:
+        """Cancel an order return
+
+        Args:
+            return_id: ID of the return.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.post(f"/orderreturns/{return_id}/cancel")
+        return OrderReturn(**resp.json())
+
+    async def complete(
+        self,
+        return_id: str,
+    ) -> OrderReturn:
+        """Complete an order return
+
+        Args:
+            return_id: ID of the return.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.post(f"/orderreturns/{return_id}/complete")
+        return OrderReturn(**resp.json())
+
+    async def decline(
+        self,
+        return_id: str,
+        approval_info: Union[ApprovalInfo, dict[str, Any]],
+    ) -> OrderReturn:
+        """Decline an order return
+
+        Args:
+            return_id: ID of the return.
+            approval_info: A ``ApprovalInfo`` model or dict.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.post(
+            f"/orderreturns/{return_id}/decline", json=self._serialize(approval_info)
+        )
+        return OrderReturn(**resp.json())
+
+    async def list_eligible_approvers(
+        self,
+        return_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[User]:
+        """List order return eligible approvers
+
+        Args:
+            return_id: ID of the return.
+            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(f"/orderreturns/{return_id}/eligibleapprovers", **params)
+        return self._parse_list(resp.json(), User)
+
+    async def delete_item(
+        self,
+        return_id: str,
+        line_item_id: str,
+    ) -> OrderReturn:
+        """Delete an order return item
+
+        Args:
+            return_id: ID of the return.
+            line_item_id: ID of the line item.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.delete(f"/orderreturns/{return_id}/items/{line_item_id}")
+        return OrderReturn(**resp.json())
+
+    async def submit(
+        self,
+        return_id: str,
+    ) -> OrderReturn:
+        """Submit an order return
+
+        Args:
+            return_id: ID of the return.
+
+        Returns:
+            The OrderReturn object.
+        """
+        resp = await self._http.post(f"/orderreturns/{return_id}/submit")
+        return OrderReturn(**resp.json())