ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/misc.py

@@ -0,0 +1,280 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud AccessLevel and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel, XP
+
+__all__ = [
+    "AccessLevel",
+    "ApiRole",
+    "CommerceRole",
+    "OrderDirection",
+    "OrderStatus",
+    "PartyType",
+    "SearchType",
+    "XpThingType",
+    "Incrementor",
+    "XpIndex",
+    "ProductFacet",
+    "GroupOrderInvitation",
+]
+
+
+class AccessLevel(OrderCloudEnum):
+    """"""
+
+    Private = "Private"
+    Public = "Public"
+    Shareable = "Shareable"
+
+
+class ApiRole(OrderCloudEnum):
+    """"""
+
+    ApiClientAdmin = "ApiClientAdmin"
+    ApiClientReader = "ApiClientReader"
+    AddressAdmin = "AddressAdmin"
+    AddressReader = "AddressReader"
+    AdminAddressAdmin = "AdminAddressAdmin"
+    AdminAddressReader = "AdminAddressReader"
+    AdminUserAdmin = "AdminUserAdmin"
+    AdminUserGroupAdmin = "AdminUserGroupAdmin"
+    AdminUserGroupReader = "AdminUserGroupReader"
+    AdminUserReader = "AdminUserReader"
+    ApprovalRuleAdmin = "ApprovalRuleAdmin"
+    ApprovalRuleReader = "ApprovalRuleReader"
+    BundleAdmin = "BundleAdmin"
+    BundleAssignmentAdmin = "BundleAssignmentAdmin"
+    BundleReader = "BundleReader"
+    BuyerAdmin = "BuyerAdmin"
+    BuyerImpersonation = "BuyerImpersonation"
+    BuyerReader = "BuyerReader"
+    BuyerUserAdmin = "BuyerUserAdmin"
+    BuyerUserReader = "BuyerUserReader"
+    CatalogAdmin = "CatalogAdmin"
+    CatalogReader = "CatalogReader"
+    CategoryAdmin = "CategoryAdmin"
+    CategoryReader = "CategoryReader"
+    CostCenterAdmin = "CostCenterAdmin"
+    CostCenterReader = "CostCenterReader"
+    CreditCardAdmin = "CreditCardAdmin"
+    CreditCardReader = "CreditCardReader"
+    EntitySyncConfigAdmin = "EntitySyncConfigAdmin"
+    FullAccess = "FullAccess"
+    IncrementorAdmin = "IncrementorAdmin"
+    IncrementorReader = "IncrementorReader"
+    LocaleReader = "LocaleReader"
+    LocaleAdmin = "LocaleAdmin"
+    MeAddressAdmin = "MeAddressAdmin"
+    MeAdmin = "MeAdmin"
+    MeCreditCardAdmin = "MeCreditCardAdmin"
+    MessageConfigAssignmentAdmin = "MessageConfigAssignmentAdmin"
+    MeSubscriptionAdmin = "MeSubscriptionAdmin"
+    MeXpAdmin = "MeXpAdmin"
+    OrderAdmin = "OrderAdmin"
+    OrderReader = "OrderReader"
+    OverrideShipping = "OverrideShipping"
+    OverrideTax = "OverrideTax"
+    OverrideUnitPrice = "OverrideUnitPrice"
+    PasswordReset = "PasswordReset"
+    PriceScheduleAdmin = "PriceScheduleAdmin"
+    PriceScheduleReader = "PriceScheduleReader"
+    ProductAdmin = "ProductAdmin"
+    ProductAssignmentAdmin = "ProductAssignmentAdmin"
+    ProductCollectionReader = "ProductCollectionReader"
+    ProductFacetAdmin = "ProductFacetAdmin"
+    ProductFacetReader = "ProductFacetReader"
+    ProductReader = "ProductReader"
+    ProductSyncConfigAdmin = "ProductSyncConfigAdmin"
+    PromotionAdmin = "PromotionAdmin"
+    PromotionReader = "PromotionReader"
+    SecurityProfileAdmin = "SecurityProfileAdmin"
+    SecurityProfileReader = "SecurityProfileReader"
+    SetSecurityProfile = "SetSecurityProfile"
+    ShipmentAdmin = "ShipmentAdmin"
+    ShipmentReader = "ShipmentReader"
+    Shopper = "Shopper"
+    SpendingAccountAdmin = "SpendingAccountAdmin"
+    SpendingAccountReader = "SpendingAccountReader"
+    SubscriptionAdmin = "SubscriptionAdmin"
+    SubscriptionReader = "SubscriptionReader"
+    SupplierAddressAdmin = "SupplierAddressAdmin"
+    SupplierAddressReader = "SupplierAddressReader"
+    SupplierAdmin = "SupplierAdmin"
+    SupplierReader = "SupplierReader"
+    SupplierUserAdmin = "SupplierUserAdmin"
+    SupplierUserGroupAdmin = "SupplierUserGroupAdmin"
+    SupplierUserGroupReader = "SupplierUserGroupReader"
+    SupplierUserReader = "SupplierUserReader"
+    UnsubmittedOrderReader = "UnsubmittedOrderReader"
+    UserGroupAdmin = "UserGroupAdmin"
+    UserGroupReader = "UserGroupReader"
+    OpenIDConnectReader = "OpenIDConnectReader"
+    OpenIDConnectAdmin = "OpenIDConnectAdmin"
+    MessageSenderReader = "MessageSenderReader"
+    MessageSenderAdmin = "MessageSenderAdmin"
+    XpIndexAdmin = "XpIndexAdmin"
+    WebhookReader = "WebhookReader"
+    WebhookAdmin = "WebhookAdmin"
+    IntegrationEventReader = "IntegrationEventReader"
+    IntegrationEventAdmin = "IntegrationEventAdmin"
+    TrackingEventReader = "TrackingEventReader"
+    TrackingEventAdmin = "TrackingEventAdmin"
+    DeliveryConfigAdmin = "DeliveryConfigAdmin"
+    OrderSyncConfigAdmin = "OrderSyncConfigAdmin"
+    ErrorConfigAdmin = "ErrorConfigAdmin"
+
+
+class CommerceRole(OrderCloudEnum):
+    """"""
+
+    Buyer = "Buyer"
+    Seller = "Seller"
+    Supplier = "Supplier"
+
+
+class OrderDirection(OrderCloudEnum):
+    """Direction of the order, from the current user's perspective."""
+
+    Incoming = "Incoming"
+    Outgoing = "Outgoing"
+    All = "All"
+
+
+class OrderStatus(OrderCloudEnum):
+    """"""
+
+    Unsubmitted = "Unsubmitted"
+    AwaitingApproval = "AwaitingApproval"
+    Declined = "Declined"
+    Open = "Open"
+    Completed = "Completed"
+    Canceled = "Canceled"
+
+
+class PartyType(OrderCloudEnum):
+    """"""
+
+    User = "User"
+    Group = "Group"
+    Company = "Company"
+    BuyerGroup = "BuyerGroup"
+
+
+class SearchType(OrderCloudEnum):
+    """"""
+
+    AnyTerm = "AnyTerm"
+    AllTermsAnyField = "AllTermsAnyField"
+    AllTermsSameField = "AllTermsSameField"
+    ExactPhrase = "ExactPhrase"
+    ExactPhrasePrefix = "ExactPhrasePrefix"
+
+
+class XpThingType(OrderCloudEnum):
+    """"""
+
+    Address = "Address"
+    Variant = "Variant"
+    Order = "Order"
+    OrderReturn = "OrderReturn"
+    LineItem = "LineItem"
+    CostCenter = "CostCenter"
+    CreditCard = "CreditCard"
+    Payment = "Payment"
+    Spec = "Spec"
+    SpecOption = "SpecOption"
+    UserGroup = "UserGroup"
+    Company = "Company"
+    Category = "Category"
+    PriceSchedule = "PriceSchedule"
+    Shipment = "Shipment"
+    SpendingAccount = "SpendingAccount"
+    User = "User"
+    Promotion = "Promotion"
+    ApprovalRule = "ApprovalRule"
+    SellerApprovalRule = "SellerApprovalRule"
+    Catalog = "Catalog"
+    ProductFacet = "ProductFacet"
+    MessageSender = "MessageSender"
+    InventoryRecord = "InventoryRecord"
+    ProductCollection = "ProductCollection"
+    Subscription = "Subscription"
+    GroupOrderInvitation = "GroupOrderInvitation"
+    BuyerGroup = "BuyerGroup"
+    Discount = "Discount"
+
+
+class Incrementor(OrderCloudModel):
+    """An OrderCloud Incrementor.
+
+    Attributes:
+        id: The string "{replace-with-incrementor-ID}" can be passed into any ID field to populate the next ID in the sequence. It can also be prefixed with other ID safe characters.
+        name:
+        last_number: Increments as IDs are generated.
+        left_padding_count: Use to enforce a minimum incrementor ID length. For example if your LastNumber is 0 and LeftPaddingCount is 4, your first generated ID will be 0001.
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    last_number: Optional[int] = Field(None, alias="LastNumber")
+    left_padding_count: Optional[int] = Field(None, alias="LeftPaddingCount")
+
+
+class XpIndex(OrderCloudModel):
+    """An OrderCloud XpIndex.
+
+    Attributes:
+        thing_type:
+        key:
+    """
+
+    thing_type: Optional[XpThingType] = Field(None, alias="ThingType")
+    key: Optional[str] = Field(None, alias="Key")
+
+
+class ProductFacet(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ProductFacet.
+
+    Attributes:
+        id:
+        name:
+        xp_path: Identifies full path to XP field used for this facet. If not provided, facet value assumed to be stored at product.XP.{facet ID}.
+        list_order:
+        min_count: Minimum count required or a facet value to be returned in list metadata. If you want zero-count values returned, set this to 0.
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    name: Optional[str] = Field(None, alias="Name")
+    xp_path: Optional[str] = Field(None, alias="XpPath")
+    list_order: Optional[int] = Field(None, alias="ListOrder")
+    min_count: int = Field(1, alias="MinCount")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class GroupOrderInvitation(OrderCloudModel, Generic[XP]):
+    """An OrderCloud GroupOrderInvitation.
+
+    Attributes:
+        id:  (read-only)
+        expiration_date: Maximum 1 year.
+        name:
+        order_id:
+        order_status:  (read-only)
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
+    name: Optional[str] = Field(None, alias="Name")
+    order_id: Optional[str] = Field(None, alias="OrderID")
+    order_status: Optional[_OrderStatus] = Field(None, alias="OrderStatus")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+_OrderStatus = OrderStatus

