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

workos/types/directory_sync/__init__.py

@@ -0,0 +1,5 @@
+from .directory_group import *
+from .directory_state import *
+from .directory_type import *
+from .directory_user import *
+from .directory import *

workos/types/directory_sync/directory.py

@@ -0,0 +1,31 @@
+from typing import Literal, Optional
+from workos.types.workos_model import WorkOSModel
+from workos.types.directory_sync.directory_state import DirectoryState
+from workos.types.directory_sync.directory_type import DirectoryType
+from workos.typing.literals import LiteralOrUntyped
+
+
+class DirectoryUsersMetadata(WorkOSModel):
+    active: int
+    inactive: int
+
+
+class DirectoryMetadata(WorkOSModel):
+    users: DirectoryUsersMetadata
+    groups: int
+
+
+class Directory(WorkOSModel):
+    """Representation of a Directory Response as returned by WorkOS through the Directory Sync feature."""
+
+    id: str
+    object: Literal["directory"]
+    domain: Optional[str] = None
+    name: str
+    organization_id: str
+    external_key: str
+    state: LiteralOrUntyped[DirectoryState]
+    type: LiteralOrUntyped[DirectoryType]
+    metadata: Optional[DirectoryMetadata] = None
+    created_at: str
+    updated_at: str

workos/types/directory_sync/directory_group.py

@@ -0,0 +1,16 @@
+from typing import Any, Literal, Mapping
+from workos.types.workos_model import WorkOSModel
+
+
+class DirectoryGroup(WorkOSModel):
+    """Representation of a Directory Group as returned by WorkOS through the Directory Sync feature."""
+
+    id: str
+    object: Literal["directory_group"]
+    idp_id: str
+    name: str
+    directory_id: str
+    organization_id: str
+    raw_attributes: Mapping[str, Any]
+    created_at: str
+    updated_at: str

workos/types/directory_sync/directory_state.py

@@ -0,0 +1,28 @@
+from typing import Any, Literal
+from pydantic import BeforeValidator, ValidationInfo
+from typing_extensions import Annotated
+
+
+ApiDirectoryState = Literal[
+    "active",
+    "inactive",
+    "validating",
+    "deleting",
+    "invalid_credentials",
+]
+
+
+def convert_legacy_directory_state(value: Any, info: ValidationInfo) -> Any:
+    if isinstance(value, str):
+        if value == "linked":
+            return "active"
+        elif value == "unlinked":
+            return "inactive"
+
+    return value
+
+
+DirectoryState = Annotated[
+    ApiDirectoryState,
+    BeforeValidator(convert_legacy_directory_state),
+]

workos/types/directory_sync/directory_type.py

@@ -0,0 +1,24 @@
+from typing import Literal
+
+
+DirectoryType = Literal[
+    "azure scim v2.0",
+    "bamboohr",
+    "breathe hr",
+    "cezanne hr",
+    "cyperark scim v2.0",
+    "fourth hr",
+    "generic scim v2.0",
+    "gsuite directory",
+    "hibob",
+    "jump cloud scim v2.0",
+    "okta scim v2.0",
+    "onelogin scim v2.0",
+    "people hr",
+    "personio",
+    "pingfederate scim v2.0",
+    "rippling v2.0",
+    "sftp",
+    "sftp workday",
+    "workday",
+]

workos/types/directory_sync/directory_user.py

@@ -0,0 +1,50 @@
+from typing import Any, Dict, Literal, Optional, Sequence, Union
+
+from workos.types.workos_model import WorkOSModel
+from workos.types.directory_sync.directory_group import DirectoryGroup
+
+
+DirectoryUserState = Literal["active", "inactive"]
+
+
+class DirectoryUserEmail(WorkOSModel):
+    type: Optional[str] = None
+    value: Optional[str] = None
+    primary: Optional[bool] = None
+
+
+class InlineRole(WorkOSModel):
+    slug: str
+
+
+class DirectoryUser(WorkOSModel):
+    id: str
+    object: Literal["directory_user"]
+    idp_id: str
+    directory_id: str
+    organization_id: str
+    first_name: Optional[str] = None
+    last_name: Optional[str] = None
+    email: Optional[str] = None
+    # @deprecated Will be removed in a future major version. Enable the `job_title` custom attribute in dashboard and pull from customAttributes instead. See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
+    job_title: Optional[str] = None
+    # @deprecated Will be removed in a future major version. Enable the `emails` custom attribute in dashboard and pull from customAttributes instead. See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
+    emails: Sequence[DirectoryUserEmail]
+    # @deprecated Will be removed in a future major version. Enable the `username` custom attribute in dashboard and pull from customAttributes instead. See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
+    username: Optional[str] = None
+    state: DirectoryUserState
+    custom_attributes: Dict[str, Any]
+    raw_attributes: Dict[str, Any]
+    created_at: str
+    updated_at: str
+    role: Optional[InlineRole] = None
+    roles: Optional[Sequence[InlineRole]] = None
+
+    def primary_email(self) -> Union[DirectoryUserEmail, None]:
+        return next((email for email in self.emails if email.primary), None)
+
+
+class DirectoryUserWithGroups(DirectoryUser):
+    """Representation of a Directory User as returned by WorkOS through the Directory Sync feature."""
+
+    groups: Sequence[DirectoryGroup]

workos/types/directory_sync/list_filters.py

@@ -0,0 +1,21 @@
+from typing import Optional
+from workos.types.list_resource import ListArgs
+
+
+class DirectoryListFilters(ListArgs, total=False):
+    search: Optional[str]
+    organization_id: Optional[str]
+    domain: Optional[str]
+
+
+class DirectoryUserListFilters(
+    ListArgs,
+    total=False,
+):
+    group: Optional[str]
+    directory: Optional[str]
+
+
+class DirectoryGroupListFilters(ListArgs, total=False):
+    user: Optional[str]
+    directory: Optional[str]

workos/types/events/__init__.py

@@ -0,0 +1,13 @@
+from .authentication_payload import *
+from .connection_payload_with_legacy_fields import *
+from .directory_group_membership_payload import *
+from .directory_group_with_previous_attributes import *
+from .directory_payload import *
+from .directory_payload_with_legacy_fields import *
+from .directory_user_with_previous_attributes import *
+from .event_model import *
+from .event_type import *
+from .event import *
+from .organization_domain_verification_failed_payload import *
+from .previous_attributes import *
+from .session_payload import *

workos/types/events/authentication_payload.py

@@ -0,0 +1,70 @@
+from typing import Literal, Optional
+from workos.types.workos_model import WorkOSModel
+
+
+class AuthenticationResultCommon(WorkOSModel):
+    ip_address: Optional[str] = None
+    user_agent: Optional[str] = None
+
+
+class AuthenticationResultSucceeded(AuthenticationResultCommon):
+    status: Literal["succeeded"]
+    email: str
+
+
+class ErrorWithCode(WorkOSModel):
+    code: str
+    message: str
+
+
+class AuthenticationResultFailed(AuthenticationResultCommon):
+    status: Literal["failed"]
+    error: ErrorWithCode
+    email: Optional[str] = None
+    user_id: Optional[str] = None
+
+
+class AuthenticationEmailVerificationSucceededPayload(AuthenticationResultSucceeded):
+    type: Literal["email_verification"]
+    user_id: str
+
+
+class AuthenticationMagicAuthFailedPayload(AuthenticationResultFailed):
+    type: Literal["magic_auth"]
+
+
+class AuthenticationMagicAuthSucceededPayload(AuthenticationResultSucceeded):
+    type: Literal["magic_auth"]
+    user_id: str
+
+
+class AuthenticationMfaSucceededPayload(AuthenticationResultSucceeded):
+    type: Literal["mfa"]
+    user_id: Optional[str] = None
+
+
+class AuthenticationOauthFailedPayload(AuthenticationResultFailed):
+    type: Literal["oauth"]
+
+
+class AuthenticationOauthSucceededPayload(AuthenticationResultSucceeded):
+    type: Literal["oauth"]
+    user_id: Optional[str] = None
+
+
+class AuthenticationPasswordFailedPayload(AuthenticationResultFailed):
+    type: Literal["password"]
+
+
+class AuthenticationPasswordSucceededPayload(AuthenticationResultSucceeded):
+    type: Literal["password"]
+    user_id: str
+
+
+class AuthenticationSsoFailedPayload(AuthenticationResultFailed):
+    type: Literal["sso"]
+
+
+class AuthenticationSsoSucceededPayload(AuthenticationResultSucceeded):
+    type: Literal["sso"]
+    user_id: Optional[str] = None

workos/types/events/connection_payload_with_legacy_fields.py

@@ -0,0 +1,5 @@
+from workos.types.sso import ConnectionWithDomains
+
+
+class ConnectionPayloadWithLegacyFields(ConnectionWithDomains):
+    external_key: str

workos/types/events/directory_group_membership_payload.py

