label-studio-sdk 2.0.6__py3-none-any.whl → 2.0.8__py3-none-any.whl

label_studio_sdk/organizations/client.py

@@ -1,8 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import typing
 from ..core.client_wrapper import SyncClientWrapper
+from .invites.client import InvitesClient
 from .members.client import MembersClient
-import typing
+from .permissions.client import PermissionsClient
 from ..core.request_options import RequestOptions
 from ..types.organization_invite import OrganizationInvite
 from ..core.unchecked_base_model import construct_type
@@ -11,14 +13,31 @@ from ..core.api_error import ApiError
 from ..types.organization_id import OrganizationId
 from ..types.lse_organization import LseOrganization
 from ..core.jsonable_encoder import jsonable_encoder
+from ..errors.bad_request_error import BadRequestError
+from ..errors.forbidden_error import ForbiddenError
+from ..errors.not_found_error import NotFoundError
+import datetime as dt
+from .types.patched_default_role_request_custom_scripts_editable_by import (
+    PatchedDefaultRoleRequestCustomScriptsEditableBy,
+)
+from ..types.role9e7enum import Role9E7Enum
+from ..types.default_role import DefaultRole
+from ..core.serialization import convert_and_respect_annotation_metadata
 from ..core.client_wrapper import AsyncClientWrapper
+from .invites.client import AsyncInvitesClient
 from .members.client import AsyncMembersClient
+from .permissions.client import AsyncPermissionsClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
 
 
 class OrganizationsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.invites = InvitesClient(client_wrapper=self._client_wrapper)
         self.members = MembersClient(client_wrapper=self._client_wrapper)
