workos 5.24.0__py3-none-any.whl → 5.26.0__py3-none-any.whl

workos/__about__.py

@@ -12,7 +12,7 @@ __package_name__ = "workos"
 
 __package_url__ = "https://github.com/workos-inc/workos-python"
 
-__version__ = "5.24.0"
+__version__ = "5.26.0"
 
 __author__ = "WorkOS"
 

workos/_base_client.py

@@ -11,6 +11,7 @@ from workos.directory_sync import DirectorySyncModule
 from workos.events import EventsModule
 from workos.mfa import MFAModule
 from workos.organizations import OrganizationsModule
+from workos.organization_domains import OrganizationDomainsModule
 from workos.passwordless import PasswordlessModule
 from workos.portal import PortalModule
 from workos.sso import SSOModule
@@ -88,6 +89,10 @@ class BaseClient(ClientConfiguration):
     @abstractmethod
     def organizations(self) -> OrganizationsModule: ...
 
+    @property
+    @abstractmethod
+    def organization_domains(self) -> OrganizationDomainsModule: ...
+
     @property
     @abstractmethod
     def passwordless(self) -> PasswordlessModule: ...

workos/async_client.py

@@ -7,6 +7,7 @@ from workos.events import AsyncEvents
 from workos.fga import FGAModule
 from workos.mfa import MFAModule
 from workos.organizations import AsyncOrganizations
+from workos.organization_domains import AsyncOrganizationDomains
 from workos.passwordless import PasswordlessModule
 from workos.portal import PortalModule
 from workos.sso import AsyncSSO
@@ -80,6 +81,14 @@ class AsyncClient(BaseClient):
             self._organizations = AsyncOrganizations(self._http_client)
         return self._organizations
 
