ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/promotion.py

@@ -0,0 +1,297 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud PromotionOverride and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+
+__all__ = [
+    "PromotionOverride",
+    "PromotionIntegration",
+    "AddedPromo",
+    "RemovedPromo",
+    "EligiblePromotion",
+    "RefreshPromosResponse",
+    "Promotion",
+]
+
+
+class PromotionOverride(OrderCloudModel):
+    """An OrderCloud PromotionOverride.
+
+    Attributes:
+        promotion_id:
+        amount: Overrides the promotion's calculated discount to this amount.
+    """
+
+    promotion_id: Optional[str] = Field(None, alias="PromotionID")
+    amount: Optional[float] = Field(None, alias="Amount")
+
+
+class PromotionIntegration(OrderCloudModel):
+    """An OrderCloud PromotionIntegration.
+
+    Attributes:
+        hash_key: Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.
+        url:
+        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.
+    """
+
+    hash_key: Optional[str] = Field(None, alias="HashKey")
+    url: Optional[str] = Field(None, alias="Url")
+    custom_auth_header_name: Optional[str] = Field(None, alias="CustomAuthHeaderName")
+    custom_auth_header_value: Optional[str] = Field(None, alias="CustomAuthHeaderValue")
+
+
+class AddedPromo(OrderCloudModel, Generic[XP]):
+    """An OrderCloud AddedPromo.
+
+    Attributes:
+        line_item_id:
+        amount:
+        id:
+        line_item_level: If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level.
+        code: Must be unique. Entered by buyer when adding promo to order.
+        name:
+        redemption_limit: Limit the total number of orders this promotion can be applied to across all users.
+        redemption_limit_per_user: Limit the total number of orders this promotion can be applied to per user.
+        redemption_count: The number of times this promotion has been applied to an order. (read-only)
+        quantity_limit_per_order: Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_limit_per_order: Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_sort_by: Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.
+        description:
+        fine_print: For reference only. Terms, conditions, and other legal jargon.
+        start_date:
+        expiration_date:
+        eligible_expression: The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.
+        value_expression: The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.
+        can_combine: If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined.
+        allow_all_buyers: Allow promo to be used by all buyers without creating explicit assignments.
+        owner_id: ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create.
+        auto_apply:
+        active:
+        use_integration:
+        priority: Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint.
+        xp:
+    """
+
+    line_item_id: Optional[str] = Field(None, alias="LineItemID")
+    amount: Optional[float] = Field(None, alias="Amount")
+    id: Optional[str] = Field(None, alias="ID")
+    line_item_level: Optional[bool] = Field(None, alias="LineItemLevel")
+    code: Optional[str] = Field(None, alias="Code")
+    name: Optional[str] = Field(None, alias="Name")
+    redemption_limit: Optional[int] = Field(None, alias="RedemptionLimit")
+    redemption_limit_per_user: Optional[int] = Field(None, alias="RedemptionLimitPerUser")
+    redemption_count: int = Field(0, alias="RedemptionCount")
+    quantity_limit_per_order: Optional[int] = Field(None, alias="QuantityLimitPerOrder")
+    item_limit_per_order: Optional[int] = Field(None, alias="ItemLimitPerOrder")
+    item_sort_by: Optional[str] = Field(None, alias="ItemSortBy")
+    description: Optional[str] = Field(None, alias="Description")
+    fine_print: Optional[str] = Field(None, alias="FinePrint")
+    start_date: Optional[str] = Field(None, alias="StartDate")
+    expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
+    eligible_expression: Optional[str] = Field(None, alias="EligibleExpression")
+    value_expression: Optional[str] = Field(None, alias="ValueExpression")
+    can_combine: Optional[bool] = Field(None, alias="CanCombine")
+    allow_all_buyers: Optional[bool] = Field(None, alias="AllowAllBuyers")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    auto_apply: bool = Field(False, alias="AutoApply")
+    active: bool = Field(True, alias="Active")
+    use_integration: Optional[bool] = Field(None, alias="UseIntegration")
+    priority: Optional[int] = Field(None, alias="Priority")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class RemovedPromo(OrderCloudModel, Generic[XP]):
+    """An OrderCloud RemovedPromo.
+
+    Attributes:
+        error_code:
+        reason:
+        line_item_id:
+        amount:
+        id:
+        line_item_level: If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level.
+        code: Must be unique. Entered by buyer when adding promo to order.
+        name:
+        redemption_limit: Limit the total number of orders this promotion can be applied to across all users.
+        redemption_limit_per_user: Limit the total number of orders this promotion can be applied to per user.
+        redemption_count: The number of times this promotion has been applied to an order. (read-only)
+        quantity_limit_per_order: Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_limit_per_order: Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_sort_by: Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.
+        description:
+        fine_print: For reference only. Terms, conditions, and other legal jargon.
+        start_date:
+        expiration_date:
+        eligible_expression: The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.
+        value_expression: The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.
+        can_combine: If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined.
+        allow_all_buyers: Allow promo to be used by all buyers without creating explicit assignments.
+        owner_id: ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create.
+        auto_apply:
+        active:
+        use_integration:
+        priority: Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint.
+        xp:
+    """
+
+    error_code: Optional[str] = Field(None, alias="ErrorCode")
+    reason: Optional[str] = Field(None, alias="Reason")
+    line_item_id: Optional[str] = Field(None, alias="LineItemID")
+    amount: Optional[float] = Field(None, alias="Amount")
+    id: Optional[str] = Field(None, alias="ID")
+    line_item_level: Optional[bool] = Field(None, alias="LineItemLevel")
+    code: Optional[str] = Field(None, alias="Code")
+    name: Optional[str] = Field(None, alias="Name")
+    redemption_limit: Optional[int] = Field(None, alias="RedemptionLimit")
+    redemption_limit_per_user: Optional[int] = Field(None, alias="RedemptionLimitPerUser")
+    redemption_count: int = Field(0, alias="RedemptionCount")
+    quantity_limit_per_order: Optional[int] = Field(None, alias="QuantityLimitPerOrder")
+    item_limit_per_order: Optional[int] = Field(None, alias="ItemLimitPerOrder")
+    item_sort_by: Optional[str] = Field(None, alias="ItemSortBy")
+    description: Optional[str] = Field(None, alias="Description")
+    fine_print: Optional[str] = Field(None, alias="FinePrint")
+    start_date: Optional[str] = Field(None, alias="StartDate")
+    expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
+    eligible_expression: Optional[str] = Field(None, alias="EligibleExpression")
+    value_expression: Optional[str] = Field(None, alias="ValueExpression")
+    can_combine: Optional[bool] = Field(None, alias="CanCombine")
+    allow_all_buyers: Optional[bool] = Field(None, alias="AllowAllBuyers")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    auto_apply: bool = Field(False, alias="AutoApply")
+    active: bool = Field(True, alias="Active")
+    use_integration: Optional[bool] = Field(None, alias="UseIntegration")
+    priority: Optional[int] = Field(None, alias="Priority")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class EligiblePromotion(OrderCloudModel, Generic[XP]):
+    """An OrderCloud EligiblePromotion.
+
+    Attributes:
+        amount:  (read-only)
+        id:
+        line_item_level: If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level.
+        code: Must be unique. Entered by buyer when adding promo to order.
+        name:
+        redemption_limit: Limit the total number of orders this promotion can be applied to across all users.
+        redemption_limit_per_user: Limit the total number of orders this promotion can be applied to per user.
+        redemption_count: The number of times this promotion has been applied to an order. (read-only)
+        quantity_limit_per_order: Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_limit_per_order: Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_sort_by: Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.
+        description:
+        fine_print: For reference only. Terms, conditions, and other legal jargon.
+        start_date:
+        expiration_date:
+        eligible_expression: The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.
+        value_expression: The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.
+        can_combine: If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined.
+        allow_all_buyers: Allow promo to be used by all buyers without creating explicit assignments.
+        owner_id: ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create.
+        auto_apply:
+        active:
+        use_integration:
+        priority: Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint.
+        xp:
+    """
+
+    amount: float = Field(0.0, alias="Amount")
+    id: Optional[str] = Field(None, alias="ID")
+    line_item_level: Optional[bool] = Field(None, alias="LineItemLevel")
+    code: Optional[str] = Field(None, alias="Code")
+    name: Optional[str] = Field(None, alias="Name")
+    redemption_limit: Optional[int] = Field(None, alias="RedemptionLimit")
+    redemption_limit_per_user: Optional[int] = Field(None, alias="RedemptionLimitPerUser")
+    redemption_count: int = Field(0, alias="RedemptionCount")
+    quantity_limit_per_order: Optional[int] = Field(None, alias="QuantityLimitPerOrder")
+    item_limit_per_order: Optional[int] = Field(None, alias="ItemLimitPerOrder")
+    item_sort_by: Optional[str] = Field(None, alias="ItemSortBy")
+    description: Optional[str] = Field(None, alias="Description")
+    fine_print: Optional[str] = Field(None, alias="FinePrint")
+    start_date: Optional[str] = Field(None, alias="StartDate")
+    expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
+    eligible_expression: Optional[str] = Field(None, alias="EligibleExpression")
+    value_expression: Optional[str] = Field(None, alias="ValueExpression")
+    can_combine: Optional[bool] = Field(None, alias="CanCombine")
+    allow_all_buyers: Optional[bool] = Field(None, alias="AllowAllBuyers")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    auto_apply: bool = Field(False, alias="AutoApply")
+    active: bool = Field(True, alias="Active")
+    use_integration: Optional[bool] = Field(None, alias="UseIntegration")
+    priority: Optional[int] = Field(None, alias="Priority")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class RefreshPromosResponse(OrderCloudModel):
+    """An OrderCloud RefreshPromosResponse.
+
+    Attributes:
+        promos_added: Promotions that were auto-applied.
+        promos_removed: Promotions that were removed due to ineligibility or other reasons.
+    """
+
+    promos_added: Optional[list[AddedPromo]] = Field(None, alias="PromosAdded")
+    promos_removed: Optional[list[RemovedPromo]] = Field(None, alias="PromosRemoved")
+
+
+class Promotion(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Promotion.
+
+    Attributes:
+        id:
+        line_item_level: If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level.
+        code: Must be unique. Entered by buyer when adding promo to order.
+        name:
+        redemption_limit: Limit the total number of orders this promotion can be applied to across all users.
+        redemption_limit_per_user: Limit the total number of orders this promotion can be applied to per user.
+        redemption_count: The number of times this promotion has been applied to an order. (read-only)
+        quantity_limit_per_order: Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_limit_per_order: Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_sort_by: Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.
+        description:
+        fine_print: For reference only. Terms, conditions, and other legal jargon.
+        start_date:
+        expiration_date:
+        eligible_expression: The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.
+        value_expression: The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.
+        can_combine: If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined.
+        allow_all_buyers: Allow promo to be used by all buyers without creating explicit assignments.
+        owner_id: ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create.
+        auto_apply:
+        active:
+        use_integration:
+        priority: Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint.
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    line_item_level: Optional[bool] = Field(None, alias="LineItemLevel")
+    code: Optional[str] = Field(None, alias="Code")
+    name: Optional[str] = Field(None, alias="Name")
+    redemption_limit: Optional[int] = Field(None, alias="RedemptionLimit")
+    redemption_limit_per_user: Optional[int] = Field(None, alias="RedemptionLimitPerUser")
+    redemption_count: int = Field(0, alias="RedemptionCount")
+    quantity_limit_per_order: Optional[int] = Field(None, alias="QuantityLimitPerOrder")
+    item_limit_per_order: Optional[int] = Field(None, alias="ItemLimitPerOrder")
+    item_sort_by: Optional[str] = Field(None, alias="ItemSortBy")
+    description: Optional[str] = Field(None, alias="Description")
+    fine_print: Optional[str] = Field(None, alias="FinePrint")
+    start_date: Optional[str] = Field(None, alias="StartDate")
+    expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
+    eligible_expression: Optional[str] = Field(None, alias="EligibleExpression")
+    value_expression: Optional[str] = Field(None, alias="ValueExpression")
+    can_combine: Optional[bool] = Field(None, alias="CanCombine")
+    allow_all_buyers: Optional[bool] = Field(None, alias="AllowAllBuyers")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    auto_apply: bool = Field(False, alias="AutoApply")
+    active: bool = Field(True, alias="Active")
+    use_integration: Optional[bool] = Field(None, alias="UseIntegration")
+    priority: Optional[int] = Field(None, alias="Priority")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/security.py

@@ -0,0 +1,89 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud PasswordConfig, ImpersonationConfig, SecurityProfile models."""
+
+from __future__ import annotations
+from typing import Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel
+from .misc import ApiRole
+
+__all__ = ["PasswordConfig", "ImpersonationConfig", "SecurityProfile"]
+
+
+class PasswordConfig(OrderCloudModel):
+    """An OrderCloud PasswordConfig.
+
+    Attributes:
+        limit_password_reuse: The number of passwords, including the current password, that are blocked from reuse. For example, if set to 1, any password except the current one can be reused.
+        max_consecutive_dupe_chars: The maximum number of consecutive repeating characters in a password.
+        maximum_password_age: The password expires after MaximumPasswordAge in days.
+        minimum_password_age: The password may not be changed again until this number of minutes has passed.
+        allowed_failed_attempts: The number of failed attempts before the account is locked for the LockoutDuration.
+        lockout_duration: The number of minutes an account is locked when the AllowedFailedAttempts is reached. Use 0 to indicate that lockout should be indefinite, requiring the manual intervention by an admin user.
+        upper_case_required: At least one upper case character is required.
+        lower_case_required: At least one lower case character is required.
+        special_character_required: At least one special character is required.
+        numeric_required: At least one number is required.
+        minimum_character_count: The minimum length of a password.
+    """
+
+    limit_password_reuse: Optional[int] = Field(None, alias="LimitPasswordReuse")
+    max_consecutive_dupe_chars: Optional[int] = Field(None, alias="MaxConsecutiveDupeChars")
+    maximum_password_age: Optional[int] = Field(None, alias="MaximumPasswordAge")
+    minimum_password_age: Optional[int] = Field(None, alias="MinimumPasswordAge")
+    allowed_failed_attempts: Optional[int] = Field(None, alias="AllowedFailedAttempts")
+    lockout_duration: Optional[int] = Field(None, alias="LockoutDuration")
+    upper_case_required: Optional[bool] = Field(None, alias="UpperCaseRequired")
+    lower_case_required: Optional[bool] = Field(None, alias="LowerCaseRequired")
+    special_character_required: Optional[bool] = Field(None, alias="SpecialCharacterRequired")
+    numeric_required: Optional[bool] = Field(None, alias="NumericRequired")
+    minimum_character_count: Optional[int] = Field(None, alias="MinimumCharacterCount")
+
+
+class ImpersonationConfig(OrderCloudModel):
+    """An OrderCloud ImpersonationConfig.
+
+    Attributes:
+        id:
+        impersonation_buyer_id: The BuyerID of the impersonator group or user (party doing the impersonating)
+        impersonation_group_id: The UserGroupID of the impersonator (party doing the impersonating)
+        impersonation_user_id: The UserID of the impersonator (party doing the impersonating)
+        buyer_id: The BuyerID of the impersonatee (party being impersonated). If null, the config can be used to impersonate users in any buyer in the marketplace that is able to access the specified API Client.
+        group_id: The UserGroupID of the impersonatee (party being impersonated)
+        user_id: The UserID of the impersonatee (party being impersonated)
+        security_profile_id:
+        client_id:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    impersonation_buyer_id: Optional[str] = Field(None, alias="ImpersonationBuyerID")
+    impersonation_group_id: Optional[str] = Field(None, alias="ImpersonationGroupID")
+    impersonation_user_id: Optional[str] = Field(None, alias="ImpersonationUserID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    group_id: Optional[str] = Field(None, alias="GroupID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+    security_profile_id: Optional[str] = Field(None, alias="SecurityProfileID")
+    client_id: Optional[str] = Field(None, alias="ClientID")
+
+
+class SecurityProfile(OrderCloudModel):
+    """An OrderCloud SecurityProfile.
+
+    Attributes:
+        id:
+        name:
+        roles:
+        custom_roles:
+        password_config:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    roles: Optional[list[ApiRole]] = Field(None, alias="Roles")
+    custom_roles: Optional[list[str]] = Field(None, alias="CustomRoles")
+    password_config: Optional[_PasswordConfig] = Field(None, alias="PasswordConfig")
+
+
+_PasswordConfig = PasswordConfig

ordercloud/models/shared.py

@@ -0,0 +1,131 @@
+"""Shared base classes and pagination types for OrderCloud models.
+
+Generated models use snake_case field names with ``Field(alias="PascalCase")``
+so that Python-side access is idiomatic (e.g. ``product.name``,
+``page.meta.total_count``) while JSON serialisation still uses PascalCase
+to match the OrderCloud API.
+"""
+
+from enum import Enum
+from typing import Any, Generic, Optional, TypeVar
+
+from pydantic import BaseModel, ConfigDict, Field
+
+T = TypeVar("T")
+XP = TypeVar("XP")
+
+__all__ = [
+    "OrderCloudModel",
+    "OrderCloudEnum",
+    "XP",
+    "Meta",
+    "ListFacetValue",
+    "ListFacet",
+    "MetaWithFacets",
+    "ListPage",
+]
+
+
+class OrderCloudEnum(str, Enum):
+    """Base for all OrderCloud string enums.
+
+    Overrides ``__str__`` and ``__format__`` to return the raw value,
+    ensuring consistent behaviour in f-strings across Python 3.10-3.13.
+    (Python 3.11 changed ``Enum.__format__`` to include the class name.)
+    """
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+    def __format__(self, format_spec: str) -> str:
+        return str(self.value).__format__(format_spec)
+
+
+class OrderCloudModel(BaseModel):
+    """Base model for all OrderCloud API resources.
+
+    Configured with ``populate_by_name=True`` so fields can be set by
+    either their Python name or JSON alias, and ``extra="allow"`` so
+    that unrecognised fields from the API (e.g. new additions) are
+    preserved rather than dropped.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+
+class Meta(BaseModel):
+    """Pagination metadata returned with list responses.
+
+    Attributes:
+        page: Current 1-based page number.
+        page_size: Number of items per page.
+        total_count: Total number of items matching the query.
+        total_pages: Total number of pages.
+        item_range: Two-element list ``[first, last]`` item indices on this page.
+        next_page_key: Opaque key for cursor-based pagination (if available).
+    """
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    page: int = Field(0, alias="Page")
+    page_size: int = Field(0, alias="PageSize")
+    total_count: int = Field(0, alias="TotalCount")
+    total_pages: int = Field(0, alias="TotalPages")
+    item_range: list[int] = Field(default_factory=list, alias="ItemRange")
+    next_page_key: Optional[str] = Field(None, alias="NextPageKey")
+
+
+class ListFacetValue(BaseModel):
+    """A single value within a search facet.
+
+    Attributes:
+        value: The facet value string.
+        count: Number of items matching this facet value.
+    """
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    value: str = Field("", alias="Value")
+    count: int = Field(0, alias="Count")
+
+
+class ListFacet(BaseModel):
+    """A search facet returned with product list responses.
+
+    Attributes:
+        name: The facet field name.
+        xp_path: The extended property path for this facet.
+        values: The individual facet values and their counts.
+        xp: Extended properties (arbitrary custom data).
+    """
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    name: str = Field("", alias="Name")
+    xp_path: str = Field("", alias="XpPath")
+    values: list[ListFacetValue] = Field(default_factory=list, alias="Values")
+    xp: Optional[dict[str, Any]] = Field(None, alias="xp")
+
+
+class MetaWithFacets(Meta):
+    """Pagination metadata with search facets (used by product search).
+
+    Attributes:
+        facets: Search facets with value counts for refinement.
+    """
+
+    facets: list[ListFacet] = Field(default_factory=list, alias="Facets")
+
+
+class ListPage(BaseModel, Generic[T]):
+    """A paginated list of items returned by the OrderCloud API.
+
+    Attributes:
+        items: The items on this page.
+        meta: Pagination metadata.
+    """
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    items: list[T] = Field(default_factory=list, alias="Items")
+    meta: Meta = Field(default_factory=Meta, alias="Meta")

ordercloud/models/shipment.py

@@ -0,0 +1,150 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud ShipMethod and related 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__ = [
+    "ShipMethod",
+    "ShipEstimateItem",
+    "ShipEstimate",
+    "ShipEstimateResponse",
+    "ShipmentItem",
+    "Shipment",
+]
+
+
+class ShipMethod(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ShipMethod.
+
+    Attributes:
+        id:
+        name:
+        cost:
+        estimated_transit_days:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    cost: Optional[float] = Field(None, alias="Cost")
+    estimated_transit_days: Optional[int] = Field(None, alias="EstimatedTransitDays")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class ShipEstimateItem(OrderCloudModel):
+    """An OrderCloud ShipEstimateItem.
+
+    Attributes:
+        line_item_id:
+        quantity:
+    """
+
+    line_item_id: Optional[str] = Field(None, alias="LineItemID")
+    quantity: Optional[int] = Field(None, alias="Quantity")
+
+
+class ShipEstimate(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ShipEstimate.
+
+    Attributes:
+        id:
+        xp:
+        selected_ship_method_id:
+        ship_estimate_items:
+        ship_methods:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    xp: Optional[XP] = Field(None, alias="xp")
+    selected_ship_method_id: Optional[str] = Field(None, alias="SelectedShipMethodID")
+    ship_estimate_items: Optional[list[ShipEstimateItem]] = Field(None, alias="ShipEstimateItems")
+    ship_methods: Optional[list[ShipMethod]] = Field(None, alias="ShipMethods")
+
+
+class ShipEstimateResponse(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ShipEstimateResponse.
+
+    Attributes:
+        ship_estimates:
+        http_status_code:
+        unhandled_error_body:
+        xp:
+        succeeded:
+    """
+
+    ship_estimates: Optional[list[ShipEstimate]] = Field(None, alias="ShipEstimates")
+    http_status_code: Optional[int] = Field(None, alias="HttpStatusCode")
+    unhandled_error_body: Optional[str] = Field(None, alias="UnhandledErrorBody")
+    xp: Optional[XP] = Field(None, alias="xp")
+    succeeded: Optional[bool] = Field(None, alias="Succeeded")
+
+
+class ShipmentItem(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ShipmentItem.
+
+    Attributes:
+        order_id:
+        line_item_id:
+        quantity_shipped:
+        unit_price:  (read-only)
+        cost_center:  (read-only)
+        date_needed:  (read-only)
+        product:  (read-only)
+        variant:  (read-only)
+        specs:  (read-only)
+        xp: For reference only, represents line item XP from the given line item ID (read-only)
+    """
+
+    order_id: Optional[str] = Field(None, alias="OrderID")
+    line_item_id: Optional[str] = Field(None, alias="LineItemID")
+    quantity_shipped: Optional[int] = Field(None, alias="QuantityShipped")
+    unit_price: float = Field(0.0, alias="UnitPrice")
+    cost_center: Optional[str] = Field(None, alias="CostCenter")
+    date_needed: Optional[str] = Field(None, alias="DateNeeded")
+    product: Optional[LineItemProduct] = Field(None, alias="Product")
+    variant: Optional[LineItemVariant] = Field(None, alias="Variant")
+    specs: Optional[list[LineItemSpec]] = Field(None, alias="Specs")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class Shipment(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Shipment.
+
+    Attributes:
+        id:
+        buyer_id:
+        shipper: For reference only, does not influence any OrderCloud behavior.
+        date_shipped: In order to properly trigger OrderShipped emails, this date must be NULL on initial create. Update with the date only when all of the Shipment items have been created. Once all of an order's items exist on a shipment that has a DateShipped populated the OrderShipped message sender will trigger and Order.Status will be updated to Complete.
+        date_delivered:
+        tracking_number:
+        cost: For reference only, does not influence any OrderCloud behavior.
+        owner_id: ID of the organization that owns the shipment. Only the marketplace owner can override the OwnerID on create.
+        xp:
+        account:
+        from_address_id: Marketplace owner or supplier AddressID where the product will be shipped from.
+        to_address_id:
+        from_address:  (read-only)
+        to_address:  (read-only)
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    shipper: Optional[str] = Field(None, alias="Shipper")
+    date_shipped: Optional[str] = Field(None, alias="DateShipped")
+    date_delivered: Optional[str] = Field(None, alias="DateDelivered")
+    tracking_number: Optional[str] = Field(None, alias="TrackingNumber")
+    cost: Optional[float] = Field(None, alias="Cost")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    xp: Optional[XP] = Field(None, alias="xp")
+    account: Optional[str] = Field(None, alias="Account")
+    from_address_id: Optional[str] = Field(None, alias="FromAddressID")
+    to_address_id: Optional[str] = Field(None, alias="ToAddressID")
+    from_address: Optional[Address] = Field(None, alias="FromAddress")
+    to_address: Optional[Address] = Field(None, alias="ToAddress")