Input type QoL improvements (#313)

* Audit logs QOL improvements

* Events and MFA QoL improvements

* passwordless QoL improvements

* SSO QoL improvements

* User management QoL improvements

* Fix some ciruclar dependencies

* Remove empty lines

* Update NotRequired import

tests/test_audit_logs.py

@@ -2,9 +2,8 @@
 
 import pytest
 
-from workos.audit_logs import AuditLogs
+from workos.audit_logs import AuditLogEvent, AuditLogs
 from workos.exceptions import AuthenticationException, BadRequestException
-from workos.resources.audit_logs import AuditLogEvent
 from workos.utils.http_client import SyncHTTPClient
 
 

tests/test_client.py

@@ -1,5 +1,4 @@
 import pytest
-
 from workos import async_client, client
 from workos.exceptions import ConfigurationException
 

tests/test_sso.py

@@ -1,13 +1,11 @@
 import json
-
 from six.moves.urllib.parse import parse_qsl, urlparse
 import pytest
-
 from tests.utils.fixtures.mock_profile import MockProfile
 from tests.utils.list_resource import list_data_to_dicts, list_response_of
 import workos
-from workos.sso import SSO, AsyncSSO
-from workos.resources.sso import Profile, SsoProviderType
+from workos.sso import SSO, AsyncSSO, SsoProviderType
+from workos.resources.sso import Profile
 from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
 from workos.utils.request_helper import RESPONSE_TYPE_CODE
 from tests.utils.fixtures.mock_connection import MockConnection

workos/audit_logs.py

@@ -1,7 +1,8 @@
 from typing import Optional, Protocol, Sequence
+from typing_extensions import TypedDict, NotRequired
 
 import workos
-from workos.resources.audit_logs import AuditLogEvent, AuditLogExport
+from workos.resources.audit_logs import AuditLogExport
 from workos.utils.http_client import SyncHTTPClient
 from workos.utils.request_helper import REQUEST_METHOD_GET, REQUEST_METHOD_POST
 from workos.utils.validation import AUDIT_LOGS_MODULE, validate_settings
@@ -10,6 +11,41 @@
 EXPORTS_PATH = "audit_logs/exports"
 
 
+class AuditLogEventTarget(TypedDict):
+    """Describes the entity that was targeted by the event."""
+
+    id: str
+    metadata: NotRequired[dict]
+    name: NotRequired[str]
+    type: str
+
+
+class AuditLogEventActor(TypedDict):
+    """Describes the entity that generated the event."""
+
+    id: str
+    metadata: NotRequired[dict]
+    name: NotRequired[str]
+    type: str
+
+
+class AuditLogEventContext(TypedDict):
+    """Attributes of audit log event context."""
+
+    location: str
+    user_agent: NotRequired[str]
+
+
+class AuditLogEvent(TypedDict):
+    action: str
+    version: NotRequired[int]
+    occurred_at: str  # ISO-8601 datetime of when an event occurred
+    actor: AuditLogEventActor
+    targets: Sequence[AuditLogEventTarget]
+    context: AuditLogEventContext
+    metadata: NotRequired[dict]
+
+
 class AuditLogsModule(Protocol):
     def create_event(
         self,

workos/events.py

@@ -1,4 +1,4 @@
-from typing import Optional, Protocol, Sequence, Union
+from typing import Literal, Optional, Protocol, Sequence, Union
 
 import workos
 from workos.typing.sync_or_async import SyncOrAsync

workos/mfa.py

@@ -1,4 +1,4 @@
-from typing import Optional, Protocol
+from typing import Literal, Optional, Protocol
 
 import workos
 from workos.utils.http_client import SyncHTTPClient
@@ -15,9 +15,14 @@
     AuthenticationFactor,
     AuthenticationFactorSms,
     AuthenticationFactorTotp,
-    EnrollAuthenticationFactorType,
+    SmsAuthenticationFactorType,
+    TotpAuthenticationFactorType,
 )
 
+EnrollAuthenticationFactorType = Literal[
+    SmsAuthenticationFactorType, TotpAuthenticationFactorType
+]
+
 
 class MFAModule(Protocol):
     def enroll_factor(

workos/passwordless.py

@@ -4,7 +4,9 @@
 from workos.utils.http_client import SyncHTTPClient
 from workos.utils.request_helper import REQUEST_METHOD_POST
 from workos.utils.validation import PASSWORDLESS_MODULE, validate_settings
-from workos.resources.passwordless import PasswordlessSession, PasswordlessSessionType
+from workos.resources.passwordless import PasswordlessSession
+
+PasswordlessSessionType = Literal["MagicLink"]
 
 
 class PasswordlessModule(Protocol):

workos/resources/audit_logs.py

@@ -1,6 +1,4 @@
-from typing import Literal, Optional, Sequence, TypedDict
-from typing_extensions import NotRequired
-
+from typing import Literal, Optional
 from workos.resources.workos_model import WorkOSModel
 
 AuditLogExportState = Literal["error", "pending", "ready"]
@@ -15,38 +13,3 @@ class AuditLogExport(WorkOSModel):
     updated_at: str
     state: AuditLogExportState
     url: Optional[str] = None
-
-
-class AuditLogEventActor(TypedDict):
-    """Describes the entity that generated the event."""
-
-    id: str
-    metadata: NotRequired[dict]
-    name: NotRequired[str]
-    type: str
-
-
-class AuditLogEventTarget(TypedDict):
-    """Describes the entity that was targeted by the event."""
-
-    id: str
-    metadata: NotRequired[dict]
-    name: NotRequired[str]
-    type: str
-
-
-class AuditLogEventContext(TypedDict):
-    """Attributes of audit log event context."""
-
-    location: str
-    user_agent: NotRequired[str]
-
-
-class AuditLogEvent(TypedDict):
-    action: str
-    version: NotRequired[int]
-    occurred_at: str  # ISO-8601 datetime of when an event occurred
-    actor: AuditLogEventActor
-    targets: Sequence[AuditLogEventTarget]
-    context: AuditLogEventContext
-    metadata: NotRequired[dict]

workos/resources/events.py

@@ -45,7 +45,6 @@
 from workos.types.user_management.invitation_common import InvitationCommon
 from workos.types.user_management.magic_auth_common import MagicAuthCommon
 from workos.types.user_management.password_reset_common import PasswordResetCommon
-from workos.typing.literals import LiteralOrUntyped
 
 EventType = Literal[
     "authentication.email_verification_succeeded",
@@ -89,6 +88,7 @@
     "user.deleted",
     "user.updated",
 ]
+
 EventTypeDiscriminator = TypeVar("EventTypeDiscriminator", bound=EventType)
 EventPayload = TypeVar(
     "EventPayload",

workos/resources/list.py

@@ -1,4 +1,5 @@
 import abc
+from pydantic import BaseModel, Field
 from typing import (
     AsyncIterator,
     Awaitable,
@@ -22,7 +23,6 @@
 from workos.resources.events import Event
 from workos.resources.mfa import AuthenticationFactor
 from workos.resources.organizations import Organization
-from pydantic import BaseModel, Field
 from workos.resources.sso import ConnectionWithDomains
 from workos.resources.user_management import Invitation, OrganizationMembership, User
 from workos.resources.workos_model import WorkOSModel

workos/resources/mfa.py

@@ -7,9 +7,6 @@
 AuthenticationFactorType = Literal[
     "generic_otp", SmsAuthenticationFactorType, TotpAuthenticationFactorType
 ]
-EnrollAuthenticationFactorType = Literal[
-    SmsAuthenticationFactorType, TotpAuthenticationFactorType
-]
 
 
 class TotpFactor(WorkOSModel):

workos/resources/passwordless.py

@@ -1,8 +1,6 @@
 from typing import Literal
 from workos.resources.workos_model import WorkOSModel
 
-PasswordlessSessionType = Literal["MagicLink"]
-
 
 class PasswordlessSession(WorkOSModel):
     """Representation of a WorkOS Passwordless Session Response."""

workos/resources/sso.py

@@ -1,9 +1,7 @@
 from typing import Literal, Sequence, Union
-
 from workos.resources.workos_model import WorkOSModel
-from workos.types.sso.connection import Connection
+from workos.types.sso.connection import Connection, ConnectionType
 from workos.typing.literals import LiteralOrUntyped
-from workos.utils.connection_types import ConnectionType
 
 
 class Profile(WorkOSModel):
@@ -39,11 +37,3 @@ class ConnectionWithDomains(Connection):
     """Representation of a Connection Response as returned by WorkOS through the SSO feature."""
 
     domains: Sequence[ConnectionDomain]
-
-
-SsoProviderType = Literal[
-    "AppleOAuth",
-    "GitHubOAuth",
-    "GoogleOAuth",
-    "MicrosoftOAuth",
-]

workos/resources/user_management.py

@@ -11,7 +11,7 @@
 from workos.types.user_management.password_reset_common import PasswordResetCommon
 
 
-PasswordHashType = Literal["bcrypt", "firebase-scrypt", "ssha"]
+OrganizationMembershipStatus = Literal["active", "inactive", "pending"]
 
 AuthenticationMethod = Literal[
     "SSO",
@@ -87,9 +87,6 @@ class OrganizationMembershipRole(TypedDict):
     slug: str
 
 
-OrganizationMembershipStatus = Literal["active", "inactive", "pending"]
-
-
 class OrganizationMembership(WorkOSModel):
     """Representation of an WorkOS Organization Membership."""
 

workos/sso.py

@@ -1,16 +1,14 @@
-from typing import Optional, Protocol, Union
-
+from typing import Literal, Optional, Protocol, Union
 import workos
 from workos.typing.sync_or_async import SyncOrAsync
 from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
 from workos.utils.pagination_order import PaginationOrder
 from workos.resources.sso import (
+    ConnectionType,
     ConnectionWithDomains,
     Profile,
     ProfileAndToken,
-    SsoProviderType,
 )
-from workos.utils.connection_types import ConnectionType
 from workos.utils.request_helper import (
     DEFAULT_LIST_RESPONSE_LIMIT,
     RESPONSE_TYPE_CODE,
@@ -35,6 +33,13 @@
 
 OAUTH_GRANT_TYPE = "authorization_code"
 
+SsoProviderType = Literal[
+    "AppleOAuth",
+    "GitHubOAuth",
+    "GoogleOAuth",
+    "MicrosoftOAuth",
+]
+
 
 class ConnectionsListFilters(ListArgs, total=False):
     connection_type: Optional[ConnectionType]

workos/types/events/connection_payload_with_legacy_fields.py

@@ -1,4 +1,3 @@
-from typing import Literal
 from workos.resources.sso import ConnectionWithDomains
 
 

workos/types/sso/connection.py

@@ -1,13 +1,48 @@
 from typing import Literal
-
 from workos.resources.workos_model import WorkOSModel
 from workos.typing.literals import LiteralOrUntyped
-from workos.utils.connection_types import ConnectionType
 
 ConnectionState = Literal[
     "active", "deleting", "inactive", "requires_type", "validating"
 ]
 
+ConnectionType = Literal[
+    "ADFSSAML",
+    "AdpOidc",
+    "AppleOAuth",
+    "Auth0SAML",
+    "AzureSAML",
+    "CasSAML",
+    "CloudflareSAML",
+    "ClassLinkSAML",
+    "CyberArkSAML",
+    "DuoSAML",
+    "GenericOIDC",
+    "GenericSAML",
+    "GitHubOAuth",
+    "GoogleOAuth",
+    "GoogleSAML",
+    "JumpCloudSAML",
+    "KeycloakSAML",
+    "LastPassSAML",
+    "LoginGovOidc",
+    "MagicLink",
+    "MicrosoftOAuth",
+    "MiniOrangeSAML",
+    "NetIqSAML",
+    "OktaSAML",
+    "OneLoginSAML",
+    "OracleSAML",
+    "PingFederateSAML",
+    "PingOneSAML",
+    "RipplingSAML",
+    "SalesforceSAML",
+    "ShibbolethGenericSAML",
+    "ShibbolethSAML",
+    "SimpleSamlPhpSAML",
+    "VMwareSAML",
+]
+
 
 class Connection(WorkOSModel):
     object: Literal["connection"]

workos/user_management.py

@@ -1,4 +1,4 @@
-from typing import Optional, Protocol, Set, Union
+from typing import Literal, Optional, Protocol, Set, Union
 
 import workos
 from workos.resources.list import (
@@ -20,14 +20,12 @@
     MagicAuth,
     OrganizationMembership,
     OrganizationMembershipStatus,
-    PasswordHashType,
     PasswordReset,
     RefreshTokenAuthenticationResponse,
     User,
 )
 from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
 from workos.utils.pagination_order import PaginationOrder
-from workos.utils.um_provider_types import UserManagementProviderType
 from workos.utils.request_helper import (
     DEFAULT_LIST_RESPONSE_LIMIT,
     RESPONSE_TYPE_CODE,
@@ -68,6 +66,12 @@
 PASSWORD_RESET_DETAIL_PATH = "user_management/password_reset/{0}"
 
 
+PasswordHashType = Literal["bcrypt", "firebase-scrypt", "ssha"]
+UserManagementProviderType = Literal[
+    "authkit", "AppleOAuth", "GitHubOAuth", "GoogleOAuth", "MicrosoftOAuth"
+]
+
+
 class UsersListFilters(ListArgs, total=False):
     email: Optional[str]
     organization_id: Optional[str]