ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/discount.py

@@ -0,0 +1,63 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud DiscountBreak, DiscountedPrices, Discount models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+
+__all__ = ["DiscountBreak", "DiscountedPrices", "Discount"]
+
+
+class DiscountBreak(OrderCloudModel):
+    """An OrderCloud DiscountBreak.
+
+    Attributes:
+        quantity: Minimum quantity required for this discount tier.
+        amount: Percentage discount (e.g., 10.5 for 10.5% off). Must be between 0 and 100.
+    """
+
+    quantity: Optional[int] = Field(None, alias="Quantity")
+    amount: Optional[float] = Field(None, alias="Amount")
+
+
+class DiscountedPrices(OrderCloudModel):
+    """An OrderCloud DiscountedPrices.
+
+    Attributes:
+        price: Discounted price per unit.
+        sale_price: Discounted sale price per unit.
+        subscription_price: Discounted subscription price per unit.
+        bundle_price: Discounted bundle price per unit.
+    """
+
+    price: Optional[float] = Field(None, alias="Price")
+    sale_price: Optional[float] = Field(None, alias="SalePrice")
+    subscription_price: Optional[float] = Field(None, alias="SubscriptionPrice")
+    bundle_price: Optional[float] = Field(None, alias="BundlePrice")
+
+
+class Discount(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Discount.
+
+    Attributes:
+        id:
+        description:
+        discount_breaks: Quantity-based percentage discount tiers. Each tier specifies a minimum quantity and percentage discount amount.
+        product_filter:
+        catalog_id:
+        category_id:
+        product_id:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    description: Optional[str] = Field(None, alias="Description")
+    discount_breaks: Optional[list[DiscountBreak]] = Field(None, alias="DiscountBreaks")
+    product_filter: Optional[str] = Field(None, alias="ProductFilter")
+    catalog_id: Optional[str] = Field(None, alias="CatalogID")
+    category_id: Optional[str] = Field(None, alias="CategoryID")
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/integration.py

@@ -0,0 +1,76 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud IntegrationEventType and related models."""
+
+from __future__ import annotations
+from typing import Any, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel
+from .misc import ApiRole
+
+__all__ = ["IntegrationEventType", "TrackingEventType", "IntegrationEvent", "TrackingEvent"]
+
+
+class IntegrationEventType(OrderCloudEnum):
+    """"""
+
+    OrderCheckout = "OrderCheckout"
+    OpenIDConnect = "OpenIDConnect"
+    OrderReturn = "OrderReturn"
+    AddToCart = "AddToCart"
+
+
+class TrackingEventType(OrderCloudEnum):
+    """"""
+
+    UserLoggedIn = "UserLoggedIn"
+    LineItemAdded = "LineItemAdded"
+    LineItemUpdated = "LineItemUpdated"
+    OrderSubmitted = "OrderSubmitted"
+
+
+class IntegrationEvent(OrderCloudModel):
+    """An OrderCloud IntegrationEvent.
+
+    Attributes:
+        elevated_roles:
+        id:
+        config_data: Any additional data needed for your integration event should be included here.
+        event_type:
+        custom_implementation_url: URL the integration event will POST data to, likely a route within your middleware.
+        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.
+        name:
+        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: Optional[list[ApiRole]] = Field(None, alias="ElevatedRoles")
+    id: Optional[str] = Field(None, alias="ID")
+    config_data: Optional[dict[str, Any]] = Field(None, alias="ConfigData")
+    event_type: Optional[IntegrationEventType] = Field(None, alias="EventType")
+    custom_implementation_url: Optional[str] = Field(None, alias="CustomImplementationUrl")
+    custom_auth_header_name: Optional[str] = Field(None, alias="CustomAuthHeaderName")
+    custom_auth_header_value: Optional[str] = Field(None, alias="CustomAuthHeaderValue")
+    name: Optional[str] = Field(None, alias="Name")
+    hash_key: Optional[str] = Field(None, alias="HashKey")
+
+
+class TrackingEvent(OrderCloudModel):
+    """An OrderCloud TrackingEvent.
+
+    Attributes:
+        id:
+        event_type:
+        client_id:
+        name:
+        config_data:
+        delivery_config_id:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    event_type: Optional[TrackingEventType] = Field(None, alias="EventType")
+    client_id: Optional[str] = Field(None, alias="ClientID")
+    name: Optional[str] = Field(None, alias="Name")
+    config_data: Optional[dict[str, Any]] = Field(None, alias="ConfigData")
+    delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")

ordercloud/models/inventory_record.py

@@ -0,0 +1,53 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud InventoryIntegration, InventoryRecord models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .address import Address
+
+__all__ = ["InventoryIntegration", "InventoryRecord"]
+_Address = Address
+
+
+class InventoryIntegration(OrderCloudModel):
+    """An OrderCloud InventoryIntegration.
+
+    Attributes:
+        delivery_config_id:
+        limit_notifications: When true, events will only fire when QuantityAvailable changes in the following ways: is equal to or less than 0, increases from 0 or less than 0 to a positive number, is equal to or less than NotificationPoint, increases from a number equal to or less than the NotificationPoint to a number greater than the NotificationPoint.
+    """
+
+    delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")
+    limit_notifications: Optional[bool] = Field(None, alias="LimitNotifications")
+
+
+class InventoryRecord(OrderCloudModel, Generic[XP]):
+    """An OrderCloud InventoryRecord.
+
+    Attributes:
+        id:
+        owner_id:
+        allow_all_buyers: Allow inventory record to be used by all buyers without creating explicit assignments.
+        address:  (read-only)
+        address_id: AddressID is required because an inventory record represents a location where physical inventory for a given product exists.
+        order_can_exceed:
+        quantity_available:
+        notification_point:
+        last_updated:  (read-only)
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    allow_all_buyers: bool = Field(True, alias="AllowAllBuyers")
+    address: Optional[_Address] = Field(None, alias="Address")
+    address_id: Optional[str] = Field(None, alias="AddressID")
+    order_can_exceed: Optional[bool] = Field(None, alias="OrderCanExceed")
+    quantity_available: Optional[int] = Field(None, alias="QuantityAvailable")
+    notification_point: Optional[int] = Field(None, alias="NotificationPoint")
+    last_updated: Optional[str] = Field(None, alias="LastUpdated")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/line_item.py

@@ -0,0 +1,95 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud BundleItems, LineItem models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .address import Address
+from .line_item_types import LineItemProduct, LineItemSpec, LineItemVariant
+
+__all__ = ["BundleItems", "LineItem"]
+
+
+class BundleItems(OrderCloudModel):
+    """An OrderCloud BundleItems.
+
+    Attributes:
+        line_items:
+    """
+
+    line_items: Optional[list[LineItem]] = Field(None, alias="LineItems")
+
+
+class LineItem(OrderCloudModel, Generic[XP]):
+    """An OrderCloud LineItem.
+
+    Attributes:
+        id:
+        product_id:
+        quantity:
+        bundle_item_id: The ID of the line item that represents the bundle. Signifies that the product is being purchased as part of a bundle. (read-only)
+        is_bundle: When true, this item represents a bundle being purchased. (read-only)
+        date_added:  (read-only)
+        quantity_shipped: Sum of QuantityShipped from all shipment items. (read-only)
+        unit_price: Auto calculated price per quantity. Modification requires OverrideUnitPrice role.
+        promotion_discount: Sum of all line item level promotion discount amounts applied. (read-only)
+        base_discount: Discount amount from discount assignments applied to this line item. (read-only)
+        discount_id: ID of the discount applied to this line item. (read-only)
+        line_total: LineSubtotal - BaseDiscount - PromotionDiscount (read-only)
+        line_subtotal: UnitPrice x Quantity (read-only)
+        cost_center: For reference only, does not influence any OrderCloud behavior.
+        date_needed:
+        shipping_account: For reference only, does not influence any OrderCloud behavior.
+        shipping_address_id:
+        ship_from_address_id: Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.
+        product:  (read-only)
+        variant:  (read-only)
+        shipping_address:  (read-only)
+        ship_from_address:  (read-only)
+        supplier_id:  (read-only)
+        inventory_record_id: InventoryRecordID of which product inventory location to use. Cannot be modified once an order is submitted.
+        price_schedule_id: PriceScheduleID used to determine unit price. (read-only)
+        is_on_sale: True when the price schedule and price break has an active SalePrice. (read-only)
+        price_overridden: If true, UnitPrice was overridden. (read-only)
+        specs:
+        incoming_order_id: ID of the original order. Only returns a value for the marketplace owner. (read-only)
+        outgoing_order_id: ID of the split or forwarded order. Only returns a value for the marketplace owner. (read-only)
+        invitation_id:  (read-only)
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    quantity: int = Field(1, alias="Quantity")
+    bundle_item_id: Optional[str] = Field(None, alias="BundleItemID")
+    is_bundle: Optional[bool] = Field(None, alias="IsBundle")
+    date_added: Optional[str] = Field(None, alias="DateAdded")
+    quantity_shipped: int = Field(0, alias="QuantityShipped")
+    unit_price: Optional[float] = Field(None, alias="UnitPrice")
+    promotion_discount: float = Field(0.0, alias="PromotionDiscount")
+    base_discount: float = Field(0.0, alias="BaseDiscount")
+    discount_id: Optional[str] = Field(None, alias="DiscountID")
+    line_total: float = Field(0.0, alias="LineTotal")
+    line_subtotal: float = Field(0.0, alias="LineSubtotal")
+    cost_center: Optional[str] = Field(None, alias="CostCenter")
+    date_needed: Optional[str] = Field(None, alias="DateNeeded")
+    shipping_account: Optional[str] = Field(None, alias="ShippingAccount")
+    shipping_address_id: Optional[str] = Field(None, alias="ShippingAddressID")
+    ship_from_address_id: Optional[str] = Field(None, alias="ShipFromAddressID")
+    product: Optional[LineItemProduct] = Field(None, alias="Product")
+    variant: Optional[LineItemVariant] = Field(None, alias="Variant")
+    shipping_address: Optional[Address] = Field(None, alias="ShippingAddress")
+    ship_from_address: Optional[Address] = Field(None, alias="ShipFromAddress")
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+    inventory_record_id: Optional[str] = Field(None, alias="InventoryRecordID")
+    price_schedule_id: Optional[str] = Field(None, alias="PriceScheduleID")
+    is_on_sale: Optional[bool] = Field(None, alias="IsOnSale")
+    price_overridden: Optional[bool] = Field(None, alias="PriceOverridden")
+    specs: Optional[list[LineItemSpec]] = Field(None, alias="Specs")
+    incoming_order_id: Optional[str] = Field(None, alias="IncomingOrderID")
+    outgoing_order_id: Optional[str] = Field(None, alias="OutgoingOrderID")
+    invitation_id: Optional[str] = Field(None, alias="InvitationID")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/line_item_types.py

@@ -0,0 +1,89 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud LineItemProduct, LineItemVariant, LineItemSpec models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .price_schedule import PriceMarkupType
+
+__all__ = ["LineItemProduct", "LineItemVariant", "LineItemSpec"]
+_PriceMarkupType = PriceMarkupType
+
+
+class LineItemProduct(OrderCloudModel, Generic[XP]):
+    """An OrderCloud LineItemProduct.
+
+    Attributes:
+        id:
+        name:
+        description:
+        returnable:
+        quantity_multiplier:
+        ship_weight:
+        ship_height:
+        ship_width:
+        ship_length:
+        default_supplier_id:
+        parent_id:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    returnable: Optional[bool] = Field(None, alias="Returnable")
+    quantity_multiplier: Optional[int] = Field(None, alias="QuantityMultiplier")
+    ship_weight: Optional[float] = Field(None, alias="ShipWeight")
+    ship_height: Optional[float] = Field(None, alias="ShipHeight")
+    ship_width: Optional[float] = Field(None, alias="ShipWidth")
+    ship_length: Optional[float] = Field(None, alias="ShipLength")
+    default_supplier_id: Optional[str] = Field(None, alias="DefaultSupplierID")
+    parent_id: Optional[str] = Field(None, alias="ParentID")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class LineItemVariant(OrderCloudModel, Generic[XP]):
+    """An OrderCloud LineItemVariant.
+
+    Attributes:
+        id:
+        name:
+        description:
+        ship_weight:
+        ship_height:
+        ship_width:
+        ship_length:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    ship_weight: Optional[float] = Field(None, alias="ShipWeight")
+    ship_height: Optional[float] = Field(None, alias="ShipHeight")
+    ship_width: Optional[float] = Field(None, alias="ShipWidth")
+    ship_length: Optional[float] = Field(None, alias="ShipLength")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class LineItemSpec(OrderCloudModel):
+    """An OrderCloud LineItemSpec.
+
+    Attributes:
+        spec_id:
+        name:  (read-only)
+        option_id:
+        value:
+        price_markup_type:
+        price_markup:
+    """
+
+    spec_id: Optional[str] = Field(None, alias="SpecID")
+    name: Optional[str] = Field(None, alias="Name")
+    option_id: Optional[str] = Field(None, alias="OptionID")
+    value: Optional[str] = Field(None, alias="Value")
+    price_markup_type: Optional[_PriceMarkupType] = Field(None, alias="PriceMarkupType")
+    price_markup: Optional[float] = Field(None, alias="PriceMarkup")

ordercloud/models/message_sender.py

@@ -0,0 +1,80 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud MessageType, MessageSenderConfig, MessageSender models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel, XP
+from .misc import ApiRole
+
+__all__ = ["MessageType", "MessageSenderConfig", "MessageSender"]
+
+
+class MessageType(OrderCloudEnum):
+    """"""
+
+    OrderDeclined = "OrderDeclined"
+    OrderSubmitted = "OrderSubmitted"
+    ShipmentCreated = "ShipmentCreated"
+    ForgottenPassword = "ForgottenPassword"
+    ForgottenUsername = "ForgottenUsername"
+    OrderSubmittedForYourApproval = "OrderSubmittedForYourApproval"
+    OrderSubmittedForApproval = "OrderSubmittedForApproval"
+    OrderApproved = "OrderApproved"
+    OrderSubmittedForYourApprovalHasBeenApproved = "OrderSubmittedForYourApprovalHasBeenApproved"
+    OrderSubmittedForYourApprovalHasBeenDeclined = "OrderSubmittedForYourApprovalHasBeenDeclined"
+    NewUserInvitation = "NewUserInvitation"
+    OrderReturnDeclined = "OrderReturnDeclined"
+    OrderReturnSubmitted = "OrderReturnSubmitted"
+    OrderReturnSubmittedForYourApproval = "OrderReturnSubmittedForYourApproval"
+    OrderReturnSubmittedForApproval = "OrderReturnSubmittedForApproval"
+    OrderReturnApproved = "OrderReturnApproved"
+    OrderReturnSubmittedForYourApprovalHasBeenApproved = (
+        "OrderReturnSubmittedForYourApprovalHasBeenApproved"
+    )
+    OrderReturnSubmittedForYourApprovalHasBeenDeclined = (
+        "OrderReturnSubmittedForYourApprovalHasBeenDeclined"
+    )
+    OrderReturnCompleted = "OrderReturnCompleted"
+    SubscriptionReminder = "SubscriptionReminder"
+    ProductCollectionInvitationAccepted = "ProductCollectionInvitationAccepted"
+    ProductCollectionInvitationDeclined = "ProductCollectionInvitationDeclined"
+    OneTimePassword = "OneTimePassword"
+
+
+class MessageSenderConfig(OrderCloudModel):
+    """An OrderCloud MessageSenderConfig.
+
+    Attributes:
+        secret:
+        endpoint:
+    """
+
+    secret: Optional[str] = Field(None, alias="Secret")
+    endpoint: Optional[str] = Field(None, alias="Endpoint")
+
+
+class MessageSender(OrderCloudModel, Generic[XP]):
+    """An OrderCloud MessageSender.
+
+    Attributes:
+        id:
+        name:
+        message_types:
+        description:
+        elevated_roles: If additional data not provided by the message sender is needed, provide any elevated roles needed to make additional calls.
+        xp:
+        delivery_config_id:
+        allow_all_buyers: Allow message sender to trigger for all buyers without creating explicit assignments.
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    message_types: Optional[list[MessageType]] = Field(None, alias="MessageTypes")
+    description: Optional[str] = Field(None, alias="Description")
+    elevated_roles: Optional[list[ApiRole]] = Field(None, alias="ElevatedRoles")
+    xp: Optional[XP] = Field(None, alias="xp")
+    delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")
+    allow_all_buyers: bool = Field(False, alias="AllowAllBuyers")