+    @property
+    def organization_domains(self) -> AsyncOrganizationDomains:
+        if not getattr(self, "_organization_domains", None):
+            self._organization_domains = AsyncOrganizationDomains(
+                http_client=self._http_client, client_configuration=self
+            )
+        return self._organization_domains
+
     @property
     def passwordless(self) -> PasswordlessModule:
         raise NotImplementedError(

workos/client.py

@@ -5,6 +5,7 @@ from workos.audit_logs import AuditLogs
 from workos.directory_sync import DirectorySync
 from workos.fga import FGA
 from workos.organizations import Organizations
+from workos.organization_domains import OrganizationDomains
 from workos.passwordless import Passwordless
 from workos.portal import Portal
 from workos.sso import SSO
@@ -80,6 +81,14 @@ class SyncClient(BaseClient):
             self._organizations = Organizations(self._http_client)
         return self._organizations
 
+    @property
+    def organization_domains(self) -> OrganizationDomains:
+        if not getattr(self, "_organization_domains", None):
+            self._organization_domains = OrganizationDomains(
+                http_client=self._http_client, client_configuration=self
+            )
+        return self._organization_domains
+
     @property
     def passwordless(self) -> Passwordless:
         if not getattr(self, "_passwordless", None):

workos/organization_domains.py

@@ -0,0 +1,179 @@
+from typing import Protocol
+from workos._client_configuration import ClientConfiguration
+from workos.types.organization_domains import OrganizationDomain
+from workos.typing.sync_or_async import SyncOrAsync
+from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
+from workos.utils.request_helper import (
+    REQUEST_METHOD_DELETE,
+    REQUEST_METHOD_GET,
+    REQUEST_METHOD_POST,
+)
+
+
+class OrganizationDomainsModule(Protocol):
+    """Offers methods for managing organization domains."""
+
+    _client_configuration: ClientConfiguration
+
+    def get_organization_domain(
+        self, organization_domain_id: str
+    ) -> SyncOrAsync[OrganizationDomain]:
+        """Gets a single Organization Domain
+
+        Args:
+            organization_domain_id (str): Organization Domain unique identifier
+
+        Returns:
+            OrganizationDomain: Organization Domain response from WorkOS
+        """
+        ...
+
+    def create_organization_domain(
+        self,
+        organization_id: str,
+        domain: str,
+    ) -> SyncOrAsync[OrganizationDomain]:
+        """Creates an Organization Domain
+
+        Args:
+            organization_id (str): Organization unique identifier
+            domain (str): Domain to be added to the organization
+
+        Returns:
+            OrganizationDomain: Organization Domain response from WorkOS
+        """
+        ...
+
+    def verify_organization_domain(
+        self, organization_domain_id: str
+    ) -> SyncOrAsync[OrganizationDomain]:
+        """Verifies an Organization Domain
+
+        Args:
+            organization_domain_id (str): Organization Domain unique identifier
+
+        Returns:
+            OrganizationDomain: Organization Domain response from WorkOS
+        """
+        ...
+
+    def delete_organization_domain(
+        self, organization_domain_id: str
+    ) -> SyncOrAsync[None]:
+        """Deletes a single Organization Domain
+
+        Args:
+            organization_domain_id (str): Organization Domain unique identifier
+
+        Returns:
+            None
+        """
+        ...
+
+
+class OrganizationDomains:
+    """Offers methods for managing organization domains."""
+
+    _http_client: SyncHTTPClient
+    _client_configuration: ClientConfiguration
+
+    def __init__(
+        self,
+        http_client: SyncHTTPClient,
+        client_configuration: ClientConfiguration,
+    ):
+        self._http_client = http_client
+        self._client_configuration = client_configuration
+
+    def get_organization_domain(
+        self, organization_domain_id: str
+    ) -> OrganizationDomain:
+        response = self._http_client.request(
+            f"organization_domains/{organization_domain_id}",
+            method=REQUEST_METHOD_GET,
+        )
+
+        return OrganizationDomain.model_validate(response)
+
+    def create_organization_domain(
+        self,
+        organization_id: str,
+        domain: str,
+    ) -> OrganizationDomain:
+        response = self._http_client.request(
+            "organization_domains",
+            method=REQUEST_METHOD_POST,
+            json={"organization_id": organization_id, "domain": domain},
+        )
+
+        return OrganizationDomain.model_validate(response)
+
+    def verify_organization_domain(
+        self, organization_domain_id: str
+    ) -> OrganizationDomain:
+        response = self._http_client.request(
+            f"organization_domains/{organization_domain_id}/verify",
+            method=REQUEST_METHOD_POST,
+        )
+
+        return OrganizationDomain.model_validate(response)
+
+    def delete_organization_domain(self, organization_domain_id: str) -> None:
+        self._http_client.request(
+            f"organization_domains/{organization_domain_id}",
+            method=REQUEST_METHOD_DELETE,
+        )
+
+
+class AsyncOrganizationDomains:
+    """Offers async methods for managing organization domains."""
+
+    _http_client: AsyncHTTPClient
+    _client_configuration: ClientConfiguration
+
+    def __init__(
+        self,
+        http_client: AsyncHTTPClient,
+        client_configuration: ClientConfiguration,
+    ):
+        self._http_client = http_client
+        self._client_configuration = client_configuration
+
+    async def get_organization_domain(
+        self, organization_domain_id: str
+    ) -> OrganizationDomain:
+        response = await self._http_client.request(
+            f"organization_domains/{organization_domain_id}",
+            method=REQUEST_METHOD_GET,
+        )
+
+        return OrganizationDomain.model_validate(response)
+
+    async def create_organization_domain(
+        self,
+        organization_id: str,
+        domain: str,
+    ) -> OrganizationDomain:
+        response = await self._http_client.request(
+            "organization_domains",
+            method=REQUEST_METHOD_POST,
+            json={"organization_id": organization_id, "domain": domain},
+        )
+
+        return OrganizationDomain.model_validate(response)
+
+    async def verify_organization_domain(
+        self, organization_domain_id: str
+    ) -> OrganizationDomain:
+        response = await self._http_client.request(
+            f"organization_domains/{organization_domain_id}/verify",
+            method=REQUEST_METHOD_POST,
+        )
+
+        return OrganizationDomain.model_validate(response)
+
+    async def delete_organization_domain(self, organization_domain_id: str) -> None:
+        await self._http_client.request(
+            f"organization_domains/{organization_domain_id}",
+            method=REQUEST_METHOD_DELETE,
+        )

workos/types/events/event.py

@@ -38,7 +38,7 @@ from workos.types.events.organization_domain_verification_failed_payload import
 )
 from workos.types.events.session_created_payload import SessionCreatedPayload
 from workos.types.organizations.organization_common import OrganizationCommon
-from workos.types.organizations.organization_domain import OrganizationDomain
+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 (

workos/types/events/event_model.py

@@ -37,7 +37,7 @@ from workos.types.events.organization_domain_verification_failed_payload import
 )
 from workos.types.events.session_created_payload import SessionCreatedPayload
 from workos.types.organizations.organization_common import OrganizationCommon
