workos 1.5.1__py3-none-any.whl → 5.38.0__py3-none-any.whl

workos/types/user_management/oauth_tokens.py

@@ -0,0 +1,21 @@
+from typing import Literal, Sequence
+
+from workos.types.workos_model import WorkOSModel
+
+OAuthTokensProvidersType = Literal[
+    "AppleOauth",
+    "GitHubOauth",
+    "GoogleOauth",
+    "MicrosoftOauth",
+    "SalesforceOauth",
+]
+
+
+class OAuthTokens(WorkOSModel):
+    """Representation of a WorkOS Dashboard member impersonating a user"""
+
+    provider: OAuthTokensProvidersType
+    access_token: str
+    refresh_token: str
+    expires_at: int
+    scopes: Sequence[str]

workos/types/user_management/organization_membership.py

@@ -0,0 +1,25 @@
+from typing import Literal, Sequence, Optional
+from typing_extensions import TypedDict
+
+from workos.types.workos_model import WorkOSModel
+from workos.typing.literals import LiteralOrUntyped
+
+OrganizationMembershipStatus = Literal["active", "inactive", "pending"]
+
+
+class OrganizationMembershipRole(TypedDict):
+    slug: str
+
+
+class OrganizationMembership(WorkOSModel):
+    """Representation of an WorkOS Organization Membership."""
+
+    object: Literal["organization_membership"]
+    id: str
+    user_id: str
+    organization_id: str
+    role: OrganizationMembershipRole
+    roles: Optional[Sequence[OrganizationMembershipRole]] = None
+    status: LiteralOrUntyped[OrganizationMembershipStatus]
+    created_at: str
+    updated_at: str

workos/types/user_management/password_hash_type.py

@@ -0,0 +1,4 @@
+from typing import Literal
+
+
+PasswordHashType = Literal["bcrypt", "firebase-scrypt", "ssha"]

workos/types/user_management/password_reset.py

@@ -0,0 +1,18 @@
+from typing import Literal
+from workos.types.workos_model import WorkOSModel
+
+
+class PasswordResetCommon(WorkOSModel):
+    object: Literal["password_reset"]
+    id: str
+    user_id: str
+    email: str
+    expires_at: str
+    created_at: str
+
+
+class PasswordReset(PasswordResetCommon):
+    """Representation of a WorkOS PasswordReset object."""
+
+    password_reset_token: str
+    password_reset_url: str

workos/types/user_management/screen_hint.py

@@ -0,0 +1,3 @@
+from typing import Literal
+
+ScreenHintType = Literal["sign-up", "sign-in"]

workos/types/user_management/session.py

@@ -0,0 +1,79 @@
+from enum import Enum
+from typing import Optional, Sequence, TypedDict, Union
+
+from typing_extensions import Literal
+
+from workos.types.user_management.impersonator import Impersonator
+from workos.types.user_management.user import User
+from workos.types.workos_model import WorkOSModel
+
+
+class AuthenticateWithSessionCookieFailureReason(Enum):
+    INVALID_JWT = "invalid_jwt"
+    INVALID_SESSION_COOKIE = "invalid_session_cookie"
+    NO_SESSION_COOKIE_PROVIDED = "no_session_cookie_provided"
+
+
+class AuthenticateWithSessionCookieSuccessResponse(WorkOSModel):
+    authenticated: Literal[True]
+    session_id: str
+    organization_id: Optional[str] = None
+    role: Optional[str] = None
+    roles: Optional[Sequence[str]] = None
+    permissions: Optional[Sequence[str]] = None
+    user: User
+    impersonator: Optional[Impersonator] = None
+    entitlements: Optional[Sequence[str]] = None
+    feature_flags: Optional[Sequence[str]] = None
+
+
+class AuthenticateWithSessionCookieErrorResponse(WorkOSModel):
+    authenticated: Literal[False]
+    reason: Union[AuthenticateWithSessionCookieFailureReason, str]
+
+
+class RefreshWithSessionCookieSuccessResponse(
+    AuthenticateWithSessionCookieSuccessResponse
+):
+    sealed_session: str
+
+
+class RefreshWithSessionCookieErrorResponse(WorkOSModel):
+    authenticated: Literal[False]
+    reason: Union[AuthenticateWithSessionCookieFailureReason, str]
+
+
+class SessionConfig(TypedDict, total=False):
+    seal_session: bool
+    cookie_password: str
+
+
+AuthMethodType = Literal[
+    "external_auth",
+    "impersonation",
+    "magic_code",
+    "migrated_session",
+    "oauth",
+    "passkey",
+    "password",
+    "sso",
+    "unknown",
+]
+
+
+class Session(WorkOSModel):
+    """Representation of a WorkOS User Management Session."""
+
+    object: Literal["session"]
+    id: str
+    user_id: str
+    organization_id: Optional[str] = None
+    status: str
+    auth_method: AuthMethodType
+    impersonator: Optional[Impersonator] = None
+    ip_address: Optional[str] = None
+    user_agent: Optional[str] = None
+    expires_at: str
+    ended_at: Optional[str] = None
+    created_at: str
+    updated_at: str

