ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/middleware.py

@@ -0,0 +1,66 @@
+"""Middleware hook types for intercepting HTTP requests and responses."""
+
+from dataclasses import dataclass, field
+from typing import Any, Awaitable, Callable, Optional
+
+import httpx
+
+__all__ = [
+    "RequestContext",
+    "ResponseContext",
+    "BeforeRequest",
+    "AfterResponse",
+]
+
+
+@dataclass
+class RequestContext:
+    """Mutable context passed to before-request hooks.
+
+    Hooks can modify ``headers``, ``params``, or ``json`` in place
+    before the request is sent.
+
+    Attributes:
+        method: HTTP method (e.g. ``"GET"``).
+        path: API path relative to the base URL.
+        url: Fully resolved request URL.
+        headers: Request headers (mutable).
+        params: Query parameters (mutable, may be ``None``).
+        json: JSON request body (mutable, may be ``None``).
+    """
+
+    method: str
+    path: str
+    url: str
+    headers: dict[str, str] = field(default_factory=dict)
+    params: Optional[dict[str, Any]] = None
+    json: Optional[dict[str, Any]] = None
+
+
+@dataclass
+class ResponseContext:
+    """Context passed to after-response hooks.
+
+    Attributes:
+        request: The request context that produced this response.
+        response: The HTTP response.
+        attempt: Zero-based attempt number (0 on first try, >0 on retries).
+    """
+
+    request: RequestContext
+    response: httpx.Response
+    attempt: int
+
+
+BeforeRequest = Callable[[RequestContext], Awaitable[None]]
+"""Async callable invoked before each HTTP request.
+
+Receives a mutable ``RequestContext`` — modify it to alter headers,
+params, or the JSON body before the request is sent.
+"""
+
+AfterResponse = Callable[[ResponseContext], Awaitable[None]]
+"""Async callable invoked after each HTTP response (including retries).
+
+Receives a ``ResponseContext`` with the request details and the response.
+"""

ordercloud/models/__init__.py

