label-studio-sdk 2.0.2__py3-none-any.whl → 2.0.3__py3-none-any.whl

label_studio_sdk/sso/saml/client.py

@@ -0,0 +1,278 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...core.client_wrapper import SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.saml_settings import SamlSettings
+from ...core.unchecked_base_model import construct_type
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
+from ...types.project_group_request import ProjectGroupRequest
+from ...types.saml_settings_update import SamlSettingsUpdate
+from ...core.serialization import convert_and_respect_annotation_metadata
+from ...core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SamlClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SamlSettings:
+        """
+        Retrieve SAML2 settings for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SamlSettings
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.sso.saml.get()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/saml/settings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SamlSettings,
+                    construct_type(
+                        type_=SamlSettings,  # 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(
+        self,
+        *,
+        projects_groups: typing.Optional[typing.Sequence[ProjectGroupRequest]] = OMIT,
+        roles_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        workspaces_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SamlSettingsUpdate:
+        """
+        Update SAML2 settings for the currently active organization.
+
+        Parameters
+        ----------
+        projects_groups : typing.Optional[typing.Sequence[ProjectGroupRequest]]
+
+        roles_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        workspaces_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SamlSettingsUpdate
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio, ProjectGroupRequest
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.sso.saml.update(
+            projects_groups=[
+                ProjectGroupRequest(
+                    group="groups_test",
+                    project_id=42,
+                    role="Inherit",
+                )
+            ],
+            roles_groups=[["Administrator", "groups_test"]],
+            workspaces_groups=[["Default workspace", "groups_test"]],
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/saml/settings",
+            method="POST",
+            json={
+                "projects_groups": convert_and_respect_annotation_metadata(
+                    object_=projects_groups, annotation=typing.Sequence[ProjectGroupRequest], direction="write"
+                ),
+                "roles_groups": roles_groups,
+                "workspaces_groups": workspaces_groups,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SamlSettingsUpdate,
+                    construct_type(
+                        type_=SamlSettingsUpdate,  # 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 AsyncSamlClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SamlSettings:
+        """
+        Retrieve SAML2 settings for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SamlSettings
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.sso.saml.get()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/saml/settings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SamlSettings,
+                    construct_type(
+                        type_=SamlSettings,  # 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(
+        self,
+        *,
+        projects_groups: typing.Optional[typing.Sequence[ProjectGroupRequest]] = OMIT,
+        roles_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        workspaces_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SamlSettingsUpdate:
+        """
+        Update SAML2 settings for the currently active organization.
+
+        Parameters
+        ----------
+        projects_groups : typing.Optional[typing.Sequence[ProjectGroupRequest]]
+
+        roles_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        workspaces_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SamlSettingsUpdate
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio, ProjectGroupRequest
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.sso.saml.update(
+                projects_groups=[
+                    ProjectGroupRequest(
+                        group="groups_test",
+                        project_id=42,
+                        role="Inherit",
+                    )
+                ],
+                roles_groups=[["Administrator", "groups_test"]],
+                workspaces_groups=[["Default workspace", "groups_test"]],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/saml/settings",
+            method="POST",
+            json={
+                "projects_groups": convert_and_respect_annotation_metadata(
+                    object_=projects_groups, annotation=typing.Sequence[ProjectGroupRequest], direction="write"
+                ),
+                "roles_groups": roles_groups,
+                "workspaces_groups": workspaces_groups,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SamlSettingsUpdate,
+                    construct_type(
+                        type_=SamlSettingsUpdate,  # 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/sso/scim/__init__.py

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

label_studio_sdk/sso/scim/client.py

@@ -0,0 +1,278 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...core.client_wrapper import SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.scim_settings import ScimSettings
+from ...core.unchecked_base_model import construct_type
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
+from ...types.project_group_request import ProjectGroupRequest
+from ...types.scim_settings_update import ScimSettingsUpdate
+from ...core.serialization import convert_and_respect_annotation_metadata
+from ...core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class ScimClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> ScimSettings:
+        """
+        Retrieve SCIM settings for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ScimSettings
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.sso.scim.get()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/scim/settings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    ScimSettings,
+                    construct_type(
+                        type_=ScimSettings,  # 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(
+        self,
+        *,
+        projects_groups: typing.Optional[typing.Sequence[ProjectGroupRequest]] = OMIT,
+        roles_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        workspaces_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ScimSettingsUpdate:
+        """
+        Update SCIM settings for the currently active organization.
+
+        Parameters
+        ----------
+        projects_groups : typing.Optional[typing.Sequence[ProjectGroupRequest]]
+
+        roles_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        workspaces_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ScimSettingsUpdate
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio, ProjectGroupRequest
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.sso.scim.update(
+            projects_groups=[
+                ProjectGroupRequest(
+                    group="groups_test",
+                    project_id=42,
+                    role="Inherit",
+                )
+            ],
+            roles_groups=[["Administrator", "groups_test"]],
+            workspaces_groups=[["Default workspace", "groups_test"]],
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/scim/settings",
+            method="POST",
+            json={
+                "projects_groups": convert_and_respect_annotation_metadata(
+                    object_=projects_groups, annotation=typing.Sequence[ProjectGroupRequest], direction="write"
+                ),
+                "roles_groups": roles_groups,
+                "workspaces_groups": workspaces_groups,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    ScimSettingsUpdate,
+                    construct_type(
+                        type_=ScimSettingsUpdate,  # 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 AsyncScimClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> ScimSettings:
+        """
+        Retrieve SCIM settings for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ScimSettings
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.sso.scim.get()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/scim/settings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    ScimSettings,
+                    construct_type(
+                        type_=ScimSettings,  # 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(
+        self,
+        *,
+        projects_groups: typing.Optional[typing.Sequence[ProjectGroupRequest]] = OMIT,
+        roles_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        workspaces_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ScimSettingsUpdate:
+        """
+        Update SCIM settings for the currently active organization.
+
+        Parameters
+        ----------
+        projects_groups : typing.Optional[typing.Sequence[ProjectGroupRequest]]
+
+        roles_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        workspaces_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ScimSettingsUpdate
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio, ProjectGroupRequest
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.sso.scim.update(
+                projects_groups=[
+                    ProjectGroupRequest(
+                        group="groups_test",
+                        project_id=42,
+                        role="Inherit",
+                    )
+                ],
+                roles_groups=[["Administrator", "groups_test"]],
+                workspaces_groups=[["Default workspace", "groups_test"]],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/scim/settings",
+            method="POST",
+            json={
+                "projects_groups": convert_and_respect_annotation_metadata(
+                    object_=projects_groups, annotation=typing.Sequence[ProjectGroupRequest], direction="write"
+                ),
+                "roles_groups": roles_groups,
+                "workspaces_groups": workspaces_groups,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    ScimSettingsUpdate,
+                    construct_type(
+                        type_=ScimSettingsUpdate,  # 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/types/__init__.py

@@ -124,6 +124,9 @@ from .pause_request import PauseRequest
 from .prediction import Prediction
 from .prediction_request import PredictionRequest
 from .project import Project
+from .project_group import ProjectGroup
+from .project_group_request import ProjectGroupRequest
+from .project_group_role_enum import ProjectGroupRoleEnum
 from .project_import import ProjectImport
 from .project_label_config import ProjectLabelConfig
 from .project_label_config_request import ProjectLabelConfigRequest
@@ -149,7 +152,11 @@ from .role9e7enum import Role9E7Enum
 from .role_based_task import RoleBasedTask
 from .s3export_storage import S3ExportStorage
 from .s3import_storage import S3ImportStorage
+from .saml_settings import SamlSettings
+from .saml_settings_update import SamlSettingsUpdate
 from .sampling_enum import SamplingEnum
+from .scim_settings import ScimSettings
+from .scim_settings_update import ScimSettingsUpdate
 from .scope_enum import ScopeEnum
 from .selected_items_request import SelectedItemsRequest
 from .serialization_option import SerializationOption
@@ -302,6 +309,9 @@ __all__ = [
     "Prediction",
     "PredictionRequest",
     "Project",
+    "ProjectGroup",
+    "ProjectGroupRequest",
+    "ProjectGroupRoleEnum",
     "ProjectImport",
     "ProjectLabelConfig",
     "ProjectLabelConfigRequest",
@@ -327,7 +337,11 @@ __all__ = [
     "RoleBasedTask",
     "S3ExportStorage",
     "S3ImportStorage",
+    "SamlSettings",
+    "SamlSettingsUpdate",
     "SamplingEnum",
+    "ScimSettings",
+    "ScimSettingsUpdate",
     "ScopeEnum",
     "SelectedItemsRequest",
     "SerializationOption",

label_studio_sdk/types/project_group.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .project_group_role_enum import ProjectGroupRoleEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class ProjectGroup(UncheckedBaseModel):
+    group: str
+    project_id: int
+    role: ProjectGroupRoleEnum
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/project_group_request.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .project_group_role_enum import ProjectGroupRoleEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class ProjectGroupRequest(UncheckedBaseModel):
+    group: str
+    project_id: int
+    role: ProjectGroupRoleEnum
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/project_group_role_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProjectGroupRoleEnum = typing.Union[typing.Literal["Inherit", "Annotator", "Reviewer"], typing.Any]

label_studio_sdk/types/saml_settings.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class SamlSettings(UncheckedBaseModel):
+    projects_groups: typing.Optional[typing.Optional[typing.Any]] = None
+    roles_groups: typing.Optional[typing.Optional[typing.Any]] = None
+    workspaces_groups: typing.Optional[typing.Optional[typing.Any]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/saml_settings_update.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .project_group import ProjectGroup
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class SamlSettingsUpdate(UncheckedBaseModel):
+    projects_groups: typing.Optional[typing.List[ProjectGroup]] = None
+    roles_groups: typing.Optional[typing.List[typing.List[str]]] = None
+    workspaces_groups: typing.Optional[typing.List[typing.List[str]]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow