ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/assignments.py

@@ -0,0 +1,402 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud AddressAssignment and related models."""
+
+from __future__ import annotations
+from typing import Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel
+from .message_sender import MessageType
+
+__all__ = [
+    "AddressAssignment",
+    "ApiClientAssignment",
+    "BundleAssignment",
+    "BundleCatalogAssignment",
+    "BundleProductAssignment",
+    "CatalogAssignment",
+    "CategoryAssignment",
+    "CategoryBundleAssignment",
+    "CategoryProductAssignment",
+    "CostCenterAssignment",
+    "CreditCardAssignment",
+    "DiscountAssignment",
+    "InventoryRecordAssignment",
+    "LocaleAssignment",
+    "MessageCCListenerAssignment",
+    "MessageSenderAssignment",
+    "ProductAssignment",
+    "ProductCatalogAssignment",
+    "PromotionAssignment",
+    "SecurityProfileAssignment",
+    "SpecProductAssignment",
+    "SpendingAccountAssignment",
+    "UserGroupAssignment",
+]
+_MessageType = MessageType
+
+
+class AddressAssignment(OrderCloudModel):
+    """An OrderCloud AddressAssignment.
+
+    Attributes:
+        address_id:
+        user_id:
+        user_group_id:
+        is_shipping:
+        is_billing:
+    """
+
+    address_id: Optional[str] = Field(None, alias="AddressID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+    is_shipping: Optional[bool] = Field(None, alias="IsShipping")
+    is_billing: Optional[bool] = Field(None, alias="IsBilling")
+
+
+class ApiClientAssignment(OrderCloudModel):
+    """An OrderCloud ApiClientAssignment.
+
+    Attributes:
+        api_client_id:
+        buyer_id:
+        supplier_id:
+    """
+
+    api_client_id: Optional[str] = Field(None, alias="ApiClientID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+
+
+class BundleAssignment(OrderCloudModel):
+    """An OrderCloud BundleAssignment.
+
+    Attributes:
+        seller_id: Marketplace owner can write to this property when creating bundle assignments for other sellers.
+        bundle_id:
+        buyer_id:
+        user_group_id:
+    """
+
+    seller_id: Optional[str] = Field(None, alias="SellerID")
+    bundle_id: Optional[str] = Field(None, alias="BundleID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class BundleCatalogAssignment(OrderCloudModel):
+    """An OrderCloud BundleCatalogAssignment.
+
+    Attributes:
+        catalog_id:
+        bundle_id:
+    """
+
+    catalog_id: Optional[str] = Field(None, alias="CatalogID")
+    bundle_id: Optional[str] = Field(None, alias="BundleID")
+
+
+class BundleProductAssignment(OrderCloudModel):
+    """An OrderCloud BundleProductAssignment.
+
+    Attributes:
+        product_id:
+        bundle_id:
+        required:
+        default_quantity:
+    """
+
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    bundle_id: Optional[str] = Field(None, alias="BundleID")
+    required: Optional[bool] = Field(None, alias="Required")
+    default_quantity: Optional[int] = Field(None, alias="DefaultQuantity")
+
+
+class CatalogAssignment(OrderCloudModel):
+    """An OrderCloud CatalogAssignment.
+
+    Attributes:
+        catalog_id:
+        buyer_id:
+        buyer_group_id:
+        view_all_categories:
+        view_all_products:
+    """
+
+    catalog_id: Optional[str] = Field(None, alias="CatalogID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    buyer_group_id: Optional[str] = Field(None, alias="BuyerGroupID")
+    view_all_categories: Optional[bool] = Field(None, alias="ViewAllCategories")
+    view_all_products: Optional[bool] = Field(None, alias="ViewAllProducts")
+
+
+class CategoryAssignment(OrderCloudModel):
+    """An OrderCloud CategoryAssignment.
+
+    Attributes:
+        category_id:
+        buyer_id:
+        user_group_id:
+        visible: Set to null to inherit from parent category or catalog level.
+        view_all_products: Set to null to inherit from parent category or catalog level.
+    """
+
+    category_id: Optional[str] = Field(None, alias="CategoryID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+    visible: Optional[bool] = Field(None, alias="Visible")
+    view_all_products: Optional[bool] = Field(None, alias="ViewAllProducts")
+
+
+class CategoryBundleAssignment(OrderCloudModel):
+    """An OrderCloud CategoryBundleAssignment.
+
+    Attributes:
+        category_id:
+        bundle_id:
+        list_order:
+    """
+
+    category_id: Optional[str] = Field(None, alias="CategoryID")
+    bundle_id: Optional[str] = Field(None, alias="BundleID")
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+
+
+class CategoryProductAssignment(OrderCloudModel):
+    """An OrderCloud CategoryProductAssignment.
+
+    Attributes:
+        category_id:
+        product_id:
+        list_order:
+    """
+
+    category_id: Optional[str] = Field(None, alias="CategoryID")
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+
+
+class CostCenterAssignment(OrderCloudModel):
+    """An OrderCloud CostCenterAssignment.
+
+    Attributes:
+        cost_center_id:
+        user_group_id:
+    """
+
+    cost_center_id: Optional[str] = Field(None, alias="CostCenterID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class CreditCardAssignment(OrderCloudModel):
+    """An OrderCloud CreditCardAssignment.
+
+    Attributes:
+        credit_card_id:
+        user_id:
+        user_group_id:
+    """
+
+    credit_card_id: Optional[str] = Field(None, alias="CreditCardID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class DiscountAssignment(OrderCloudModel):
+    """An OrderCloud DiscountAssignment.
+
+    Attributes:
+        discount_id:
+        buyer_group_id: When specified, BuyerID and UserGroupID must be null.
+        buyer_id: Required when BuyerGroupID is null.
+        user_group_id: Optional. Only valid when BuyerID is specified.
+    """
+
+    discount_id: Optional[str] = Field(None, alias="DiscountID")
+    buyer_group_id: Optional[str] = Field(None, alias="BuyerGroupID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class InventoryRecordAssignment(OrderCloudModel):
+    """An OrderCloud InventoryRecordAssignment.
+
+    Attributes:
+        inventory_record_id:
+        buyer_id:
+        user_group_id:
+    """
+
+    inventory_record_id: Optional[str] = Field(None, alias="InventoryRecordID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class LocaleAssignment(OrderCloudModel):
+    """An OrderCloud LocaleAssignment.
+
+    Attributes:
+        locale_id:
+        buyer_id:
+        user_group_id:
+    """
+
+    locale_id: Optional[str] = Field(None, alias="LocaleID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class MessageCCListenerAssignment(OrderCloudModel):
+    """An OrderCloud MessageCCListenerAssignment.
+
+    Attributes:
+        message_sender_assignment:
+        message_config_name:  (read-only)
+        message_config_description:  (read-only)
+        message_type:
+        buyer_id:
+        supplier_id:
+        user_group_id:
+        user_id:
+    """
+
+    message_sender_assignment: Optional[_MessageSenderAssignment] = Field(
+        None, alias="MessageSenderAssignment"
+    )
+    message_config_name: Optional[str] = Field(None, alias="MessageConfigName")
+    message_config_description: Optional[str] = Field(None, alias="MessageConfigDescription")
+    message_type: Optional[_MessageType] = Field(None, alias="MessageType")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+
+
+class MessageSenderAssignment(OrderCloudModel):
+    """An OrderCloud MessageSenderAssignment.
+
+    Attributes:
+        message_sender_id:
+        buyer_id:
+        supplier_id:
+        user_group_id:
+        message_config_name:  (read-only)
+        message_config_description:  (read-only)
+    """
+
+    message_sender_id: Optional[str] = Field(None, alias="MessageSenderID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+    message_config_name: Optional[str] = Field(None, alias="MessageConfigName")
+    message_config_description: Optional[str] = Field(None, alias="MessageConfigDescription")
+
+
+class ProductAssignment(OrderCloudModel):
+    """An OrderCloud ProductAssignment.
+
+    Attributes:
+        seller_id: Only the marketplace owner can override the SellerID on create. A price schedule owned by the supplier is required in order to write to this property.
+        product_id:
+        buyer_id:
+        user_group_id:
+        price_schedule_id:
+    """
+
+    seller_id: Optional[str] = Field(None, alias="SellerID")
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+    price_schedule_id: Optional[str] = Field(None, alias="PriceScheduleID")
+
+
+class ProductCatalogAssignment(OrderCloudModel):
+    """An OrderCloud ProductCatalogAssignment.
+
+    Attributes:
+        catalog_id:
+        product_id:
+    """
+
+    catalog_id: Optional[str] = Field(None, alias="CatalogID")
+    product_id: Optional[str] = Field(None, alias="ProductID")
+
+
+class PromotionAssignment(OrderCloudModel):
+    """An OrderCloud PromotionAssignment.
+
+    Attributes:
+        promotion_id:
+        buyer_id:
+        user_group_id:
+    """
+
+    promotion_id: Optional[str] = Field(None, alias="PromotionID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class SecurityProfileAssignment(OrderCloudModel):
+    """An OrderCloud SecurityProfileAssignment.
+
+    Attributes:
+        security_profile_id:
+        buyer_id:
+        supplier_id:
+        user_id:
+        user_group_id:
+    """
+
+    security_profile_id: Optional[str] = Field(None, alias="SecurityProfileID")
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class SpecProductAssignment(OrderCloudModel):
+    """An OrderCloud SpecProductAssignment.
+
+    Attributes:
+        spec_id:
+        product_id:
+        default_value: When defined, overrides the DefaultValue set on the spec for this product only.
+        default_option_id: When defined, overrides the DefaultOptionID set on the spec for this product only.
+    """
+
+    spec_id: Optional[str] = Field(None, alias="SpecID")
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    default_value: Optional[str] = Field(None, alias="DefaultValue")
+    default_option_id: Optional[str] = Field(None, alias="DefaultOptionID")
+
+
+class SpendingAccountAssignment(OrderCloudModel):
+    """An OrderCloud SpendingAccountAssignment.
+
+    Attributes:
+        spending_account_id:
+        user_id:
+        user_group_id:
+        allow_exceed: If true, a user can place an order for an amount greater than the available balance, causing the balance to go negative.
+    """
+
+    spending_account_id: Optional[str] = Field(None, alias="SpendingAccountID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+    allow_exceed: Optional[bool] = Field(None, alias="AllowExceed")
+
+
+class UserGroupAssignment(OrderCloudModel):
+    """An OrderCloud UserGroupAssignment.
+
+    Attributes:
+        user_group_id:
+        user_id:
+    """
+
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+
+
+_MessageSenderAssignment = MessageSenderAssignment

ordercloud/models/auth_models.py

@@ -0,0 +1,114 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud AccessToken and related models."""
+
+from __future__ import annotations
+from typing import Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel
+from .misc import ApiRole
+
+__all__ = [
+    "AccessToken",
+    "AccessTokenBasic",
+    "ImpersonateTokenRequest",
+    "OneTimePasswordRequest",
+    "PasswordReset",
+    "PasswordResetRequest",
+    "TokenPasswordReset",
+]
+
+
+class AccessToken(OrderCloudModel):
+    """An OrderCloud AccessToken.
+
+    Attributes:
+        access_token:
+        expires_in:
+        token_type:
+        refresh_token:
+    """
+
+    access_token: Optional[str] = Field(None, alias="access_token")
+    expires_in: Optional[int] = Field(None, alias="expires_in")
+    token_type: Optional[str] = Field(None, alias="token_type")
+    refresh_token: Optional[str] = Field(None, alias="refresh_token")
+
+
+class AccessTokenBasic(OrderCloudModel):
+    """An OrderCloud AccessTokenBasic.
+
+    Attributes:
+        access_token:
+    """
+
+    access_token: Optional[str] = Field(None, alias="access_token")
+
+
+class ImpersonateTokenRequest(OrderCloudModel):
+    """An OrderCloud ImpersonateTokenRequest.
+
+    Attributes:
+        client_id:
+        roles:
+        custom_roles:
+    """
+
+    client_id: Optional[str] = Field(None, alias="ClientID")
+    roles: Optional[list[ApiRole]] = Field(None, alias="Roles")
+    custom_roles: Optional[list[str]] = Field(None, alias="CustomRoles")
+
+
+class OneTimePasswordRequest(OrderCloudModel):
+    """An OrderCloud OneTimePasswordRequest.
+
+    Attributes:
+        client_id:
+        username:
+        email:
+    """
+
+    client_id: Optional[str] = Field(None, alias="ClientID")
+    username: Optional[str] = Field(None, alias="Username")
+    email: Optional[str] = Field(None, alias="Email")
+
+
+class PasswordReset(OrderCloudModel):
+    """An OrderCloud PasswordReset.
+
+    Attributes:
+        client_id:
+        username:
+        password:
+    """
+
+    client_id: Optional[str] = Field(None, alias="ClientID")
+    username: Optional[str] = Field(None, alias="Username")
+    password: Optional[str] = Field(None, alias="Password")
+
+
+class PasswordResetRequest(OrderCloudModel):
+    """An OrderCloud PasswordResetRequest.
+
+    Attributes:
+        client_id:
+        email:
+        username:
+        url:
+    """
+
+    client_id: Optional[str] = Field(None, alias="ClientID")
+    email: Optional[str] = Field(None, alias="Email")
+    username: Optional[str] = Field(None, alias="Username")
+    url: Optional[str] = Field(None, alias="URL")
+
+
+class TokenPasswordReset(OrderCloudModel):
+    """An OrderCloud TokenPasswordReset.
+
+    Attributes:
+        new_password:
+    """
+
+    new_password: Optional[str] = Field(None, alias="NewPassword")

ordercloud/models/bundle.py

@@ -0,0 +1,31 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Bundle models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+
+__all__ = ["Bundle"]
+
+
+class Bundle(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Bundle.
+
+    Attributes:
+        id:
+        owner_id: ID of the organization that owns the bundle. Only the ma marketplace owner can override the OwnerID on create.
+        name:
+        description:
+        active: If false, bundle is not visible or purchasable from a buyer's perspective.
+        xp: Consider keeping bundle and product xp schemas consistent. Defining conflicting xp types will result in indexing problems.
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    active: Optional[bool] = Field(None, alias="Active")
+    xp: Optional[XP] = Field(None, alias="xp")