@@ -0,0 +1,271 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud API models."""
+
+from .product import (  # noqa: F401
+    Inventory,
+    VariantInventory,
+    VariantSpec,
+    VariantOverrides,
+    Variant,
+    AdHocProduct,
+    ProductSupplier,
+    Product,
+)
+from .bundle import (  # noqa: F401
+    Bundle,
+)
+from .order import (  # noqa: F401
+    OrderApprovalInfo,
+    ApprovalInfo,
+    OrderApproval,
+    OrderPromotion,
+    ShipMethodSelection,
+    OrderShipMethodSelection,
+    OrderSplitResult,
+    OrderSubmitResponse,
+    OrderSubmitForApprovalResponse,
+    OrderApprovedResponse,
+    OrderCalculateResponse,
+    LineItemOverride,
+    ExtendedLineItem,
+    OrderWorksheet,
+    Order,
+    OrderDirection,
+    OrderStatus,
+)
+from .line_item import (  # noqa: F401
+    BundleItems,
+    LineItem,
+)
+from .line_item_types import (  # noqa: F401
+    LineItemProduct,
+    LineItemVariant,
+    LineItemSpec,
+)
+from .order_return import (  # noqa: F401
+    OrderReturnItem,
+    OrderReturnApproval,
+    OrderReturn,
+)
+from .buyer import (  # noqa: F401
+    BuyerPriceBreak,
+    BuyerPriceSchedule,
+    ProductSeller,
+    BuyerAddress,
+    BuyerCreditCard,
+    BuyerProduct,
+    BuyerSupplier,
+    BuyerGroup,
+    Buyer,
+)
+from .user import (  # noqa: F401
+    UserOrderMoveOption,
+    Locale,
+    MeBuyer,
+    MeSeller,
+    MeSupplier,
+    OrderUser,
+    MeUser,
+    User,
+)
+from .catalog import (  # noqa: F401
+    Catalog,
+)
+from .category import (  # noqa: F401
+    Category,
+)
+from .address import (  # noqa: F401
+    Address,
+)
+from .supplier import (  # noqa: F401
+    SupplierBuyer,
+    Supplier,
+)
+from .price_schedule import (  # noqa: F401
+    PriceMarkupType,
+    PriceBreak,
+    PriceSchedule,
+)
+from .spec import (  # noqa: F401
+    SpecOption,
+    Spec,
+)
+from .promotion import (  # noqa: F401
+    PromotionOverride,
+    PromotionIntegration,
+    AddedPromo,
+    RemovedPromo,
+    EligiblePromotion,
+    RefreshPromosResponse,
+    Promotion,
+)
+from .payment import (  # noqa: F401
+    PaymentType,
+    PaymentTransaction,
+    Payment,
+)
+from .discount import (  # noqa: F401
+    DiscountBreak,
+    DiscountedPrices,
+    Discount,
+)
+from .shipment import (  # noqa: F401
+    ShipMethod,
+    ShipEstimateItem,
+    ShipEstimate,
+    ShipEstimateResponse,
+    ShipmentItem,
+    Shipment,
+)
+from .cost_center import (  # noqa: F401
+    CostCenter,
+)
+from .credit_card import (  # noqa: F401
+    CreditCard,
+)
+from .spending_account import (  # noqa: F401
+    SpendingAccount,
+)
+from .inventory_record import (  # noqa: F401
+    InventoryIntegration,
+    InventoryRecord,
+)
+from .user_group import (  # noqa: F401
+    UserGroup,
+)
+from .security import (  # noqa: F401
+    PasswordConfig,
+    ImpersonationConfig,
+    SecurityProfile,
+)
+from .api_client import (  # noqa: F401
+    ApiClientSecret,
+    ApiClientSecretCreateResponse,
+    ApiClient,
+)
+from .approval import (  # noqa: F401
+    ApprovalStatus,
+    ApprovalType,
+    ApprovalRule,
+    SellerApprovalRule,
+)
+from .subscription import (  # noqa: F401
+    SubscriptionInterval,
+    SubscriptionPayment,
+    SubscriptionIntegration,
+    SubscriptionIntegrationResponse,
+    Subscription,
+)
+from .message_sender import (  # noqa: F401
+    MessageType,
+    MessageSenderConfig,
+    MessageSender,
+)
+from .webhook import (  # noqa: F401
+    WebhookRoute,
+    Webhook,
+)
+from .integration import (  # noqa: F401
+    IntegrationEventType,
+    TrackingEventType,
+    IntegrationEvent,
+    TrackingEvent,
+)
+from .open_id_connect import (  # noqa: F401
+    OpenIdConnect,
+)
+from .delivery import (  # noqa: F401
+    KafkaConfig,
+    HttpConfig,
+    EventHubConfig,
+    AzureBlobConfig,
+    AzureTableConfig,
+    CosmosDbConfig,
+    MailchimpConfig,
+    ContentHubConfig,
+    SearchIngestionContent,
+    SearchIngestionHttpContent,
+    SearchIngestion,
+    DeliveryTargets,
+    DeliveryConfig,
+    SendEvent,
+    DiscoverEvent,
+    ErrorConfig,
+)
+from .sync import (  # noqa: F401
+    EntitySyncConfig,
+    OrderSyncConfig,
+    ProductSyncConfig,
+    SyncAdminUser,
+    SyncBuyer,
+    SyncBuyerUser,
+    SyncBuyerUserGroup,
+    SyncCategory,
+    SyncInventoryRecord,
+    SyncProduct,
+    SyncSupplier,
+    SyncSupplierUser,
+)
+from .product_collection import (  # noqa: F401
+    ProductCollectionEntry,
+    ProductCollectionProduct,
+    ProductCollectionBuyerProduct,
+    ProductCollectionInvitation,
+    ProductCollection,
+)
+from .assignments import (  # noqa: F401
+    AddressAssignment,
+    ApiClientAssignment,
+    BundleAssignment,
+    BundleCatalogAssignment,
+    BundleProductAssignment,
+    CatalogAssignment,
+    CategoryAssignment,
+    CategoryBundleAssignment,
+    CategoryProductAssignment,
+    CostCenterAssignment,
+    CreditCardAssignment,
+    DiscountAssignment,
+    InventoryRecordAssignment,
+    LocaleAssignment,
+    MessageCCListenerAssignment,
+    MessageSenderAssignment,
+    ProductAssignment,
+    ProductCatalogAssignment,
+    PromotionAssignment,
+    SecurityProfileAssignment,
+    SpecProductAssignment,
+    SpendingAccountAssignment,
+    UserGroupAssignment,
+)
+from .auth_models import (  # noqa: F401
+    AccessToken,
+    AccessTokenBasic,
+    ImpersonateTokenRequest,
+    OneTimePasswordRequest,
+    PasswordReset,
+    PasswordResetRequest,
+    TokenPasswordReset,
+)
+from .misc import (  # noqa: F401
+    AccessLevel,
+    ApiRole,
+    CommerceRole,
+    PartyType,
+    SearchType,
+    XpThingType,
+    Incrementor,
+    XpIndex,
+    ProductFacet,
+    GroupOrderInvitation,
+)
+from .shared import (  # noqa: F401
+    ListFacet,
+    ListFacetValue,
+    ListPage,
+    Meta,
+    MetaWithFacets,
+    OrderCloudEnum,
+    OrderCloudModel,
+)

ordercloud/models/address.py

@@ -0,0 +1,47 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Address models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+
+__all__ = ["Address"]
+
+
+class Address(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Address.
+
+    Attributes:
+        id:
+        date_created:  (read-only)
+        company_name:
+        first_name:
+        last_name:
+        street1:
+        street2:
+        city:
+        state:
+        zip:
+        country:
+        phone:
+        address_name:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    company_name: Optional[str] = Field(None, alias="CompanyName")
+    first_name: Optional[str] = Field(None, alias="FirstName")
+    last_name: Optional[str] = Field(None, alias="LastName")
+    street1: Optional[str] = Field(None, alias="Street1")
+    street2: Optional[str] = Field(None, alias="Street2")
+    city: Optional[str] = Field(None, alias="City")
+    state: Optional[str] = Field(None, alias="State")
+    zip: Optional[str] = Field(None, alias="Zip")
+    country: Optional[str] = Field(None, alias="Country")
+    phone: Optional[str] = Field(None, alias="Phone")
+    address_name: Optional[str] = Field(None, alias="AddressName")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/api_client.py

@@ -0,0 +1,116 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud ApiClientSecret, ApiClientSecretCreateResponse, ApiClient models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .misc import ApiRole
+
+__all__ = ["ApiClientSecret", "ApiClientSecretCreateResponse", "ApiClient"]
+
+
+class ApiClientSecret(OrderCloudModel):
+    """An OrderCloud ApiClientSecret.
+
+    Attributes:
+        id:
+        name:
+        expiration:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    expiration: Optional[str] = Field(None, alias="Expiration")
+
+
+class ApiClientSecretCreateResponse(OrderCloudModel):
+    """An OrderCloud ApiClientSecretCreateResponse.
+
+    Attributes:
+        client_secret:  (read-only)
+        id:
+        name:
+        expiration:
+    """
+
+    client_secret: Optional[str] = Field(None, alias="ClientSecret")
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    expiration: Optional[str] = Field(None, alias="Expiration")
+
+
+class ApiClient(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ApiClient.
+
+    Attributes:
+        id: Used for OAuth 2.0 workflows and impersonation. (read-only)
+        client_secret: Enables the OAuth 2.0 client credentials grant type. Required on all OAuth workflows when present.
+        access_token_duration:
+        active: All user authentication is prohibited if false.
+        app_name:
+        refresh_token_duration:
+        anonymous_token_duration: Specifies the duration of anonymous tokens, expressed in minutes. This value is only used if the API Client is configured for anonymous shopping.
+        default_context_user_name: Optionally define a user that will be used when authenticating with a client credentials grant type flow. This grant type is often used for anonymous browsing on buyer applications and authentication on server integration layers.
+        xp:
+        allow_any_buyer: Allow all buyer users in your organization access to authenticate using this API Client.
+        allow_any_supplier: Allow all supplier users in your organization access to authenticate using this API Client.
+        allow_seller: Allow all marketplace owner users in your organization access to authenticate using this API Client.
+        is_anon_buyer: Enables anonymous shopping when a buyer user is the DefaultContextUser.
+        assigned_buyer_count:  (read-only)
+        assigned_supplier_count:  (read-only)
+        order_checkout_integration_event_id: If populated, an error will be thrown when attempting to submit an order that has not been processed through the OrderCheckout integration.
+        order_checkout_integration_event_name:  (read-only)
+        order_return_integration_event_id: If populated, and not overriden by an OrderAdmin, the integration event will be used to calculate ReturnAmount on the order return or each individual return item.
+        order_return_integration_event_name:  (read-only)
+        add_to_cart_integration_event_id: If populated, the integration event will be used to fetch product information from an external system when a line item is added to an unsubmitted order and the product does not exist in OrderCloud.
+        add_to_cart_integration_event_name:  (read-only)
+        minimum_required_roles:
+        minimum_required_custom_roles:
+        maximum_granted_roles:
+        maximum_granted_custom_roles:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    client_secret: Optional[str] = Field(None, alias="ClientSecret")
+    access_token_duration: Optional[int] = Field(None, alias="AccessTokenDuration")
+    active: Optional[bool] = Field(None, alias="Active")
+    app_name: Optional[str] = Field(None, alias="AppName")
+    refresh_token_duration: Optional[int] = Field(None, alias="RefreshTokenDuration")
+    anonymous_token_duration: int = Field(10080, alias="AnonymousTokenDuration")
+    default_context_user_name: Optional[str] = Field(None, alias="DefaultContextUserName")
+    xp: Optional[XP] = Field(None, alias="xp")
+    allow_any_buyer: Optional[bool] = Field(None, alias="AllowAnyBuyer")
+    allow_any_supplier: Optional[bool] = Field(None, alias="AllowAnySupplier")
+    allow_seller: Optional[bool] = Field(None, alias="AllowSeller")
+    is_anon_buyer: Optional[bool] = Field(None, alias="IsAnonBuyer")
+    assigned_buyer_count: int = Field(0, alias="AssignedBuyerCount")
+    assigned_supplier_count: int = Field(0, alias="AssignedSupplierCount")
+    order_checkout_integration_event_id: Optional[str] = Field(
+        None, alias="OrderCheckoutIntegrationEventID"
+    )
+    order_checkout_integration_event_name: Optional[str] = Field(
+        None, alias="OrderCheckoutIntegrationEventName"
+    )
+    order_return_integration_event_id: Optional[str] = Field(
+        None, alias="OrderReturnIntegrationEventID"
+    )
+    order_return_integration_event_name: Optional[str] = Field(
+        None, alias="OrderReturnIntegrationEventName"
+    )
+    add_to_cart_integration_event_id: Optional[str] = Field(
+        None, alias="AddToCartIntegrationEventID"
+    )
+    add_to_cart_integration_event_name: Optional[str] = Field(
+        None, alias="AddToCartIntegrationEventName"
+    )
+    minimum_required_roles: Optional[list[ApiRole]] = Field(None, alias="MinimumRequiredRoles")
+    minimum_required_custom_roles: Optional[list[str]] = Field(
+        None, alias="MinimumRequiredCustomRoles"
+    )
+    maximum_granted_roles: Optional[list[ApiRole]] = Field(None, alias="MaximumGrantedRoles")
+    maximum_granted_custom_roles: Optional[list[str]] = Field(
+        None, alias="MaximumGrantedCustomRoles"
+    )

ordercloud/models/approval.py

@@ -0,0 +1,73 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud ApprovalStatus and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel, XP
+
+__all__ = ["ApprovalStatus", "ApprovalType", "ApprovalRule", "SellerApprovalRule"]
+
+
+class ApprovalStatus(OrderCloudEnum):
+    """"""
+
+    Pending = "Pending"
+    Approved = "Approved"
+    Declined = "Declined"
+
+
+class ApprovalType(OrderCloudEnum):
+    """"""
+
+    Order = "Order"
+    OrderReturn = "OrderReturn"
+
+
+class ApprovalRule(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ApprovalRule.
+
+    Attributes:
+        id:
+        name:
+        description:
+        approving_group_id:
+        rule_expression: The expression evaluated to determine an order requires approval. See rules engine documentation for formatting details.
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    approving_group_id: Optional[str] = Field(None, alias="ApprovingGroupID")
+    rule_expression: Optional[str] = Field(None, alias="RuleExpression")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class SellerApprovalRule(OrderCloudModel, Generic[XP]):
+    """An OrderCloud SellerApprovalRule.
+
+    Attributes:
+        owner_id: ID of the organization who owns the rule. Only the marketplace owner can write a value other than their own organization ID. The value is used to look up the ApprovingGroupID.
+        approval_type: OrderReturn is the only ApprovalType supported currently.
+        id:
+        name:
+        description:
+        approving_group_id:
+        rule_expression: The expression evaluated to determine an order requires approval. See rules engine documentation for formatting details.
+        xp:
+    """
+
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    approval_type: Optional[_ApprovalType] = Field(None, alias="ApprovalType")
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    approving_group_id: Optional[str] = Field(None, alias="ApprovingGroupID")
+    rule_expression: Optional[str] = Field(None, alias="RuleExpression")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+_ApprovalType = ApprovalType