@@ -0,0 +1,9 @@
+from workos.types.directory_sync import DirectoryGroup
+from workos.types.workos_model import WorkOSModel
+from workos.types.directory_sync.directory_user import DirectoryUser
+
+
+class DirectoryGroupMembershipPayload(WorkOSModel):
+    directory_id: str
+    user: DirectoryUser
+    group: DirectoryGroup

workos/types/events/directory_group_with_previous_attributes.py

@@ -0,0 +1,6 @@
+from workos.types.directory_sync import DirectoryGroup
+from workos.types.events.previous_attributes import PreviousAttributes
+
+
+class DirectoryGroupWithPreviousAttributes(DirectoryGroup):
+    previous_attributes: PreviousAttributes

workos/types/events/directory_payload.py

@@ -0,0 +1,16 @@
+from typing import Literal
+from workos.types.directory_sync import DirectoryType
+from workos.types.workos_model import WorkOSModel
+from workos.types.directory_sync.directory_state import DirectoryState
+from workos.typing.literals import LiteralOrUntyped
+
+
+class DirectoryPayload(WorkOSModel):
+    id: str
+    name: str
+    state: LiteralOrUntyped[DirectoryState]
+    type: LiteralOrUntyped[DirectoryType]
+    organization_id: str
+    created_at: str
+    updated_at: str
+    object: Literal["directory"]

workos/types/events/directory_payload_with_legacy_fields.py

@@ -0,0 +1,29 @@
+from typing import Literal, Sequence
+from workos.types.workos_model import WorkOSModel
+from workos.types.events.directory_payload import DirectoryPayload
+
+
+class MinimalOrganizationDomain(WorkOSModel):
+    id: str
+    # TODO: This should be domain: str in the
+    # next major version to fix object parsing.
+    organization_id: str
+    object: Literal["organization_domain"]
+
+
+# TODO: This class should be removed in the next major version once MinimalOrganizationDomain is updated.
+class MinimalOrganizationDomainForEventsApi(WorkOSModel):
+    id: str
+    domain: str
+    object: Literal["organization_domain"]
+
+
+class DirectoryPayloadWithLegacyFields(DirectoryPayload):
+    domains: Sequence[MinimalOrganizationDomain]
+    external_key: str
+
+
+# TODO: This class should be removed in the next major version once MinimalOrganizationDomain is updated.
+class DirectoryPayloadWithLegacyFieldsForEventsApi(DirectoryPayload):
+    domains: Sequence[MinimalOrganizationDomainForEventsApi]
+    external_key: str

workos/types/events/directory_user_with_previous_attributes.py

@@ -0,0 +1,6 @@
+from workos.types.directory_sync.directory_user import DirectoryUser
+from workos.types.events.previous_attributes import PreviousAttributes
+
+
+class DirectoryUserWithPreviousAttributes(DirectoryUser):
+    previous_attributes: PreviousAttributes

workos/types/events/event.py