workos/types/user_management/user.py

@@ -0,0 +1,22 @@
+from dataclasses import field
+from typing import Literal, Optional
+from workos.types.metadata import Metadata
+from workos.types.workos_model import WorkOSModel
+
+
+class User(WorkOSModel):
+    """Representation of a WorkOS User."""
+
+    object: Literal["user"]
+    id: str
+    email: str
+    first_name: Optional[str] = None
+    last_name: Optional[str] = None
+    email_verified: bool
+    profile_picture_url: Optional[str] = None
+    last_sign_in_at: Optional[str] = None
+    locale: Optional[str] = None
+    created_at: str
+    updated_at: str
+    external_id: Optional[str] = None
+    metadata: Metadata = field(default_factory=dict)

workos/types/user_management/user_management_provider_type.py

@@ -0,0 +1,11 @@
+from typing import Literal
+
+
+UserManagementProviderType = Literal[
+    "authkit",
+    "AppleOAuth",
+    "GitHubOAuth",
+    "GoogleOAuth",
+    "MicrosoftOAuth",
+    "SalesforceOAuth",
+]

workos/types/vault/__init__.py

@@ -0,0 +1,2 @@
+from .key import *
+from .object import *

workos/types/vault/key.py

@@ -0,0 +1,25 @@
+from typing import Dict
+from pydantic import BaseModel, RootModel
+from workos.types.workos_model import WorkOSModel
+
+
+class KeyContext(RootModel[Dict[str, str]]):
+    pass
+
+
+class DataKey(WorkOSModel):
+    id: str
+    key: str
+
+
+class DataKeyPair(WorkOSModel):
+    context: KeyContext
+    data_key: DataKey
+    encrypted_keys: str
+
+
+class DecodedKeys(BaseModel):
+    iv: bytes
+    tag: bytes
+    keys: str  # Base64-encoded string
+    ciphertext: bytes

workos/types/vault/object.py

@@ -0,0 +1,38 @@
+from typing import Optional
+
+from workos.types.workos_model import WorkOSModel
+from workos.types.vault import KeyContext
+
+
+class ObjectDigest(WorkOSModel):
+    id: str
+    name: str
+    updated_at: str
+
+
+class ObjectUpdateBy(WorkOSModel):
+    id: str
+    name: str
+
+
+class ObjectMetadata(WorkOSModel):
+    context: KeyContext
+    environment_id: str
+    id: str
+    key_id: str
+    updated_at: str
+    updated_by: ObjectUpdateBy
+    version_id: str
+
+
+class VaultObject(WorkOSModel):
+    id: str
+    metadata: ObjectMetadata
+    name: str
+    value: Optional[str] = None
+
+
+class ObjectVersion(WorkOSModel):
+    created_at: str
+    current_version: bool
+    id: str

workos/types/webhooks/webhook.py