-from workos.types.organizations.organization_domain import OrganizationDomain
+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 (

workos/types/events/organization_domain_verification_failed_payload.py

@@ -1,6 +1,6 @@
 from typing import Literal
 from workos.types.workos_model import WorkOSModel
-from workos.types.organizations.organization_domain import OrganizationDomain
+from workos.types.organization_domains import OrganizationDomain
 from workos.typing.literals import LiteralOrUntyped
 
 

workos/types/organization_domains/__init__.py

@@ -0,0 +1 @@
+from .organization_domain import *

workos/types/organizations/__init__.py

@@ -1,4 +1,6 @@
 from .domain_data_input import *
 from .organization_common import *
-from .organization_domain import *
 from .organization import *
+
+# re-exported for backwards compatibility, can be removed after version 6.0.0
+from workos.types.organization_domains import OrganizationDomain

workos/types/organizations/organization.py

@@ -2,7 +2,7 @@ from dataclasses import field
 from typing import Optional, Sequence
 from workos.types.metadata import Metadata
 from workos.types.organizations.organization_common import OrganizationCommon
-from workos.types.organizations.organization_domain import OrganizationDomain
+from workos.types.organization_domains import OrganizationDomain
 
 
 class Organization(OrganizationCommon):

workos/types/organizations/organization_common.py

@@ -1,6 +1,6 @@
 from typing import Literal, Sequence
 from workos.types.workos_model import WorkOSModel
-from workos.types.organizations.organization_domain import OrganizationDomain
+from workos.types.organization_domains import OrganizationDomain
 
 
 class OrganizationCommon(WorkOSModel):

workos/types/webhooks/webhook.py

@@ -38,7 +38,7 @@ from workos.types.events.organization_domain_verification_failed_payload import
 )
 from workos.types.events.session_created_payload import SessionCreatedPayload
 from workos.types.organizations.organization_common import OrganizationCommon