+        self.permissions = PermissionsClient(client_wrapper=self._client_wrapper)
 
     def reset_token(self, *, request_options: typing.Optional[RequestOptions] = None) -> OrganizationInvite:
         """
@@ -160,11 +179,264 @@ class OrganizationsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def update(
+        self,
+        id: int,
+        *,
+        contact_info: typing.Optional[str] = OMIT,
+        created_by: typing.Optional[int] = OMIT,
+        custom_scripts_editable_by: typing.Optional[str] = OMIT,
+        custom_scripts_enabled: typing.Optional[bool] = OMIT,
+        email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        embed_domains: typing.Optional[typing.Sequence[typing.Dict[str, str]]] = OMIT,
+        embed_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        token: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> LseOrganization:
+        """
+        Update organization details including title, embed domains, and custom scripts settings.
+
+        Parameters
+        ----------
+        id : int
+
+        contact_info : typing.Optional[str]
+
+        created_by : typing.Optional[int]
+
+        custom_scripts_editable_by : typing.Optional[str]
+
+        custom_scripts_enabled : typing.Optional[bool]
+
+        email_notification_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        embed_domains : typing.Optional[typing.Sequence[typing.Dict[str, str]]]
+
+        embed_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        title : typing.Optional[str]
+
+        token : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        LseOrganization
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.organizations.update(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/organizations/{jsonable_encoder(id)}",
+            method="PATCH",
+            json={
+                "contact_info": contact_info,
+                "created_by": created_by,
+                "custom_scripts_editable_by": custom_scripts_editable_by,
+                "custom_scripts_enabled": custom_scripts_enabled,
+                "email_notification_settings": email_notification_settings,
+                "embed_domains": embed_domains,
+                "embed_settings": embed_settings,
+                "title": title,
+                "token": token,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    LseOrganization,
+                    construct_type(
+                        type_=LseOrganization,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def update_default_role(
+        self,
+        id: int,
+        *,
+        annotator_reviewer_firewall_enabled_at: typing.Optional[dt.datetime] = OMIT,
+        custom_scripts_editable_by: typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy] = OMIT,
+        custom_scripts_enabled_at: typing.Optional[dt.datetime] = OMIT,
+        default_role: typing.Optional[Role9E7Enum] = OMIT,
+        email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        embed_domains: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        embed_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        extra_data_on_activity_logs: typing.Optional[bool] = OMIT,
+        label_stream_navigation_disabled_at: typing.Optional[dt.datetime] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        read_only_quick_view_enabled_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DefaultRole:
+        """
+        Update the default role for members of a specific organization.
+
+        Parameters
+        ----------
+        id : int
+
+        annotator_reviewer_firewall_enabled_at : typing.Optional[dt.datetime]
+            Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
+
+        custom_scripts_editable_by : typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy]
+            Set the minimum user role that can edit custom scripts in the UI.
+
+            * `AD` - Administrator
+            * `MA` - Manager
+
+        custom_scripts_enabled_at : typing.Optional[dt.datetime]
+            Set to current time to enabled custom scripts for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts.
+
+        default_role : typing.Optional[Role9E7Enum]
+            Default membership role for invited users
+
+            * `OW` - Owner
+            * `AD` - Administrator
+            * `MA` - Manager
+            * `RE` - Reviewer
+            * `AN` - Annotator
+            * `DI` - Deactivated
+            * `NO` - Not Activated
+
+        email_notification_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        embed_domains : typing.Optional[typing.Optional[typing.Any]]
+
+        embed_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        external_id : typing.Optional[str]
+            External ID to uniquely identify this organization
+
+        extra_data_on_activity_logs : typing.Optional[bool]
+
+        label_stream_navigation_disabled_at : typing.Optional[dt.datetime]
+            Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
+
+        organization : typing.Optional[int]
+            A unique integer value identifying this organization.
+
+        read_only_quick_view_enabled_at : typing.Optional[dt.datetime]
+            Set to current time to prevent creating or editing annotations in quick view.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DefaultRole
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.organizations.update_default_role(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/organizations/{jsonable_encoder(id)}/set-default-role",
+            method="PATCH",
+            json={
+                "annotator_reviewer_firewall_enabled_at": annotator_reviewer_firewall_enabled_at,
+                "custom_scripts_editable_by": convert_and_respect_annotation_metadata(
+                    object_=custom_scripts_editable_by,
+                    annotation=PatchedDefaultRoleRequestCustomScriptsEditableBy,
+                    direction="write",
+                ),
+                "custom_scripts_enabled_at": custom_scripts_enabled_at,
+                "default_role": default_role,
+                "email_notification_settings": email_notification_settings,
+                "embed_domains": embed_domains,
+                "embed_settings": embed_settings,
+                "external_id": external_id,
+                "extra_data_on_activity_logs": extra_data_on_activity_logs,
+                "label_stream_navigation_disabled_at": label_stream_navigation_disabled_at,
+                "organization": organization,
+                "read_only_quick_view_enabled_at": read_only_quick_view_enabled_at,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    DefaultRole,
+                    construct_type(
+                        type_=DefaultRole,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
 
 class AsyncOrganizationsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.invites = AsyncInvitesClient(client_wrapper=self._client_wrapper)
         self.members = AsyncMembersClient(client_wrapper=self._client_wrapper)
+        self.permissions = AsyncPermissionsClient(client_wrapper=self._client_wrapper)
 
     async def reset_token(self, *, request_options: typing.Optional[RequestOptions] = None) -> OrganizationInvite:
         """
@@ -329,3 +601,270 @@ class AsyncOrganizationsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def update(
+        self,
+        id: int,
+        *,
+        contact_info: typing.Optional[str] = OMIT,
+        created_by: typing.Optional[int] = OMIT,
+        custom_scripts_editable_by: typing.Optional[str] = OMIT,
+        custom_scripts_enabled: typing.Optional[bool] = OMIT,
+        email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        embed_domains: typing.Optional[typing.Sequence[typing.Dict[str, str]]] = OMIT,
+        embed_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        token: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> LseOrganization:
+        """
+        Update organization details including title, embed domains, and custom scripts settings.
+
+        Parameters
+        ----------
+        id : int
+
+        contact_info : typing.Optional[str]
+
+        created_by : typing.Optional[int]
+
+        custom_scripts_editable_by : typing.Optional[str]
+
+        custom_scripts_enabled : typing.Optional[bool]
+
+        email_notification_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        embed_domains : typing.Optional[typing.Sequence[typing.Dict[str, str]]]
+
+        embed_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        title : typing.Optional[str]
+
+        token : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        LseOrganization
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.organizations.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/organizations/{jsonable_encoder(id)}",
+            method="PATCH",
+            json={
+                "contact_info": contact_info,
+                "created_by": created_by,
+                "custom_scripts_editable_by": custom_scripts_editable_by,
+                "custom_scripts_enabled": custom_scripts_enabled,
+                "email_notification_settings": email_notification_settings,
+                "embed_domains": embed_domains,
+                "embed_settings": embed_settings,
+                "title": title,
+                "token": token,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    LseOrganization,
+                    construct_type(
+                        type_=LseOrganization,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def update_default_role(
+        self,
+        id: int,
+        *,
+        annotator_reviewer_firewall_enabled_at: typing.Optional[dt.datetime] = OMIT,
+        custom_scripts_editable_by: typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy] = OMIT,
+        custom_scripts_enabled_at: typing.Optional[dt.datetime] = OMIT,
+        default_role: typing.Optional[Role9E7Enum] = OMIT,
+        email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        embed_domains: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        embed_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        extra_data_on_activity_logs: typing.Optional[bool] = OMIT,
+        label_stream_navigation_disabled_at: typing.Optional[dt.datetime] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        read_only_quick_view_enabled_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DefaultRole:
+        """
+        Update the default role for members of a specific organization.
+
+        Parameters
+        ----------
+        id : int
+
+        annotator_reviewer_firewall_enabled_at : typing.Optional[dt.datetime]
+            Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
+
+        custom_scripts_editable_by : typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy]
+            Set the minimum user role that can edit custom scripts in the UI.
+
+            * `AD` - Administrator
+            * `MA` - Manager
+
+        custom_scripts_enabled_at : typing.Optional[dt.datetime]
+            Set to current time to enabled custom scripts for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts.
+
+        default_role : typing.Optional[Role9E7Enum]
+            Default membership role for invited users
+
+            * `OW` - Owner
+            * `AD` - Administrator
+            * `MA` - Manager
+            * `RE` - Reviewer
+            * `AN` - Annotator
+            * `DI` - Deactivated
+            * `NO` - Not Activated
+
+        email_notification_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        embed_domains : typing.Optional[typing.Optional[typing.Any]]
+
+        embed_settings : typing.Optional[typing.Optional[typing.Any]]
+
+        external_id : typing.Optional[str]
+            External ID to uniquely identify this organization
+
+        extra_data_on_activity_logs : typing.Optional[bool]
+
+        label_stream_navigation_disabled_at : typing.Optional[dt.datetime]
+            Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
+
+        organization : typing.Optional[int]
+            A unique integer value identifying this organization.
+
+        read_only_quick_view_enabled_at : typing.Optional[dt.datetime]
+            Set to current time to prevent creating or editing annotations in quick view.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DefaultRole
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.organizations.update_default_role(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/organizations/{jsonable_encoder(id)}/set-default-role",
+            method="PATCH",
+            json={
+                "annotator_reviewer_firewall_enabled_at": annotator_reviewer_firewall_enabled_at,
+                "custom_scripts_editable_by": convert_and_respect_annotation_metadata(
+                    object_=custom_scripts_editable_by,
+                    annotation=PatchedDefaultRoleRequestCustomScriptsEditableBy,
+                    direction="write",
+                ),
+                "custom_scripts_enabled_at": custom_scripts_enabled_at,
+                "default_role": default_role,
+                "email_notification_settings": email_notification_settings,
+                "embed_domains": embed_domains,
+                "embed_settings": embed_settings,
+                "external_id": external_id,
+                "extra_data_on_activity_logs": extra_data_on_activity_logs,
+                "label_stream_navigation_disabled_at": label_stream_navigation_disabled_at,
+                "organization": organization,
+                "read_only_quick_view_enabled_at": read_only_quick_view_enabled_at,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    DefaultRole,
+                    construct_type(
+                        type_=DefaultRole,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

label_studio_sdk/organizations/invites/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+