@@ -0,0 +1,330 @@
+from typing import Literal, Union
+
+from pydantic import Field
+from typing_extensions import Annotated
+
+from workos.types.directory_sync import DirectoryGroup
+from workos.types.directory_sync.directory_user import DirectoryUser
+from workos.types.events.authentication_payload import (
+    AuthenticationEmailVerificationSucceededPayload,
+    AuthenticationMagicAuthFailedPayload,
+    AuthenticationMagicAuthSucceededPayload,
+    AuthenticationMfaSucceededPayload,
+    AuthenticationOauthFailedPayload,
+    AuthenticationOauthSucceededPayload,
+    AuthenticationPasswordFailedPayload,
+    AuthenticationPasswordSucceededPayload,
+    AuthenticationSsoFailedPayload,
+    AuthenticationSsoSucceededPayload,
+)
+from workos.types.events.connection_payload_with_legacy_fields import (
+    ConnectionPayloadWithLegacyFields,
+)
+from workos.types.events.directory_group_membership_payload import (
+    DirectoryGroupMembershipPayload,
+)
+from workos.types.events.directory_group_with_previous_attributes import (
+    DirectoryGroupWithPreviousAttributes,
+)
+from workos.types.events.directory_payload import DirectoryPayload
+from workos.types.events.directory_payload_with_legacy_fields import (
+    DirectoryPayloadWithLegacyFields,
+)
+from workos.types.events.directory_user_with_previous_attributes import (
+    DirectoryUserWithPreviousAttributes,
+)
+from workos.types.events.organization_domain_verification_failed_payload import (
+    OrganizationDomainVerificationFailedPayload,
+)
+from workos.types.events.session_payload import (
+    SessionCreatedPayload,
+    SessionRevokedPayload,
+)
+from workos.types.organization_domains import OrganizationDomain
+from workos.types.organizations.organization_common import OrganizationCommon
+from workos.types.roles.role import EventRole
+from workos.types.sso.connection import Connection
+from workos.types.user_management import OrganizationMembership, User
+from workos.types.user_management.email_verification import (
+    EmailVerificationCommon,
+)
+from workos.types.user_management.invitation import InvitationCommon
+from workos.types.user_management.magic_auth import MagicAuthCommon
+from workos.types.user_management.password_reset import PasswordResetCommon
+from workos.types.webhooks.webhook_model import WebhookModel
+
+# README
+# When adding a new webhook event type, ensure the new webhook class is
+# added to the Webhook union type at the bottom of this file.
+
+
+class AuthenticationEmailVerificationSucceededWebhook(
+    WebhookModel[AuthenticationEmailVerificationSucceededPayload,]
+):
+    event: Literal["authentication.email_verification_succeeded"]
+
+
+class AuthenticationMagicAuthFailedWebhook(
+    WebhookModel[AuthenticationMagicAuthFailedPayload,]
+):
+    event: Literal["authentication.magic_auth_failed"]
+
+
+class AuthenticationMagicAuthSucceededWebhook(
+    WebhookModel[AuthenticationMagicAuthSucceededPayload,]
+):
+    event: Literal["authentication.magic_auth_succeeded"]
+
+
+class AuthenticationMfaSucceededWebhook(
+    WebhookModel[AuthenticationMfaSucceededPayload]
+):
+    event: Literal["authentication.mfa_succeeded"]
+
+
+class AuthenticationOauthFailedWebhook(WebhookModel[AuthenticationOauthFailedPayload]):
+    event: Literal["authentication.oauth_failed"]
+
+
+class AuthenticationOauthSucceededWebhook(
+    WebhookModel[AuthenticationOauthSucceededPayload]
+):
+    event: Literal["authentication.oauth_succeeded"]
+
+
+class AuthenticationPasswordFailedWebhook(
+    WebhookModel[AuthenticationPasswordFailedPayload]
+):
+    event: Literal["authentication.password_failed"]
+
+
+class AuthenticationPasswordSucceededWebhook(
+    WebhookModel[AuthenticationPasswordSucceededPayload,]
+):
+    event: Literal["authentication.password_succeeded"]
+
+
+class AuthenticationSsoFailedWebhook(WebhookModel[AuthenticationSsoFailedPayload]):
+    event: Literal["authentication.sso_failed"]
+
+
+class AuthenticationSsoSucceededWebhook(
+    WebhookModel[AuthenticationSsoSucceededPayload]
+):
+    event: Literal["authentication.sso_succeeded"]
+
+
+class ConnectionActivatedWebhook(WebhookModel[ConnectionPayloadWithLegacyFields]):
+    event: Literal["connection.activated"]
+
+
+class ConnectionDeactivatedWebhook(WebhookModel[ConnectionPayloadWithLegacyFields]):
+    event: Literal["connection.deactivated"]
+
+
+class ConnectionDeletedWebhook(WebhookModel[Connection]):
+    event: Literal["connection.deleted"]
+
+
+class DirectoryActivatedWebhook(WebhookModel[DirectoryPayloadWithLegacyFields]):
+    event: Literal["dsync.activated"]
+
+
+class DirectoryDeletedWebhook(WebhookModel[DirectoryPayload]):
+    event: Literal["dsync.deleted"]
+
+
+class DirectoryGroupCreatedWebhook(WebhookModel[DirectoryGroup]):
+    event: Literal["dsync.group.created"]
+
+
+class DirectoryGroupDeletedWebhook(WebhookModel[DirectoryGroup]):
+    event: Literal["dsync.group.deleted"]
+
+
+class DirectoryGroupUpdatedWebhook(WebhookModel[DirectoryGroupWithPreviousAttributes]):
+    event: Literal["dsync.group.updated"]
+
+
+class DirectoryUserCreatedWebhook(WebhookModel[DirectoryUser]):
+    event: Literal["dsync.user.created"]
+
+
+class DirectoryUserDeletedWebhook(WebhookModel[DirectoryUser]):
+    event: Literal["dsync.user.deleted"]
+
+
+class DirectoryUserUpdatedWebhook(WebhookModel[DirectoryUserWithPreviousAttributes]):
+    event: Literal["dsync.user.updated"]
+
+
+class DirectoryUserAddedToGroupWebhook(WebhookModel[DirectoryGroupMembershipPayload]):
+    event: Literal["dsync.group.user_added"]
+
+
+class DirectoryUserRemovedFromGroupWebhook(
+    WebhookModel[DirectoryGroupMembershipPayload]
+):
+    event: Literal["dsync.group.user_removed"]
+
+
+class EmailVerificationCreatedWebhook(WebhookModel[EmailVerificationCommon]):
+    event: Literal["email_verification.created"]
+
+
+class InvitationAcceptedWebhook(WebhookModel[InvitationCommon]):
+    event: Literal["invitation.accepted"]
+
+
+class InvitationCreatedWebhook(WebhookModel[InvitationCommon]):
+    event: Literal["invitation.created"]
+
+
+class InvitationRevokedWebhook(WebhookModel[InvitationCommon]):
+    event: Literal["invitation.revoked"]
+
+
+class MagicAuthCreatedWebhook(WebhookModel[MagicAuthCommon]):
+    event: Literal["magic_auth.created"]
+
+
+class OrganizationCreatedWebhook(WebhookModel[OrganizationCommon]):
+    event: Literal["organization.created"]
+
+
+class OrganizationDeletedWebhook(WebhookModel[OrganizationCommon]):
+    event: Literal["organization.deleted"]
+
+
+class OrganizationUpdatedWebhook(WebhookModel[OrganizationCommon]):
+    event: Literal["organization.updated"]
+
+
+class OrganizationDomainVerificationFailedWebhook(
+    WebhookModel[OrganizationDomainVerificationFailedPayload,]
+):
+    event: Literal["organization_domain.verification_failed"]
+
+
+class OrganizationDomainVerifiedWebhook(WebhookModel[OrganizationDomain]):
+    event: Literal["organization_domain.verified"]
+
+
+class OrganizationDomainCreatedWebhook(WebhookModel[OrganizationDomain]):
+    event: Literal["organization_domain.created"]
+
+
+class OrganizationDomainUpdatedWebhook(WebhookModel[OrganizationDomain]):
+    event: Literal["organization_domain.updated"]
+
+
+class OrganizationDomainDeletedWebhook(WebhookModel[OrganizationDomain]):
+    event: Literal["organization_domain.deleted"]
+
+
+class OrganizationMembershipCreatedWebhook(WebhookModel[OrganizationMembership]):
+    event: Literal["organization_membership.created"]
+
+
+class OrganizationMembershipDeletedWebhook(WebhookModel[OrganizationMembership]):
+    event: Literal["organization_membership.deleted"]
+
+
+class OrganizationMembershipUpdatedWebhook(WebhookModel[OrganizationMembership]):
+    event: Literal["organization_membership.updated"]
+
+
+class PasswordResetCreatedWebhook(WebhookModel[PasswordResetCommon]):
+    event: Literal["password_reset.created"]
+
+
+class PasswordResetSucceededWebhook(WebhookModel[PasswordResetCommon]):
+    event: Literal["password_reset.succeeded"]
+
+
+class RoleCreatedWebhook(WebhookModel[EventRole]):
+    event: Literal["role.created"]
+
+
+class RoleDeletedWebhook(WebhookModel[EventRole]):
+    event: Literal["role.deleted"]
+
+
+class RoleUpdatedWebhook(WebhookModel[EventRole]):
+    event: Literal["role.updated"]
+
+
+class SessionCreatedWebhook(WebhookModel[SessionCreatedPayload]):
+    event: Literal["session.created"]
+
+
+class SessionRevokedWebhook(WebhookModel[SessionRevokedPayload]):
+    event: Literal["session.revoked"]
+
+
+class UserCreatedWebhook(WebhookModel[User]):
+    event: Literal["user.created"]
+
+
+class UserDeletedWebhook(WebhookModel[User]):
+    event: Literal["user.deleted"]
+
+
+class UserUpdatedWebhook(WebhookModel[User]):
+    event: Literal["user.updated"]
+
+
+Webhook = Annotated[
+    Union[
+        AuthenticationEmailVerificationSucceededWebhook,
+        AuthenticationMagicAuthFailedWebhook,
+        AuthenticationMagicAuthSucceededWebhook,
+        AuthenticationMfaSucceededWebhook,
+        AuthenticationOauthFailedWebhook,
+        AuthenticationOauthSucceededWebhook,
+        AuthenticationPasswordFailedWebhook,
+        AuthenticationPasswordSucceededWebhook,
+        AuthenticationSsoFailedWebhook,
+        AuthenticationSsoSucceededWebhook,
+        ConnectionActivatedWebhook,
+        ConnectionDeactivatedWebhook,
+        ConnectionDeletedWebhook,
+        DirectoryActivatedWebhook,
+        DirectoryDeletedWebhook,
+        DirectoryGroupCreatedWebhook,
+        DirectoryGroupDeletedWebhook,
+        DirectoryGroupUpdatedWebhook,
+        DirectoryUserCreatedWebhook,
+        DirectoryUserDeletedWebhook,
+        DirectoryUserUpdatedWebhook,
+        DirectoryUserAddedToGroupWebhook,
+        DirectoryUserRemovedFromGroupWebhook,
+        EmailVerificationCreatedWebhook,
+        InvitationAcceptedWebhook,
+        InvitationCreatedWebhook,
+        InvitationRevokedWebhook,
+        MagicAuthCreatedWebhook,
+        OrganizationCreatedWebhook,
+        OrganizationDeletedWebhook,
+        OrganizationUpdatedWebhook,
+        OrganizationDomainCreatedWebhook,
+        OrganizationDomainDeletedWebhook,
+        OrganizationDomainUpdatedWebhook,
+        OrganizationDomainVerificationFailedWebhook,
+        OrganizationDomainVerifiedWebhook,
+        OrganizationMembershipCreatedWebhook,
+        OrganizationMembershipDeletedWebhook,
+        OrganizationMembershipUpdatedWebhook,
+        PasswordResetCreatedWebhook,
+        PasswordResetSucceededWebhook,
+        RoleCreatedWebhook,
+        RoleDeletedWebhook,
+        RoleUpdatedWebhook,
+        SessionCreatedWebhook,
+        SessionRevokedWebhook,
+        UserCreatedWebhook,
+        UserDeletedWebhook,
+        UserUpdatedWebhook,
+    ],
+    Field(..., discriminator="event"),
+]

