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

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
@@ -175,6 +182,10 @@ from .version_response import VersionResponse
 from .view import View
 from .webhook import Webhook
 from .webhook_serializer_for_update import WebhookSerializerForUpdate
+from .who_am_i_lse_fields import WhoAmILseFields
+from .who_am_i_lse_fields_onboarding_state import WhoAmILseFieldsOnboardingState
+from .who_am_i_lse_fields_trial_role import WhoAmILseFieldsTrialRole
+from .who_am_i_user import WhoAmIUser
 from .workspace import Workspace
 from .workspace_member_create import WorkspaceMemberCreate
 from .workspace_member_list import WorkspaceMemberList
@@ -302,6 +313,9 @@ __all__ = [
     "Prediction",
     "PredictionRequest",
     "Project",
+    "ProjectGroup",
+    "ProjectGroupRequest",
+    "ProjectGroupRoleEnum",
     "ProjectImport",
     "ProjectLabelConfig",
     "ProjectLabelConfigRequest",
@@ -327,7 +341,11 @@ __all__ = [
     "RoleBasedTask",
     "S3ExportStorage",
     "S3ImportStorage",
+    "SamlSettings",
+    "SamlSettingsUpdate",
     "SamplingEnum",
+    "ScimSettings",
+    "ScimSettingsUpdate",
     "ScopeEnum",
     "SelectedItemsRequest",
     "SerializationOption",
@@ -353,6 +371,10 @@ __all__ = [
     "View",
     "Webhook",
     "WebhookSerializerForUpdate",
+    "WhoAmILseFields",
+    "WhoAmILseFieldsOnboardingState",
+    "WhoAmILseFieldsTrialRole",
+    "WhoAmIUser",
     "Workspace",
     "WorkspaceMemberCreate",
     "WorkspaceMemberList",

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

label_studio_sdk/types/scim_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 ScimSettings(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/scim_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 ScimSettingsUpdate(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

label_studio_sdk/types/who_am_i_lse_fields.py

@@ -0,0 +1,50 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import datetime as dt
+from .who_am_i_lse_fields_onboarding_state import WhoAmILseFieldsOnboardingState
+import pydantic
+from .who_am_i_lse_fields_trial_role import WhoAmILseFieldsTrialRole
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class WhoAmILseFields(UncheckedBaseModel):
+    active_organization_external_id: typing.Optional[str] = None
+    email_notification_settings: str
+    invite_activated: typing.Optional[bool] = None
+    invite_expired: str
+    invite_expired_at: str
+    invited_at: typing.Optional[dt.datetime] = None
+    invited_by: typing.Optional[int] = None
+    onboarding_state: typing.Optional[WhoAmILseFieldsOnboardingState] = pydantic.Field(default=None)
+    """
+    The current stage of user onboarding
+    
+    * `not_started` - Not Started
+    * `signup` - Signup
+    * `trial_signup` - Trial Signup
+    * `first_tutorial` - First Tutorial
+    * `in_app_guidance` - In App Guidance
+    * `complete` - Complete
+    """
+
+    social_auth_finished: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Is user finished social authentication
+    """
+
+    trial_company: typing.Optional[str] = None
+    trial_experience_labeling: typing.Optional[str] = None
+    trial_license_enterprise: typing.Optional[bool] = None
+    trial_models_in_production: typing.Optional[str] = None
+    trial_role: typing.Optional[WhoAmILseFieldsTrialRole] = 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/who_am_i_lse_fields_onboarding_state.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .onboarding_state_enum import OnboardingStateEnum
+from .blank_enum import BlankEnum
+from .null_enum import NullEnum
+
+WhoAmILseFieldsOnboardingState = typing.Union[OnboardingStateEnum, BlankEnum, NullEnum]

label_studio_sdk/types/who_am_i_lse_fields_trial_role.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .trial_role_enum import TrialRoleEnum
+from .blank_enum import BlankEnum
+from .null_enum import NullEnum
+
+WhoAmILseFieldsTrialRole = typing.Union[TrialRoleEnum, BlankEnum, NullEnum]

label_studio_sdk/types/who_am_i_user.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+import datetime as dt
+from .who_am_i_lse_fields import WhoAmILseFields
+from .organization_membership import OrganizationMembership
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class WhoAmIUser(UncheckedBaseModel):
+    """
+    A ModelSerializer that takes additional arguments for
+    "fields", "omit" and "expand" in order to
+    control which fields are displayed, and whether to replace simple
+    values with complex, nested serializations
+    """
+
+    active_organization: typing.Optional[int] = None
+    active_organization_meta: str
+    allow_newsletters: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow sending newsletters to user
+    """
+
+    avatar: str
+    custom_hotkeys: typing.Optional[typing.Optional[typing.Any]] = None
+    date_joined: typing.Optional[dt.datetime] = None
+    email: typing.Optional[str] = None
+    first_name: typing.Optional[str] = None
+    id: int
+    initials: str
+    last_activity: dt.datetime
+    last_name: typing.Optional[str] = None
+    lse_fields: WhoAmILseFields
+    org_membership: typing.List[OrganizationMembership]
+    pause: str
+    phone: typing.Optional[str] = None
+    username: str
+
+    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/users/client.py

@@ -11,6 +11,7 @@ import datetime as dt
 from ..types.hotkeys import Hotkeys
 from .types.users_reset_token_response import UsersResetTokenResponse
 from .types.users_get_token_response import UsersGetTokenResponse
+from ..types.who_am_i_user import WhoAmIUser
 from ..types.lse_user import LseUser
 from ..core.jsonable_encoder import jsonable_encoder
 from ..core.client_wrapper import AsyncClientWrapper
@@ -348,7 +349,7 @@ class UsersClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseUser:
+    def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> WhoAmIUser:
         """
         Retrieve details of the account that you are using to access the API.
 
@@ -359,7 +360,7 @@ class UsersClient:
 
         Returns
         -------
-        LseUser
+        WhoAmIUser
 
 
         Examples
@@ -379,9 +380,9 @@ class UsersClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LseUser,
+                    WhoAmIUser,
                     construct_type(
-                        type_=LseUser,  # type: ignore
+                        type_=WhoAmIUser,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -1109,7 +1110,7 @@ class AsyncUsersClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseUser:
+    async def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> WhoAmIUser:
         """
         Retrieve details of the account that you are using to access the API.
 
@@ -1120,7 +1121,7 @@ class AsyncUsersClient:
 
         Returns
         -------
-        LseUser
+        WhoAmIUser
 
 
         Examples
@@ -1148,9 +1149,9 @@ class AsyncUsersClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LseUser,
+                    WhoAmIUser,
                     construct_type(
-                        type_=LseUser,  # type: ignore
+                        type_=WhoAmIUser,  # type: ignore
                         object_=_response.json(),
                     ),
                 )

{label_studio_sdk-2.0.2.dist-info → label_studio_sdk-2.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 2.0.2
+Version: 2.0.4
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers