ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/webhook.py

@@ -0,0 +1,58 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud WebhookRoute, Webhook models."""
+
+from __future__ import annotations
+from typing import Any, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel
+from .misc import ApiRole
+
+__all__ = ["WebhookRoute", "Webhook"]
+
+
+class WebhookRoute(OrderCloudModel):
+    """An OrderCloud WebhookRoute.
+
+    Attributes:
+        route:
+        verb:
+    """
+
+    route: Optional[str] = Field(None, alias="Route")
+    verb: Optional[str] = Field(None, alias="Verb")
+
+
+class Webhook(OrderCloudModel):
+    """An OrderCloud Webhook.
+
+    Attributes:
+        id:
+        name:
+        description:
+        url: URL the webhook will POST data to, likely a route within your middleware. Required unless there is a valid DeliveryConfig.
+        hash_key: Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.
+        elevated_roles: If you need additional data not provided by the webhook payload, you can request any elevated roles needed to make additional calls.
+        config_data:
+        before_process_request: If true, the webhook is processed prior to the call being made and OrderCloud waits for a response before proceeding.
+        api_client_i_ds: List of API client IDs the webhook will be triggered for.
+        webhook_routes: List of routes the webhook will be triggered for.
+        delivery_config_id:
+        custom_auth_header_name: The header name that can be passed to your middleware.
+        custom_auth_header_value: The header value that can be passed to your middleware.
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    url: Optional[str] = Field(None, alias="Url")
+    hash_key: Optional[str] = Field(None, alias="HashKey")
+    elevated_roles: Optional[list[ApiRole]] = Field(None, alias="ElevatedRoles")
+    config_data: Optional[dict[str, Any]] = Field(None, alias="ConfigData")
+    before_process_request: Optional[bool] = Field(None, alias="BeforeProcessRequest")
+    api_client_i_ds: Optional[list[str]] = Field(None, alias="ApiClientIDs")
+    webhook_routes: Optional[list[WebhookRoute]] = Field(None, alias="WebhookRoutes")
+    delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")
+    custom_auth_header_name: Optional[str] = Field(None, alias="CustomAuthHeaderName")
+    custom_auth_header_value: Optional[str] = Field(None, alias="CustomAuthHeaderValue")

ordercloud/resources/__init__.py

@@ -0,0 +1,65 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud API resource clients."""
+
+from .base import BaseResource  # noqa: F401
+from .addresses import AddressesResource  # noqa: F401
+from .admin_addresses import AdminAddressesResource  # noqa: F401
+from .admin_user_groups import AdminUserGroupsResource  # noqa: F401
+from .admin_users import AdminUsersResource  # noqa: F401
+from .api_clients import ApiClientsResource  # noqa: F401
+from .approval_rules import ApprovalRulesResource  # noqa: F401
+from .bundle_line_items import BundleLineItemsResource  # noqa: F401
+from .bundle_subscription_items import BundleSubscriptionItemsResource  # noqa: F401
+from .bundles import BundlesResource  # noqa: F401
+from .buyer_groups import BuyerGroupsResource  # noqa: F401
+from .buyers import BuyersResource  # noqa: F401
+from .cart import CartResource  # noqa: F401
+from .catalogs import CatalogsResource  # noqa: F401
+from .categories import CategoriesResource  # noqa: F401
+from .cost_centers import CostCentersResource  # noqa: F401
+from .credit_cards import CreditCardsResource  # noqa: F401
+from .delivery_configurations import DeliveryConfigurationsResource  # noqa: F401
+from .discounts import DiscountsResource  # noqa: F401
+from .entity_syncs import EntitySyncsResource  # noqa: F401
+from .error_configs import ErrorConfigsResource  # noqa: F401
+from .forgotten_credentials import ForgottenCredentialsResource  # noqa: F401
+from .group_orders import GroupOrdersResource  # noqa: F401
+from .impersonation_configs import ImpersonationConfigsResource  # noqa: F401
+from .incrementors import IncrementorsResource  # noqa: F401
+from .integration_events import IntegrationEventsResource  # noqa: F401
+from .inventory_integrations import InventoryIntegrationsResource  # noqa: F401
+from .inventory_records import InventoryRecordsResource  # noqa: F401
+from .line_items import LineItemsResource  # noqa: F401
+from .locales import LocalesResource  # noqa: F401
+from .me import MeResource  # noqa: F401
+from .message_senders import MessageSendersResource  # noqa: F401
+from .open_id_connects import OpenIdConnectsResource  # noqa: F401
+from .order_returns import OrderReturnsResource  # noqa: F401
+from .order_syncs import OrderSyncsResource  # noqa: F401
+from .orders import OrdersResource  # noqa: F401
+from .payments import PaymentsResource  # noqa: F401
+from .price_schedules import PriceSchedulesResource  # noqa: F401
+from .product_collections import ProductCollectionsResource  # noqa: F401
+from .product_facets import ProductFacetsResource  # noqa: F401
+from .product_syncs import ProductSyncsResource  # noqa: F401
+from .products import ProductsResource  # noqa: F401
+from .promotion_integrations import PromotionIntegrationsResource  # noqa: F401
+from .promotions import PromotionsResource  # noqa: F401
+from .security_profiles import SecurityProfilesResource  # noqa: F401
+from .seller_approval_rules import SellerApprovalRulesResource  # noqa: F401
+from .shipments import ShipmentsResource  # noqa: F401
+from .specs import SpecsResource  # noqa: F401
+from .spending_accounts import SpendingAccountsResource  # noqa: F401
+from .subscription_integrations import SubscriptionIntegrationsResource  # noqa: F401
+from .subscription_items import SubscriptionItemsResource  # noqa: F401
+from .subscriptions import SubscriptionsResource  # noqa: F401
+from .supplier_addresses import SupplierAddressesResource  # noqa: F401
+from .supplier_user_groups import SupplierUserGroupsResource  # noqa: F401
+from .supplier_users import SupplierUsersResource  # noqa: F401
+from .suppliers import SuppliersResource  # noqa: F401
+from .tracking_events import TrackingEventsResource  # noqa: F401
+from .user_groups import UserGroupsResource  # noqa: F401
+from .users import UsersResource  # noqa: F401
+from .webhooks import WebhooksResource  # noqa: F401
+from .xp_indices import XpIndicesResource  # noqa: F401

ordercloud/resources/addresses.py

@@ -0,0 +1,228 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Addresses API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.address import Address
+from ..models.assignments import AddressAssignment
+from ..models.misc import PartyType
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["AddressesResource"]
+
+
+class AddressesResource(BaseResource):
+    """Operations on OrderCloud Addresses."""
+
+    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[Address]:
+        """List addresses
+
+        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 Address 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}/addresses", **params)
+        return self._parse_list(resp.json(), Address)
+
+    async def create(
+        self,
+        buyer_id: str,
+        address: Union[Address, dict[str, Any]],
+    ) -> Address:
+        """Create an address
+
+        Args:
+            buyer_id: ID of the buyer.
+            address: A ``Address`` model or dict. Required fields: Street1, City, Country.
+
+        Returns:
+            The Address object.
+        """
+        resp = await self._http.post(f"/buyers/{buyer_id}/addresses", json=self._serialize(address))
+        return Address(**resp.json())
+
+    async def get(
+        self,
+        buyer_id: str,
+        address_id: str,
+    ) -> Address:
+        """Retrieve an address
+
+        Args:
+            buyer_id: ID of the buyer.
+            address_id: ID of the address.
+
+        Returns:
+            The Address object.
+        """
+        resp = await self._http.get(f"/buyers/{buyer_id}/addresses/{address_id}")
+        return Address(**resp.json())
+
+    async def save(
+        self,
+        buyer_id: str,
+        address_id: str,
+        address: Union[Address, dict[str, Any]],
+    ) -> Address:
+        """Create or update an address
+
+        Args:
+            buyer_id: ID of the buyer.
+            address_id: ID of the address.
+            address: A ``Address`` model or dict. Required fields: Street1, City, Country.
+
+        Returns:
+            The Address object.
+        """
+        resp = await self._http.put(
+            f"/buyers/{buyer_id}/addresses/{address_id}",
+            json=self._serialize(address),
+        )
+        return Address(**resp.json())
+
+    async def delete(
+        self,
+        buyer_id: str,
+        address_id: str,
+    ) -> None:
+        """Delete an address
+
+        Args:
+            buyer_id: ID of the buyer.
+            address_id: ID of the address.
+        """
+        await self._http.delete(f"/buyers/{buyer_id}/addresses/{address_id}")
+
+    async def patch(
+        self,
+        buyer_id: str,
+        address_id: str,
+        partial: dict[str, Any],
+    ) -> Address:
+        """Partially update an address
+
+        Args:
+            buyer_id: ID of the buyer.
+            address_id: ID of the address.
+            partial: A dict of fields to update.
+
+        Returns:
+            The Address object.
+        """
+        resp = await self._http.patch(f"/buyers/{buyer_id}/addresses/{address_id}", json=partial)
+        return Address(**resp.json())
+
+    async def delete_assignment(
+        self,
+        buyer_id: str,
+        address_id: str,
+        *,
+        user_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+    ) -> None:
+        """Delete an address assignment
+
+        Args:
+            buyer_id: ID of the buyer.
+            address_id: ID of the address.
+            user_id: ID of the user.
+            user_group_id: ID of the user group.
+        """
+        _params: dict[str, Any] = {}
+        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"/buyers/{buyer_id}/addresses/{address_id}/assignments", **_params)
+
+    async def list_assignments(
+        self,
+        buyer_id: str,
+        *,
+        address_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        user_group_id: Optional[str] = None,
+        level: Optional[PartyType] = None,
+        is_shipping: Optional[bool] = None,
+        is_billing: Optional[bool] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+    ) -> ListPage[AddressAssignment]:
+        """List address assignments
+
+        Args:
+            buyer_id: ID of the buyer.
+            address_id: ID of the address.
+            user_id: ID of the user.
+            user_group_id: ID of the user group.
+            level: Level of the address assignment. Possible values: User, Group, Company, BuyerGroup.
+            is_shipping: Is shipping of the address assignment.
+            is_billing: Is billing of the address assignment.
+            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 AddressAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if address_id is not None:
+            params["addressID"] = address_id
+        if user_id is not None:
+            params["userID"] = user_id
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        if level is not None:
+            params["level"] = level
+        if is_shipping is not None:
+            params["isShipping"] = is_shipping
+        if is_billing is not None:
+            params["isBilling"] = is_billing
+        resp = await self._http.get(f"/buyers/{buyer_id}/addresses/assignments", **params)
+        return self._parse_list(resp.json(), AddressAssignment)
+
+    async def save_assignment(
+        self,
+        buyer_id: str,
+        address_assignment: Union[AddressAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update an address assignment
+
+        Args:
+            buyer_id: ID of the buyer.
+            address_assignment: A ``AddressAssignment`` model or dict. Required fields: AddressID.
+        """
+        await self._http.post(
+            f"/buyers/{buyer_id}/addresses/assignments", json=self._serialize(address_assignment)
+        )

ordercloud/resources/admin_addresses.py

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

ordercloud/resources/admin_user_groups.py

@@ -0,0 +1,185 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud AdminUserGroups API resource."""
+
+from __future__ import annotations
+from typing import Any, Optional, Union
+
+from ..models.assignments import UserGroupAssignment
+from ..models.user_group import UserGroup
+from ..models.shared import ListPage
+from .base import BaseResource
+
+__all__ = ["AdminUserGroupsResource"]
+
+
+class AdminUserGroupsResource(BaseResource):
+    """Operations on OrderCloud AdminUserGroups."""
+
+    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[UserGroup]:
+        """List admin user groups
+
+        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 UserGroup 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("/usergroups", **params)
+        return self._parse_list(resp.json(), UserGroup)
+
+    async def create(
+        self,
+        user_group: Union[UserGroup, dict[str, Any]],
+    ) -> UserGroup:
+        """Create an admin user group
+
+        Args:
+            user_group: A ``UserGroup`` model or dict. Required fields: Name.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.post("/usergroups", json=self._serialize(user_group))
+        return UserGroup(**resp.json())
+
+    async def get(
+        self,
+        user_group_id: str,
+    ) -> UserGroup:
+        """Retrieve an admin user group
+
+        Args:
+            user_group_id: ID of the user group.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.get(f"/usergroups/{user_group_id}")
+        return UserGroup(**resp.json())
+
+    async def save(
+        self,
+        user_group_id: str,
+        user_group: Union[UserGroup, dict[str, Any]],
+    ) -> UserGroup:
+        """Create or update an admin user group
+
+        Args:
+            user_group_id: ID of the user group.
+            user_group: A ``UserGroup`` model or dict. Required fields: Name.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.put(
+            f"/usergroups/{user_group_id}",
+            json=self._serialize(user_group),
+        )
+        return UserGroup(**resp.json())
+
+    async def delete(
+        self,
+        user_group_id: str,
+    ) -> None:
+        """Delete an admin user group
+
+        Args:
+            user_group_id: ID of the user group.
+        """
+        await self._http.delete(f"/usergroups/{user_group_id}")
+
+    async def patch(
+        self,
+        user_group_id: str,
+        partial: dict[str, Any],
+    ) -> UserGroup:
+        """Partially update an admin user group
+
+        Args:
+            user_group_id: ID of the user group.
+            partial: A dict of fields to update.
+
+        Returns:
+            The UserGroup object.
+        """
+        resp = await self._http.patch(f"/usergroups/{user_group_id}", json=partial)
+        return UserGroup(**resp.json())
+
+    async def delete_user_assignment(
+        self,
+        user_group_id: str,
+        user_id: str,
+    ) -> None:
+        """Delete an admin user group user assignment
+
+        Args:
+            user_group_id: ID of the user group.
+            user_id: ID of the user.
+        """
+        await self._http.delete(f"/usergroups/{user_group_id}/assignments/{user_id}")
+
+    async def list_user_assignments(
+        self,
+        *,
+        user_group_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+    ) -> ListPage[UserGroupAssignment]:
+        """List admin user group user assignments
+
+        Args:
+            user_group_id: ID of the user group.
+            user_id: ID of the user.
+            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 UserGroupAssignment objects.
+        """
+        params = self._build_list_params(
+            page=page,
+            page_size=page_size,
+        )
+        if user_group_id is not None:
+            params["userGroupID"] = user_group_id
+        if user_id is not None:
+            params["userID"] = user_id
+        resp = await self._http.get("/usergroups/assignments", **params)
+        return self._parse_list(resp.json(), UserGroupAssignment)
+
+    async def save_user_assignment(
+        self,
+        user_group_assignment: Union[UserGroupAssignment, dict[str, Any]],
+    ) -> None:
+        """Create or update an admin user group user assignment
+
+        Args:
+            user_group_assignment: A ``UserGroupAssignment`` model or dict. Required fields: UserGroupID, UserID.
+        """
+        await self._http.post(
+            "/usergroups/assignments", json=self._serialize(user_group_assignment)
+        )