ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/resources/promotions.py

@@ -0,0 +1,203 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Promotions API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.assignments import PromotionAssignment
+from ..models.promotion import Promotion
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["PromotionsResource"]
+
+
+class PromotionsResource(BaseResource):
+    """Operations on OrderCloud Promotions."""
+
+    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[Promotion]:
+        """List promotions
+
+        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 Promotion 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("/promotions", **params)
+        return self._parse_list(resp.json(), Promotion)
+
+    async def create(
+        self,
+        promotion: Union[Promotion, dict[str, Any]],
+    ) -> Promotion:
+        """Create a promotion
+
+        Args:
+            promotion: A ``Promotion`` model or dict. Required fields: Code, EligibleExpression.
+
+        Returns:
+            The Promotion object.
+        """
+        resp = await self._http.post("/promotions", json=self._serialize(promotion))
+        return Promotion(**resp.json())
+
+    async def get(
+        self,
+        promotion_id: str,
+    ) -> Promotion:
+        """Retrieve a promotion
+
+        Args:
+            promotion_id: ID of the promotion.
+
+        Returns:
+            The Promotion object.
+        """
+        resp = await self._http.get(f"/promotions/{promotion_id}")
+        return Promotion(**resp.json())
+
+    async def save(
+        self,
+        promotion_id: str,
+        promotion: Union[Promotion, dict[str, Any]],
+    ) -> Promotion:
+        """Create or update a promotion
+
+        Args:
+            promotion_id: ID of the promotion.
+            promotion: A ``Promotion`` model or dict. Required fields: Code, EligibleExpression.
+
+        Returns:
+            The Promotion object.
+        """
+        resp = await self._http.put(
+            f"/promotions/{promotion_id}",
+            json=self._serialize(promotion),
+        )
+        return Promotion(**resp.json())
+
+    async def delete(
+        self,
+        promotion_id: str,
+    ) -> None:
+        """Delete a promotion
+
+        Args:
+            promotion_id: ID of the promotion.
+        """
+        await self._http.delete(f"/promotions/{promotion_id}")
+
+    async def patch(
+        self,
+        promotion_id: str,
+        partial: dict[str, Any],
+    ) -> Promotion:
+        """Partially update a promotion
+
+        Args:
+            promotion_id: ID of the promotion.
+            partial: A dict of fields to update.
+
+        Returns:
+            The Promotion object.
+        """
+        resp = await self._http.patch(f"/promotions/{promotion_id}", json=partial)
+        return Promotion(**resp.json())
+
+    async def delete_assignment(
+        self,
+        promotion_id: str,
+        *,
+        buyer_id: Optional[str],
+        user_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+    ) -> None:
+        """Delete a promotion assignment
+
+        Args:
+            promotion_id: ID of the promotion.
+            buyer_id: ID of the buyer.
+            user_id: ID of the user.
+            user_group_id: ID of the user group.
+        """
+        _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
+        await self._http.delete(f"/promotions/{promotion_id}/assignments", **_params)
+
+    async def list_assignments(
+        self,
+        *,
+        buyer_id: Optional[str] = None,
+        promotion_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        level: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+    ) -> ListPage[PromotionAssignment]:
+        """List promotion assignments
+
+        Args:
+            buyer_id: ID of the buyer.
+            promotion_id: ID of the promotion.
+            user_group_id: ID of the user group.
+            level: Level of the promotion 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.
+
+        Returns:
+            A paginated list of PromotionAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if buyer_id is not None:
+            params["buyerID"] = buyer_id
+        if promotion_id is not None:
+            params["promotionID"] = promotion_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("/promotions/assignments", **params)
+        return self._parse_list(resp.json(), PromotionAssignment)
+
+    async def save_assignment(
+        self,
+        promotion_assignment: Union[PromotionAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update a promotion assignment
+
+        Args:
+            promotion_assignment: A ``PromotionAssignment`` model or dict. Required fields: PromotionID, BuyerID.
+        """
+        await self._http.post("/promotions/assignments", json=self._serialize(promotion_assignment))

ordercloud/resources/security_profiles.py

@@ -0,0 +1,222 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud SecurityProfiles API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.assignments import SecurityProfileAssignment
+from ..models.misc import CommerceRole, PartyType
+from ..models.security import SecurityProfile
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["SecurityProfilesResource"]
+
+
+class SecurityProfilesResource(BaseResource):
+    """Operations on OrderCloud SecurityProfiles."""
+
+    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[SecurityProfile]:
+        """List security profiles
+
+        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 SecurityProfile 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("/securityprofiles", **params)
+        return self._parse_list(resp.json(), SecurityProfile)
+
+    async def create(
+        self,
+        security_profile: Union[SecurityProfile, dict[str, Any]],
+    ) -> SecurityProfile:
+        """Create a security profile
+
+        Args:
+            security_profile: A ``SecurityProfile`` model or dict. Required fields: Name.
+
+        Returns:
+            The SecurityProfile object.
+        """
+        resp = await self._http.post("/securityprofiles", json=self._serialize(security_profile))
+        return SecurityProfile(**resp.json())
+
+    async def get(
+        self,
+        security_profile_id: str,
+    ) -> SecurityProfile:
+        """Retrieve a security profile
+
+        Args:
+            security_profile_id: ID of the security profile.
+
+        Returns:
+            The SecurityProfile object.
+        """
+        resp = await self._http.get(f"/securityprofiles/{security_profile_id}")
+        return SecurityProfile(**resp.json())
+
+    async def save(
+        self,
+        security_profile_id: str,
+        security_profile: Union[SecurityProfile, dict[str, Any]],
+    ) -> SecurityProfile:
+        """Create or update a security profile
+
+        Args:
+            security_profile_id: ID of the security profile.
+            security_profile: A ``SecurityProfile`` model or dict. Required fields: Name.
+
+        Returns:
+            The SecurityProfile object.
+        """
+        resp = await self._http.put(
+            f"/securityprofiles/{security_profile_id}",
+            json=self._serialize(security_profile),
+        )
+        return SecurityProfile(**resp.json())
+
+    async def delete(
+        self,
+        security_profile_id: str,
+    ) -> None:
+        """Delete a security profile
+
+        Args:
+            security_profile_id: ID of the security profile.
+        """
+        await self._http.delete(f"/securityprofiles/{security_profile_id}")
+
+    async def patch(
+        self,
+        security_profile_id: str,
+        partial: dict[str, Any],
+    ) -> SecurityProfile:
+        """Partially update a security profile
+
+        Args:
+            security_profile_id: ID of the security profile.
+            partial: A dict of fields to update.
+
+        Returns:
+            The SecurityProfile object.
+        """
+        resp = await self._http.patch(f"/securityprofiles/{security_profile_id}", json=partial)
+        return SecurityProfile(**resp.json())
+
+    async def delete_assignment(
+        self,
+        security_profile_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 security profile assignment
+
+        Args:
+            security_profile_id: ID of the security profile.
+            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"/securityprofiles/{security_profile_id}/assignments", **_params)
+
+    async def list_assignments(
+        self,
+        *,
+        buyer_id: Optional[str] = None,
+        supplier_id: Optional[str] = None,
+        security_profile_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        commerce_role: Optional[CommerceRole] = None,
+        level: Optional[PartyType] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+    ) -> ListPage[SecurityProfileAssignment]:
+        """List security profile assignments
+
+        Args:
+            buyer_id: ID of the buyer.
+            supplier_id: ID of the supplier.
+            security_profile_id: ID of the security profile.
+            user_id: ID of the user.
+            user_group_id: ID of the user group.
+            commerce_role: Commerce role of the security profile assignment. Possible values: Buyer, Seller, Supplier.
+            level: Level of the security profile 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 SecurityProfileAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if buyer_id is not None:
+            params["buyerID"] = buyer_id
+        if supplier_id is not None:
+            params["supplierID"] = supplier_id
+        if security_profile_id is not None:
+            params["securityProfileID"] = security_profile_id
+        if user_id is not None:
+            params["userID"] = user_id
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        if commerce_role is not None:
+            params["commerceRole"] = commerce_role
+        if level is not None:
+            params["level"] = level
+        resp = await self._http.get("/securityprofiles/assignments", **params)
+        return self._parse_list(resp.json(), SecurityProfileAssignment)
+
+    async def save_assignment(
+        self,
+        security_profile_assignment: Union[SecurityProfileAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update a security profile assignment
+
+        Args:
+            security_profile_assignment: A ``SecurityProfileAssignment`` model or dict. Required fields: SecurityProfileID.
+        """
+        await self._http.post(
+            "/securityprofiles/assignments", json=self._serialize(security_profile_assignment)
+        )

ordercloud/resources/seller_approval_rules.py

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