@@ -0,0 +1,324 @@
+from typing import Literal, Union
+from pydantic import Field
+from typing_extensions import Annotated
+from workos.types.user_management import OrganizationMembership, User
+from workos.types.directory_sync.directory_group 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 (
+    DirectoryPayloadWithLegacyFieldsForEventsApi,
+)
+from workos.types.events.directory_user_with_previous_attributes import (
+    DirectoryUserWithPreviousAttributes,
+)
+from workos.types.events.event_model import EventModel
+from workos.types.events.organization_domain_verification_failed_payload import (
+    OrganizationDomainVerificationFailedPayload,
+)
+from workos.types.events.session_payload import (
+    SessionCreatedPayload,
+    SessionRevokedPayload,
+)
+from workos.types.organizations.organization_common import OrganizationCommon
+from workos.types.organization_domains import OrganizationDomain
+from workos.types.roles.role import EventRole
+from workos.types.sso.connection import Connection
+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
+
+
+# README
+# When adding a new event type, ensure the new event class is
+# added to the Event union type at the bottom of this file, and
+# the event name is added to the EventType union type in event_type.py.
+
+
+class AuthenticationEmailVerificationSucceededEvent(
+    EventModel[AuthenticationEmailVerificationSucceededPayload,]
+):
+    event: Literal["authentication.email_verification_succeeded"]
+
+
+class AuthenticationMagicAuthFailedEvent(
+    EventModel[AuthenticationMagicAuthFailedPayload,]
+):
+    event: Literal["authentication.magic_auth_failed"]
+
+
+class AuthenticationMagicAuthSucceededEvent(
+    EventModel[AuthenticationMagicAuthSucceededPayload,]
+):
+    event: Literal["authentication.magic_auth_succeeded"]
+
+
+class AuthenticationMfaSucceededEvent(EventModel[AuthenticationMfaSucceededPayload]):
+    event: Literal["authentication.mfa_succeeded"]
+
+
+class AuthenticationOauthFailedEvent(EventModel[AuthenticationOauthFailedPayload]):
+    event: Literal["authentication.oauth_failed"]
+
+
+class AuthenticationOauthSucceededEvent(
+    EventModel[AuthenticationOauthSucceededPayload]
+):
+    event: Literal["authentication.oauth_succeeded"]
+
+
+class AuthenticationPasswordFailedEvent(
+    EventModel[AuthenticationPasswordFailedPayload]
+):
+    event: Literal["authentication.password_failed"]
+
+
+class AuthenticationPasswordSucceededEvent(
+    EventModel[AuthenticationPasswordSucceededPayload,]
+):
+    event: Literal["authentication.password_succeeded"]
+
+
+class AuthenticationSsoFailedEvent(EventModel[AuthenticationSsoFailedPayload]):
+    event: Literal["authentication.sso_failed"]
+
+
+class AuthenticationSsoSucceededEvent(EventModel[AuthenticationSsoSucceededPayload]):
+    event: Literal["authentication.sso_succeeded"]
+
+
+class ConnectionActivatedEvent(EventModel[ConnectionPayloadWithLegacyFields]):
+    event: Literal["connection.activated"]
+
+
+class ConnectionDeactivatedEvent(EventModel[ConnectionPayloadWithLegacyFields]):
+    event: Literal["connection.deactivated"]
+
+
+class ConnectionDeletedEvent(EventModel[Connection]):
+    event: Literal["connection.deleted"]
+
+
+class DirectoryActivatedEvent(EventModel[DirectoryPayloadWithLegacyFieldsForEventsApi]):
+    event: Literal["dsync.activated"]
+
+
+class DirectoryDeletedEvent(EventModel[DirectoryPayload]):
+    event: Literal["dsync.deleted"]
+
+
+class DirectoryGroupCreatedEvent(EventModel[DirectoryGroup]):
+    event: Literal["dsync.group.created"]
+
+
+class DirectoryGroupDeletedEvent(EventModel[DirectoryGroup]):
+    event: Literal["dsync.group.deleted"]
+
+
+class DirectoryGroupUpdatedEvent(EventModel[DirectoryGroupWithPreviousAttributes]):
+    event: Literal["dsync.group.updated"]
+
+
+class DirectoryUserCreatedEvent(EventModel[DirectoryUser]):
+    event: Literal["dsync.user.created"]
+
+
+class DirectoryUserDeletedEvent(EventModel[DirectoryUser]):
+    event: Literal["dsync.user.deleted"]
+
+
+class DirectoryUserUpdatedEvent(EventModel[DirectoryUserWithPreviousAttributes]):
+    event: Literal["dsync.user.updated"]
+
+
+class DirectoryUserAddedToGroupEvent(EventModel[DirectoryGroupMembershipPayload]):
+    event: Literal["dsync.group.user_added"]
+
+
+class DirectoryUserRemovedFromGroupEvent(EventModel[DirectoryGroupMembershipPayload]):
+    event: Literal["dsync.group.user_removed"]
+
+
+class EmailVerificationCreatedEvent(EventModel[EmailVerificationCommon]):
+    event: Literal["email_verification.created"]
+
+
+class InvitationAcceptedEvent(EventModel[InvitationCommon]):
+    event: Literal["invitation.accepted"]
+
+
+class InvitationCreatedEvent(EventModel[InvitationCommon]):
+    event: Literal["invitation.created"]
+
+
+class InvitationRevokedEvent(EventModel[InvitationCommon]):
+    event: Literal["invitation.revoked"]
+
+
+class MagicAuthCreatedEvent(EventModel[MagicAuthCommon]):
+    event: Literal["magic_auth.created"]
+
+
+class OrganizationCreatedEvent(EventModel[OrganizationCommon]):
+    event: Literal["organization.created"]
+
+
+class OrganizationDeletedEvent(EventModel[OrganizationCommon]):
+    event: Literal["organization.deleted"]
+
+
+class OrganizationUpdatedEvent(EventModel[OrganizationCommon]):
+    event: Literal["organization.updated"]
+
+
+class OrganizationDomainVerificationFailedEvent(
+    EventModel[OrganizationDomainVerificationFailedPayload,]
+):
+    event: Literal["organization_domain.verification_failed"]
+
+
+class OrganizationDomainVerifiedEvent(EventModel[OrganizationDomain]):
+    event: Literal["organization_domain.verified"]
+
+
+class OrganizationDomainCreatedEvent(EventModel[OrganizationDomain]):
+    event: Literal["organization_domain.created"]
+
+
+class OrganizationDomainUpdatedEvent(EventModel[OrganizationDomain]):
+    event: Literal["organization_domain.updated"]
+
+
+class OrganizationDomainDeletedEvent(EventModel[OrganizationDomain]):
+    event: Literal["organization_domain.deleted"]
+
+
+class OrganizationMembershipCreatedEvent(EventModel[OrganizationMembership]):
+    event: Literal["organization_membership.created"]
+
+
+class OrganizationMembershipDeletedEvent(EventModel[OrganizationMembership]):
+    event: Literal["organization_membership.deleted"]
+
+
+class OrganizationMembershipUpdatedEvent(EventModel[OrganizationMembership]):
+    event: Literal["organization_membership.updated"]
+
+
+class PasswordResetCreatedEvent(EventModel[PasswordResetCommon]):
+    event: Literal["password_reset.created"]
+
+
+class PasswordResetSucceededEvent(EventModel[PasswordResetCommon]):
+    event: Literal["password_reset.succeeded"]
+
+
+class RoleCreatedEvent(EventModel[EventRole]):
+    event: Literal["role.created"]
+
+
+class RoleDeletedEvent(EventModel[EventRole]):
+    event: Literal["role.deleted"]
+
+
+class RoleUpdatedEvent(EventModel[EventRole]):
+    event: Literal["role.updated"]
+
+
+class SessionCreatedEvent(EventModel[SessionCreatedPayload]):
+    event: Literal["session.created"]
+
+
+class SessionRevokedEvent(EventModel[SessionRevokedPayload]):
+    event: Literal["session.revoked"]
+
+
+class UserCreatedEvent(EventModel[User]):
+    event: Literal["user.created"]
+
+
+class UserDeletedEvent(EventModel[User]):
+    event: Literal["user.deleted"]
+
+
+class UserUpdatedEvent(EventModel[User]):
+    event: Literal["user.updated"]
+
+
+Event = Annotated[
+    Union[
+        AuthenticationEmailVerificationSucceededEvent,
+        AuthenticationMagicAuthFailedEvent,
+        AuthenticationMagicAuthSucceededEvent,
+        AuthenticationMfaSucceededEvent,
+        AuthenticationOauthFailedEvent,
+        AuthenticationOauthSucceededEvent,
+        AuthenticationPasswordFailedEvent,
+        AuthenticationPasswordSucceededEvent,
+        AuthenticationSsoFailedEvent,
+        AuthenticationSsoSucceededEvent,
+        ConnectionActivatedEvent,
+        ConnectionDeactivatedEvent,
+        ConnectionDeletedEvent,
+        DirectoryActivatedEvent,
+        DirectoryDeletedEvent,
+        DirectoryGroupCreatedEvent,
+        DirectoryGroupDeletedEvent,
+        DirectoryGroupUpdatedEvent,
+        DirectoryUserCreatedEvent,
+        DirectoryUserDeletedEvent,
+        DirectoryUserUpdatedEvent,
+        DirectoryUserAddedToGroupEvent,
+        DirectoryUserRemovedFromGroupEvent,
+        EmailVerificationCreatedEvent,
+        InvitationAcceptedEvent,
+        InvitationCreatedEvent,
+        InvitationRevokedEvent,
+        MagicAuthCreatedEvent,
+        OrganizationCreatedEvent,
+        OrganizationDeletedEvent,
+        OrganizationUpdatedEvent,
+        OrganizationDomainCreatedEvent,
+        OrganizationDomainDeletedEvent,
+        OrganizationDomainUpdatedEvent,
+        OrganizationDomainVerificationFailedEvent,
+        OrganizationDomainVerifiedEvent,
+        OrganizationMembershipCreatedEvent,
+        OrganizationMembershipDeletedEvent,
+        OrganizationMembershipUpdatedEvent,
+        PasswordResetCreatedEvent,
+        PasswordResetSucceededEvent,
+        RoleCreatedEvent,
+        RoleDeletedEvent,
+        RoleUpdatedEvent,
+        SessionCreatedEvent,
+        SessionRevokedEvent,
+        UserCreatedEvent,
+        UserDeletedEvent,
+        UserUpdatedEvent,
+    ],
+    Field(..., discriminator="event"),
+]