ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/spec.py

@@ -0,0 +1,67 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud SpecOption, Spec 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__ = ["SpecOption", "Spec"]
+_PriceMarkupType = PriceMarkupType
+
+
+class SpecOption(OrderCloudModel, Generic[XP]):
+    """An OrderCloud SpecOption.
+
+    Attributes:
+        id:
+        value:
+        list_order:
+        is_open_text:
+        price_markup_type: Used to change the price of a product when a specific spec option is selected.
+        price_markup:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    value: Optional[str] = Field(None, alias="Value")
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+    is_open_text: Optional[bool] = Field(None, alias="IsOpenText")
+    price_markup_type: Optional[_PriceMarkupType] = Field(None, alias="PriceMarkupType")
+    price_markup: Optional[float] = Field(None, alias="PriceMarkup")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class Spec(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Spec.
+
+    Attributes:
+        owner_id: ID of the organization that owns the spec. Only the marketplace owner can override the OwnerID on create.
+        id:
+        list_order:
+        name:
+        default_value: If no value is passed in the line item spec, this value will be used.
+        required:
+        allow_open_text: For spec options that are not pre-defined, such as FirstName for a business card.
+        default_option_id: This property can only be written to after both the spec and options have been created. If no Spec.OptionID is passed in the line item spec, this option will be used.
+        defines_variant: If true, each unique combinations of this spec's options should map to a unique product variant.
+        xp:
+        option_count:  (read-only)
+        options:  (read-only)
+    """
+
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    id: Optional[str] = Field(None, alias="ID")
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+    name: Optional[str] = Field(None, alias="Name")
+    default_value: Optional[str] = Field(None, alias="DefaultValue")
+    required: Optional[bool] = Field(None, alias="Required")
+    allow_open_text: Optional[bool] = Field(None, alias="AllowOpenText")
+    default_option_id: Optional[str] = Field(None, alias="DefaultOptionID")
+    defines_variant: Optional[bool] = Field(None, alias="DefinesVariant")
+    xp: Optional[XP] = Field(None, alias="xp")
+    option_count: int = Field(0, alias="OptionCount")
+    options: Optional[list[SpecOption]] = Field(None, alias="Options")

ordercloud/models/spending_account.py