-from workos.types.organizations.organization_domain import OrganizationDomain
+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 (

{workos-5.24.0.dist-info → workos-5.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: workos
-Version: 5.24.0
+Version: 5.26.0
 Summary: WorkOS Python Client
 Home-page: https://github.com/workos-inc/workos-python
 Author: WorkOS

{workos-5.24.0.dist-info → workos-5.26.0.dist-info}/RECORD

@@ -1,15 +1,16 @@
-workos/__about__.py,sha256=1NsUDPAjsrwknBlghnN-xITmyO39Ieog8l72kRbopYw,406
+workos/__about__.py,sha256=XjdHlLqPEJ0a5evP3CCUorp0ckGip4qzzY2V8gM6xXg,406
 workos/__init__.py,sha256=hOdbO_MJCvpLx8EbRjQg-fvFAB-glJmrmxUZK8kWG0k,167
-workos/_base_client.py,sha256=t69Nb3zxo3wygI3JtbPdZMGvIuRPsZx_xZANC5K8dn8,3429
+workos/_base_client.py,sha256=YWLXBpd0YeID3WKYZkKa4l9ZuB9e6HgdLmPKZIzXsME,3599
 workos/_client_configuration.py,sha256=g3eXhtrEMN6CW0hZ5uHb2PmLurXjyBkWZeQYMPeJD6s,222
-workos/async_client.py,sha256=JTZwKTN7YqPEScXPh-RmBHCs_glPo2LLfMHXhyBJuak,3957
+workos/async_client.py,sha256=c_lP7y49k3FEx0S6We8PrEw3PhTkD0VHyHJaKgc51HU,4358
 workos/audit_logs.py,sha256=bYoAoNO4FRSaT34UxiVkgTXCVH8givcS2YGhH_9O3NA,3983
-workos/client.py,sha256=jvqccyHJWf302ugopj9mt-IidkWBt_r8jihP0IZ4RUI,3959
+workos/client.py,sha256=hIm87iNtKfwQ93H5aRXnhTqUJIOzUEG1GX0jdLBLAYc,4345
 workos/directory_sync.py,sha256=6Z1gHz1LWNy56EtkXwNm6jhRRcvsJ7ASeDLy_Q1oKM0,14601
 workos/events.py,sha256=b4JIzMbd5LlVtpOMKVojC70RCHAgmLN3nJ62_2U0GwI,3892
 workos/exceptions.py,sha256=eoy-T4We98HKZn0UZu33fPzhm4DwafzwLeg3juhC6FE,1732
 workos/fga.py,sha256=qjZrdkXKwJDLVTMMrOADxyXRDkswto4kGIdtTjtS3hw,21008
 workos/mfa.py,sha256=J8eOr4ZEmK0TPFKD7pabSalgCFCyg3XJY1stu28_8Vw,6862
+workos/organization_domains.py,sha256=um-dm54SIs2Kd2FxqxVjIlynlenAG9NamQmNVUGOQ0k,5464
 workos/organizations.py,sha256=ugPRhwN8cN2O6qOCf7wj8Wus-oeRKXlNe2642PSl_n4,12266
 workos/passwordless.py,sha256=NGXDoxomBkrIml8-VHXH1HvCFMqotQ-YhRobUQXpVZs,3203
 workos/portal.py,sha256=lzf3fnOor4AyVdHCHMuJzVSpAC9LWWdC5sZIRtCsb0c,2443
@@ -46,11 +47,11 @@ workos/types/events/directory_group_with_previous_attributes.py,sha256=13VLNhdJZ
 workos/types/events/directory_payload.py,sha256=tRo3f9g8VoYertSUPAR25iGDyGLr2Dtb2mTkl73PAeA,503
 workos/types/events/directory_payload_with_legacy_fields.py,sha256=jk9nLmRqgllVkBG4EU3uTgcDOhCNptHgCh93U7aBAYE,1005
 workos/types/events/directory_user_with_previous_attributes.py,sha256=PhnO3WakBxAvnlOGf0UB0bvoppUYlwLyU-g9X_pPdko,244
-workos/types/events/event.py,sha256=PDUTGaYlxwMkVKRhj82XMVxfrYzpWVlkQRCRNq-mxlM,9830
-workos/types/events/event_model.py,sha256=r5B_lZ7QXgoI7SGyQF7xNaEEE-ATMRet83pMYYJANuo,3735
+workos/types/events/event.py,sha256=4E-71v38J1Udt0qFz9k17V6HmNj9Lgz-mmS-524ysIs,9817
+workos/types/events/event_model.py,sha256=TuCRgjgTWnTvwL3NTR9FBGuF7WO34OhsbtMGKss5QKA,3722
 workos/types/events/event_type.py,sha256=NIVHMahETiKeFJfZGi-ptHQH7czmRY4tChnuMU0OxWw,1690
 workos/types/events/list_filters.py,sha256=P04zmRynx9VPqNX_MBXA-3KA6flPZJogtIUqTI7w9Eg,305
-workos/types/events/organization_domain_verification_failed_payload.py,sha256=26reKTFxdriOo6fF6MVkYx0s867E-bproKTbwLZcUpE,483
+workos/types/events/organization_domain_verification_failed_payload.py,sha256=b4wX8HVbL9Nx6fCjOXkZg9eLc-Bv6YqAjMap1f7UvFc,470
 workos/types/events/previous_attributes.py,sha256=DxolwLwzcnG8r_W6rh5BT29iDfSVsIELvRYJ0NCrNn0,72
 workos/types/events/session_created_payload.py,sha256=F4eKjmetgyRIluNBDUmB2OXq8hDWEVjALJ4rrT2IHJs,462
 workos/types/fga/__init__.py,sha256=mVb3gvhvK93PAosSgO1RlNmxYX4zIxVDcZZQ8Jyejuw,151
@@ -66,12 +67,13 @@ workos/types/mfa/authentication_challenge_verification_response.py,sha256=5HxsMJ
 workos/types/mfa/authentication_factor.py,sha256=92Cq9MLwBUXfowzCv2u9ZnoH9tVgDm16jjmelN7BOGs,2021
 workos/types/mfa/authentication_factor_totp_and_challenge_response.py,sha256=Ix_DqF7eQ-x6Up8C_0wzvAXXyDY876nobRuiXXL8nbc,541
 workos/types/mfa/enroll_authentication_factor_type.py,sha256=l_w4co5BdmfglII5YAQiyL-kdAw8KiiOsYaDhn8lGWE,227
-workos/types/organizations/__init__.py,sha256=tS8oObLGCyk2QnaMtoaaGKoLbbzSylL_8qovsPF6Rqc,131
+workos/types/organization_domains/__init__.py,sha256=fpNRKfzZ0p1FybwQG4L-YY12nFPTCJjD4j60OJI5fXE,35
+workos/types/organization_domains/organization_domain.py,sha256=PkmdVVQi6h94xHWLJt0SFGgiGEVoyxwiPD-WwQ1naWs,614
+workos/types/organizations/__init__.py,sha256=uE2qD2MOebPs-_BerqenTqmu4I4DI5-CKIY_M8BGwDY,240
 workos/types/organizations/domain_data_input.py,sha256=BW3iYswF-b2SXip7jwPkmlZhgLReS_VyzUlU8PD4xdw,161
 workos/types/organizations/list_filters.py,sha256=u-TsEEMVI8IvPvxn_9--k6iYDs4T64RHTY_HY0Fvwlw,179
-workos/types/organizations/organization.py,sha256=GNs7Mf4-B4NpKSsE4uD9106kG6e6yz2EImdgSw9X310,533
-workos/types/organizations/organization_common.py,sha256=HFrXwia3xV6KkAAfW6zyMcjxXrznv82hFajHVHZdhpM,350
-workos/types/organizations/organization_domain.py,sha256=PkmdVVQi6h94xHWLJt0SFGgiGEVoyxwiPD-WwQ1naWs,614
+workos/types/organizations/organization.py,sha256=oVGg-C0blizg7aGVeRTr3vvTRvrn_WPzwaV-LvbQxRo,520
+workos/types/organizations/organization_common.py,sha256=lelq-Id9AGSmosFprFAET_QyXmYR0wHX9-XMsOTEr7s,337
 workos/types/passwordless/__init__.py,sha256=ZP_XIcGUKXsATb--bfesnsFFbbvg3WYzgqRC_qvW0rw,77
 workos/types/passwordless/passwordless_session.py,sha256=izmTI5F7qvBdoVodaXP7fnYo_XodG-ygyYTPrCEObTM,293
 workos/types/passwordless/passwordless_session_type.py,sha256=ltZAV8KFiYDVcxpVt5Hcdc089tB5VETYaa9X6E7Mvoo,75
@@ -106,7 +108,7 @@ workos/types/vault/__init__.py,sha256=krBuIl8luysrtDf9-b8KTkXOHDOaSsOR-Aao6Wlil0
 workos/types/vault/key.py,sha256=x30XBplSj9AviDDAB8MdpcULbZvvo2sUzi8RCmZQKxU,453
 workos/types/vault/object.py,sha256=-rk4KovS3eT8T8L3JltYUS0cd2Rg1JKcAX9SOaZO3D8,664
 workos/types/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-workos/types/webhooks/webhook.py,sha256=IIDhlGTwiNm3xEncSk-OYm0EZsxwXmxDT5_jKx_Bt60,9523
+workos/types/webhooks/webhook.py,sha256=v0Z7Z1eMnjCMR8iWm2KNECv-8nwPdTB8gTZCVfFP0O0,9510
 workos/types/webhooks/webhook_model.py,sha256=v7Hgtzt0nW_5RaYoB_QGVfElhdjySuG3F1BFjoid36w,404
 workos/types/webhooks/webhook_payload.py,sha256=GXt31KtyBM-ji5K5p4dBnu46Gh8adQWTq0ye5USB_6g,68
 workos/types/widgets/__init__.py,sha256=z2Tdlj_bJsRZeJRh4SOFX58PvJdf0LjKnYhrQX1fpME,65
@@ -123,8 +125,8 @@ workos/utils/crypto_provider.py,sha256=QeQSR4t9xLlb90kEfl8onVUsf1yCkYq0EjFTxK0mU
 workos/utils/http_client.py,sha256=TM5yMFFExmAE8D2Z43-5O301tRbnylLG0aXO0isGorE,6197
 workos/utils/pagination_order.py,sha256=_-et1DDJLG0czarTU7op4W6RA0V1f85GNsUgtyRU55Q,70
 workos/utils/request_helper.py,sha256=NaO16qPPbSNnCeE0fiNKYb8gM-dK_okYVJbLGrEGXz8,793
-workos-5.24.0.dist-info/LICENSE,sha256=mU--WL1JzelH2tXpKVoOlpud4cpqKSRTtdArCvYZmb4,1063
-workos-5.24.0.dist-info/METADATA,sha256=7uWspjP8xJKGOnVXxi5BPXCpCwQAGy1pUQlrWMGVMPg,4187
-workos-5.24.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-workos-5.24.0.dist-info/top_level.txt,sha256=ZFskIfue1Tw-JwjyIXRvdsAl9i0DX9VbqmgICXV84Sk,7
-workos-5.24.0.dist-info/RECORD,,
+workos-5.26.0.dist-info/LICENSE,sha256=mU--WL1JzelH2tXpKVoOlpud4cpqKSRTtdArCvYZmb4,1063
+workos-5.26.0.dist-info/METADATA,sha256=MohK6HHQVDsilcCLtEwsSRF_ufiHMGCe1puhiVakL60,4187
+workos-5.26.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+workos-5.26.0.dist-info/top_level.txt,sha256=ZFskIfue1Tw-JwjyIXRvdsAl9i0DX9VbqmgICXV84Sk,7
+workos-5.26.0.dist-info/RECORD,,