workos/types/webhooks/webhook_model.py

@@ -0,0 +1,14 @@
+from typing import Generic
+from workos.types.events.event_model import EventPayload
+from workos.types.workos_model import WorkOSModel
+
+
+class WebhookModel(WorkOSModel, Generic[EventPayload]):
+    """Representation of an Webhook delivered via Webhook.
+    Attributes:
+        OBJECT_FIELDS (list): List of fields an Webhook is comprised of.
+    """
+
+    id: str
+    data: EventPayload
+    created_at: str

workos/types/webhooks/webhook_payload.py

@@ -0,0 +1,4 @@
+from typing import Union
+
+
+WebhookPayload = Union[bytes, bytearray]

workos/types/widgets/__init__.py

@@ -0,0 +1,2 @@
+from .widget_scope import *
+from .widget_token_response import *

workos/types/widgets/widget_scope.py

@@ -0,0 +1,4 @@
+from typing import Literal
+
+
+WidgetScope = Literal["widgets:users-table:manage"]

workos/types/widgets/widget_token_response.py

@@ -0,0 +1,7 @@
+from workos.types.workos_model import WorkOSModel
+
+
+class WidgetTokenResponse(WorkOSModel):
+    """Representation of a WorkOS widget token response."""
+
+    token: str

workos/types/workos_model.py

@@ -0,0 +1,26 @@
+from typing import Any, Dict, Optional
+from typing_extensions import override
+from pydantic import BaseModel
+from pydantic.main import IncEx
+
+
+class WorkOSModel(BaseModel):
+    @override
+    def dict(
+        self,
+        *,
+        include: Optional[IncEx] = None,
+        exclude: Optional[IncEx] = None,
+        by_alias: bool = False,
+        exclude_unset: bool = False,
+        exclude_defaults: bool = False,
+        exclude_none: bool = False
+    ) -> Dict[str, Any]:
+        return self.model_dump(
+            include=include,
+            exclude=exclude,
+            by_alias=by_alias,
+            exclude_unset=exclude_unset,
+            exclude_defaults=exclude_defaults,
+            exclude_none=exclude_none,
+        )

workos/typing/__init__.py

@@ -0,0 +1 @@
+from workos.typing.untyped_literal import is_untyped_literal