@@ -0,0 +1,33 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud SpendingAccount models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+
+__all__ = ["SpendingAccount"]
+
+
+class SpendingAccount(OrderCloudModel, Generic[XP]):
+    """An OrderCloud SpendingAccount.
+
+    Attributes:
+        id:
+        name:
+        balance:
+        allow_as_payment_method: If true, a payment can be created referencing the SpendingAccountID.
+        start_date:
+        end_date:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    balance: Optional[float] = Field(None, alias="Balance")
+    allow_as_payment_method: Optional[bool] = Field(None, alias="AllowAsPaymentMethod")
+    start_date: Optional[str] = Field(None, alias="StartDate")
+    end_date: Optional[str] = Field(None, alias="EndDate")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/subscription.py

@@ -0,0 +1,125 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud SubscriptionInterval and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel, XP
+from .misc import ApiRole
+from .payment import PaymentType
+
+__all__ = [
+    "SubscriptionInterval",
+    "SubscriptionPayment",
+    "SubscriptionIntegration",
+    "SubscriptionIntegrationResponse",
+    "Subscription",
+]
+
+
+class SubscriptionInterval(OrderCloudEnum):
+    """"""
+
+    Days = "Days"
+    Weeks = "Weeks"
+    Months = "Months"
+
+
+class SubscriptionPayment(OrderCloudModel):
+    """An OrderCloud SubscriptionPayment.
+
+    Attributes:
+        type:
+        credit_card_id:
+        spending_account_id:
+    """
+
+    type: Optional[PaymentType] = Field(None, alias="Type")
+    credit_card_id: Optional[str] = Field(None, alias="CreditCardID")
+    spending_account_id: Optional[str] = Field(None, alias="SpendingAccountID")
+
+
+class SubscriptionIntegration(OrderCloudModel, Generic[XP]):
+    """An OrderCloud SubscriptionIntegration.
+
+    Attributes:
+        api_client_id: ID of the API client that will be used to generate the token passed to your hosted application via subscription integration.
+        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:
+        active:
+        notification_days:
+        url:
+        xp:
+        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.
+    """
+
+    api_client_id: Optional[str] = Field(None, alias="ApiClientID")
+    hash_key: Optional[str] = Field(None, alias="HashKey")
+    elevated_roles: Optional[list[ApiRole]] = Field(None, alias="ElevatedRoles")
+    active: Optional[bool] = Field(None, alias="Active")
+    notification_days: Optional[int] = Field(None, alias="NotificationDays")
+    url: Optional[str] = Field(None, alias="Url")
+    xp: Optional[XP] = Field(None, alias="xp")
+    custom_auth_header_name: Optional[str] = Field(None, alias="CustomAuthHeaderName")
+    custom_auth_header_value: Optional[str] = Field(None, alias="CustomAuthHeaderValue")
+
+
+class SubscriptionIntegrationResponse(OrderCloudModel, Generic[XP]):
+    """An OrderCloud SubscriptionIntegrationResponse.
+
+    Attributes:
+        http_status_code:
+        unhandled_error_body:
+        xp:
+        succeeded:
+    """
+
+    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 Subscription(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Subscription.
+
+    Attributes:
+        id:
+        frequency: Used to define how often to process the subscription. The subscription will process once every {Frequency} {Interval}.
+        interval: Used to define how often to process the subscription. The subscription will process once every {Frequency} {Interval}.
+        next_order_date: Next order date of the subscription. The hourly process that creates subscription orders will query for subscriptions with a NextOrderDate between now and five hours ago.
+        last_order_date:  (read-only)
+        notification_date: Date that subscription order reminder message sender will be triggered if used. Value is the result of NextOrderDate less NotificationDays on the subscription integration. (read-only)
+        date_created:  (read-only)
+        end_date:
+        active:
+        from_company_id: Only use when creating a subscription on behalf of another user. ID of the buyer or marketplace owner placing the order.
+        from_user_id: Only use when creating a subscription on behalf of a another user.
+        to_company_id: ID of the marketplace owner or supplier receiving the order created by this subscription, only writable on create.
+        payment:
+        billing_address_id:
+        shipping_address_id:
+        projected_subtotal: Tentative subtotal of next subscription order. Based on current known pricing; avoid if product or pricing is provided by an external integration. (read-only)
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    frequency: Optional[int] = Field(None, alias="Frequency")
+    interval: Optional[SubscriptionInterval] = Field(None, alias="Interval")
+    next_order_date: Optional[str] = Field(None, alias="NextOrderDate")
+    last_order_date: Optional[str] = Field(None, alias="LastOrderDate")
+    notification_date: Optional[str] = Field(None, alias="NotificationDate")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    end_date: Optional[str] = Field(None, alias="EndDate")
+    active: bool = Field(True, alias="Active")
+    from_company_id: Optional[str] = Field(None, alias="FromCompanyID")
+    from_user_id: Optional[str] = Field(None, alias="FromUserID")
+    to_company_id: Optional[str] = Field(None, alias="ToCompanyID")
+    payment: Optional[SubscriptionPayment] = Field(None, alias="Payment")
+    billing_address_id: Optional[str] = Field(None, alias="BillingAddressID")
+    shipping_address_id: Optional[str] = Field(None, alias="ShippingAddressID")
+    projected_subtotal: float = Field(0.0, alias="ProjectedSubtotal")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/supplier.py

@@ -0,0 +1,43 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud SupplierBuyer, Supplier models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+
+__all__ = ["SupplierBuyer", "Supplier"]
+
+
+class SupplierBuyer(OrderCloudModel):
+    """An OrderCloud SupplierBuyer.
+
+    Attributes:
+        id:
+        name:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+
+
+class Supplier(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Supplier.
+
+    Attributes:
+        id:
+        name:
+        active: If false, all user authentication is blocked.
+        date_created:  (read-only)
+        all_buyers_can_order: If false, buyers will only be able to set ToCompanyID on an order to the marketplace owner, or suppliers they have an explicit relationship to.
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    active: Optional[bool] = Field(None, alias="Active")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    all_buyers_can_order: Optional[bool] = Field(None, alias="AllBuyersCanOrder")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/sync.py

@@ -0,0 +1,172 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud EntitySyncConfig and related models."""
+
+from __future__ import annotations
+from typing import Any, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel
+
+__all__ = [
+    "EntitySyncConfig",
+    "OrderSyncConfig",
+    "ProductSyncConfig",
+    "SyncAdminUser",
+    "SyncBuyer",
+    "SyncBuyerUser",
+    "SyncBuyerUserGroup",
+    "SyncCategory",
+    "SyncInventoryRecord",
+    "SyncProduct",
+    "SyncSupplier",
+    "SyncSupplierUser",
+]
+
+
+class EntitySyncConfig(OrderCloudModel):
+    """An OrderCloud EntitySyncConfig.
+
+    Attributes:
+        delivery_config_id:
+        sync_entity_changed:
+        sync_entity_deleted:
+        paused:
+    """
+
+    delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")
+    sync_entity_changed: Optional[bool] = Field(None, alias="SyncEntityChanged")
+    sync_entity_deleted: Optional[bool] = Field(None, alias="SyncEntityDeleted")
+    paused: Optional[bool] = Field(None, alias="Paused")
+
+
+class OrderSyncConfig(OrderCloudModel):
+    """An OrderCloud OrderSyncConfig.
+
+    Attributes:
+        delivery_config_id:
+        config_data:
+    """
+
+    delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")
+    config_data: Optional[dict[str, Any]] = Field(None, alias="ConfigData")
+
+
+class ProductSyncConfig(OrderCloudModel):
+    """An OrderCloud ProductSyncConfig.
+
+    Attributes:
+        sync_product_changed:
+        sync_product_deleted:
+        delivery_config_id:
+        config_data:
+        paused:
+        exclude_price_schedules:
+    """
+
+    sync_product_changed: Optional[bool] = Field(None, alias="SyncProductChanged")
+    sync_product_deleted: Optional[bool] = Field(None, alias="SyncProductDeleted")
+    delivery_config_id: Optional[str] = Field(None, alias="DeliveryConfigID")
+    config_data: Optional[dict[str, Any]] = Field(None, alias="ConfigData")
+    paused: Optional[bool] = Field(None, alias="Paused")
+    exclude_price_schedules: Optional[bool] = Field(None, alias="ExcludePriceSchedules")
+
+
+class SyncAdminUser(OrderCloudModel):
+    """An OrderCloud SyncAdminUser.
+
+    Attributes:
+        user_id:
+    """
+
+    user_id: Optional[str] = Field(None, alias="UserID")
+
+
+class SyncBuyer(OrderCloudModel):
+    """An OrderCloud SyncBuyer.
+
+    Attributes:
+        buyer_id:
+    """
+
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+
+
+class SyncBuyerUser(OrderCloudModel):
+    """An OrderCloud SyncBuyerUser.
+
+    Attributes:
+        buyer_id:
+        user_id:
+    """
+
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_id: Optional[str] = Field(None, alias="UserID")
+
+
+class SyncBuyerUserGroup(OrderCloudModel):
+    """An OrderCloud SyncBuyerUserGroup.
+
+    Attributes:
+        buyer_id:
+        user_group_id:
+    """
+
+    buyer_id: Optional[str] = Field(None, alias="BuyerID")
+    user_group_id: Optional[str] = Field(None, alias="UserGroupID")
+
+
+class SyncCategory(OrderCloudModel):
+    """An OrderCloud SyncCategory.
+
+    Attributes:
+        catalog_id:
+        category_id:
+    """
+
+    catalog_id: Optional[str] = Field(None, alias="CatalogID")
+    category_id: Optional[str] = Field(None, alias="CategoryID")
+
+
+class SyncInventoryRecord(OrderCloudModel):
+    """An OrderCloud SyncInventoryRecord.
+
+    Attributes:
+        product_id:
+        inventory_record_id:
+    """
+
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    inventory_record_id: Optional[str] = Field(None, alias="InventoryRecordID")
+
+
+class SyncProduct(OrderCloudModel):
+    """An OrderCloud SyncProduct.
+
+    Attributes:
+        product_id:
+    """
+
+    product_id: Optional[str] = Field(None, alias="ProductID")
+
+
+class SyncSupplier(OrderCloudModel):
+    """An OrderCloud SyncSupplier.
+
+    Attributes:
+        supplier_id:
+    """
+
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+
+
+class SyncSupplierUser(OrderCloudModel):
+    """An OrderCloud SyncSupplierUser.
+
+    Attributes:
+        supplier_id:
+        user_id:
+    """
+
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+    user_id: Optional[str] = Field(None, alias="UserID")

ordercloud/models/user.py

@@ -0,0 +1,207 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud Locale and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel, XP
+
+__all__ = [
+    "UserOrderMoveOption",
+    "Locale",
+    "MeBuyer",
+    "MeSeller",
+    "MeSupplier",
+    "OrderUser",
+    "MeUser",
+    "User",
+]
+
+
+class UserOrderMoveOption(OrderCloudEnum):
+    """"""
+
+    _None = "None"
+    Unsubmitted = "Unsubmitted"
+    All = "All"
+
+
+class Locale(OrderCloudModel):
+    """An OrderCloud Locale.
+
+    Attributes:
+        id:
+        owner_id: ID of the organization that owns the Locale. Only the marketplace owner can override the OwnerID on create.
+        currency: We recommend using ISO-4217 currency codes for compatibility with tax and payment processors.
+        language: We recommend using ISO-639 language code - ISO-3166 Country code (e.g. en-US).
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    currency: Optional[str] = Field(None, alias="Currency")
+    language: Optional[str] = Field(None, alias="Language")
+
+
+class MeBuyer(OrderCloudModel):
+    """An OrderCloud MeBuyer.
+
+    Attributes:
+        id:  (read-only)
+        default_catalog_id:  (read-only)
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    default_catalog_id: Optional[str] = Field(None, alias="DefaultCatalogID")
+
+
+class MeSeller(OrderCloudModel):
+    """An OrderCloud MeSeller.
+
+    Attributes:
+        id:  (read-only)
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+
+
+class MeSupplier(OrderCloudModel):
+    """An OrderCloud MeSupplier.
+
+    Attributes:
+        id:  (read-only)
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+
+
+class OrderUser(OrderCloudModel, Generic[XP]):
+    """An OrderCloud OrderUser.
+
+    Attributes:
+        id:
+        company_id:  (read-only)
+        username: Must be unique across all organizations.
+        password:
+        first_name:
+        last_name:
+        email:
+        phone:
+        terms_accepted:
+        active: If false, authentication is prohibited.
+        xp:
+        available_roles: List of roles currently available to the user via all security profile assignments. (read-only)
+        locale: Most specific locale assigned to the user, if any. (read-only)
+        date_created:  (read-only)
+        last_active: Accurate within a few minutes. Includes impersonation activity. (read-only)
+        password_last_set_date: Can be used in conjunction with SecurityProfile.PasswordConfig to enforce password reset schedules. (read-only)
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    company_id: Optional[str] = Field(None, alias="CompanyID")
+    username: Optional[str] = Field(None, alias="Username")
+    password: Optional[str] = Field(None, alias="Password")
+    first_name: Optional[str] = Field(None, alias="FirstName")
+    last_name: Optional[str] = Field(None, alias="LastName")
+    email: Optional[str] = Field(None, alias="Email")
+    phone: Optional[str] = Field(None, alias="Phone")
+    terms_accepted: Optional[str] = Field(None, alias="TermsAccepted")
+    active: Optional[bool] = Field(None, alias="Active")
+    xp: Optional[XP] = Field(None, alias="xp")
+    available_roles: Optional[list[str]] = Field(None, alias="AvailableRoles")
+    locale: Optional[_Locale] = Field(None, alias="Locale")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    last_active: Optional[str] = Field(None, alias="LastActive")
+    password_last_set_date: Optional[str] = Field(None, alias="PasswordLastSetDate")
+
+
+class MeUser(OrderCloudModel, Generic[XP]):
+    """An OrderCloud MeUser.
+
+    Attributes:
+        buyer:  (read-only)
+        supplier:  (read-only)
+        seller:  (read-only)
+        id:
+        company_id:  (read-only)
+        username: Must be unique across all organizations.
+        password:
+        first_name:
+        last_name:
+        email:
+        phone:
+        terms_accepted:
+        active: If false, authentication is prohibited.
+        xp:
+        available_roles: List of roles currently available to the user via all security profile assignments. (read-only)
+        locale: Most specific locale assigned to the user, if any. (read-only)
+        date_created:  (read-only)
+        last_active: Accurate within a few minutes. Includes impersonation activity. (read-only)
+        password_last_set_date: Can be used in conjunction with SecurityProfile.PasswordConfig to enforce password reset schedules. (read-only)
+    """
+
+    buyer: Optional[MeBuyer] = Field(None, alias="Buyer")
+    supplier: Optional[MeSupplier] = Field(None, alias="Supplier")
+    seller: Optional[MeSeller] = Field(None, alias="Seller")
+    id: Optional[str] = Field(None, alias="ID")
+    company_id: Optional[str] = Field(None, alias="CompanyID")
+    username: Optional[str] = Field(None, alias="Username")
+    password: Optional[str] = Field(None, alias="Password")
+    first_name: Optional[str] = Field(None, alias="FirstName")
+    last_name: Optional[str] = Field(None, alias="LastName")
+    email: Optional[str] = Field(None, alias="Email")
+    phone: Optional[str] = Field(None, alias="Phone")
+    terms_accepted: Optional[str] = Field(None, alias="TermsAccepted")
+    active: Optional[bool] = Field(None, alias="Active")
+    xp: Optional[XP] = Field(None, alias="xp")
+    available_roles: Optional[list[str]] = Field(None, alias="AvailableRoles")
+    locale: Optional[_Locale] = Field(None, alias="Locale")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    last_active: Optional[str] = Field(None, alias="LastActive")
+    password_last_set_date: Optional[str] = Field(None, alias="PasswordLastSetDate")
+
+
+class User(OrderCloudModel, Generic[XP]):
+    """An OrderCloud User.
+
+    Attributes:
+        failed_login_attempts: Number of times the user failed authentication due to incorrect password since last successful attempt, or since being unlocked. (read-only)
+        id:
+        company_id:  (read-only)
+        username: Must be unique across all organizations.
+        password:
+        first_name:
+        last_name:
+        email:
+        phone:
+        terms_accepted:
+        active: If false, authentication is prohibited.
+        xp:
+        available_roles: List of roles currently available to the user via all security profile assignments. (read-only)
+        locale: Most specific locale assigned to the user, if any. (read-only)
+        date_created:  (read-only)
+        last_active: Accurate within a few minutes. Includes impersonation activity. (read-only)
+        password_last_set_date: Can be used in conjunction with SecurityProfile.PasswordConfig to enforce password reset schedules. (read-only)
+    """
+
+    failed_login_attempts: int = Field(0, alias="FailedLoginAttempts")
+    id: Optional[str] = Field(None, alias="ID")
+    company_id: Optional[str] = Field(None, alias="CompanyID")
+    username: Optional[str] = Field(None, alias="Username")
+    password: Optional[str] = Field(None, alias="Password")
+    first_name: Optional[str] = Field(None, alias="FirstName")
+    last_name: Optional[str] = Field(None, alias="LastName")
+    email: Optional[str] = Field(None, alias="Email")
+    phone: Optional[str] = Field(None, alias="Phone")
+    terms_accepted: Optional[str] = Field(None, alias="TermsAccepted")
+    active: Optional[bool] = Field(None, alias="Active")
+    xp: Optional[XP] = Field(None, alias="xp")
+    available_roles: Optional[list[str]] = Field(None, alias="AvailableRoles")
+    locale: Optional[_Locale] = Field(None, alias="Locale")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    last_active: Optional[str] = Field(None, alias="LastActive")
+    password_last_set_date: Optional[str] = Field(None, alias="PasswordLastSetDate")
+
+
+_Locale = Locale

ordercloud/models/user_group.py

@@ -0,0 +1,27 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud UserGroup models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+
+__all__ = ["UserGroup"]
+
+
+class UserGroup(OrderCloudModel, Generic[XP]):
+    """An OrderCloud UserGroup.
+
+    Attributes:
+        id:
+        name:
+        description:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    description: Optional[str] = Field(None, alias="Description")
+    xp: Optional[XP] = Field(None, alias="xp")