ordercloud/models/open_id_connect.py

@@ -0,0 +1,47 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud OpenIdConnect models."""
+
+from __future__ import annotations
+from typing import Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel
+
+__all__ = ["OpenIdConnect"]
+
+
+class OpenIdConnect(OrderCloudModel):
+    """An OrderCloud OpenIdConnect.
+
+    Attributes:
+        id: ID of this OpenID Connect configuration object. Each object allows authentication to one OrderCloud API Client through one Identity Providing Party.
+        order_cloud_api_client_id: An ID that references an OrderCloud API Client.
+        connect_client_id: An app ID from the Identity Provider that is required to get JWT tokens.
+        connect_client_secret: A secret string from the Identity Provider that grants access to get JWT tokens.
+        app_start_url: A URL on your front-end ordering site where users will be redirected after they authenticate through the Identity Provider. Supports placeholders: {0} = OrderCloud access token, {1} = IdP access token, {2} = appStartPath, {3} = OrderCloud refresh token, {4} = IdP refresh token (if available).
+        authorization_endpoint: A publicly known URL from the Identity Provider that redirects to a resource where users enter personal credentials.
+        token_endpoint: A publicly known URL from the Identity Provider where agents can get JWT tokens.
+        url_encoded: If true, uses a url encoded form post with all auth values. Otherwise, an Authorization header with basic auth is passed with a JSON object in the body.
+        integration_event_id: ID of the integration event to call upon authorization request. Used when you haven't pre-populated users into OrderCloud, or need to sync user data.
+        call_sync_user_integration_event: If true, the integration event is always triggered regardless of if the user already exists in OrderCloud.
+        integration_event_name:  (read-only)
+        additional_idp_scopes: Any additional scopes needed by the IDP.
+        custom_error_url: A URL on your front-end ordering site where users will be redirected if an error occurs while trying to authenticate.
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    order_cloud_api_client_id: Optional[str] = Field(None, alias="OrderCloudApiClientID")
+    connect_client_id: Optional[str] = Field(None, alias="ConnectClientID")
+    connect_client_secret: Optional[str] = Field(None, alias="ConnectClientSecret")
+    app_start_url: Optional[str] = Field(None, alias="AppStartUrl")
+    authorization_endpoint: Optional[str] = Field(None, alias="AuthorizationEndpoint")
+    token_endpoint: Optional[str] = Field(None, alias="TokenEndpoint")
+    url_encoded: Optional[bool] = Field(None, alias="UrlEncoded")
+    integration_event_id: Optional[str] = Field(None, alias="IntegrationEventID")
+    call_sync_user_integration_event: Optional[bool] = Field(
+        None, alias="CallSyncUserIntegrationEvent"
+    )
+    integration_event_name: Optional[str] = Field(None, alias="IntegrationEventName")
+    additional_idp_scopes: Optional[list[str]] = Field(None, alias="AdditionalIdpScopes")
+    custom_error_url: Optional[str] = Field(None, alias="CustomErrorUrl")