ayon-python-api 1.2.16.dev0__py3-none-any.whl → 1.2.17.dev0__py3-none-any.whl

ayon_api/_api_helpers/activities.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import json
 import typing
-from typing import Optional, Iterable, Generator, Any
+from typing import Optional, Iterable, Generator, Any, Literal
 
 from ayon_api.utils import (
     SortOrder,
@@ -255,6 +255,117 @@ class ActivitiesAPI(BaseServerAPI):
         )
         response.raise_for_status()
 
+    def get_raw_activity_categories(self, project_name: str) -> dict[str, Any]:
+        """Get activity categories available on server (raw response).
+
+        Args:
+            project_name (str): Project name to get categories for.
+
+        Returns:
+            list[str]: Available activity categories.
+
+        """
+        response = self.get(f"projects/{project_name}/activityCategories")
+        response.raise_for_status()
+        return response.data
+
+    def get_activity_categories(self, project_name: str) -> list[str]:
+        """Get activity categories available on server.
+
+        Args:
+            project_name (str): Project name to get categories for.
+
+        Returns:
+            list[str]: Available activity categories.
+
+        """
+
+        data = self.get_raw_activity_categories(project_name)
+        return data["categories"]
+
+    def create_activity_reaction(
+        self,
+        project_name: str,
+        activity_id: str,
+        reaction: str,
+    ) -> None:
+        """React to activity."""
+        response = self.post(
+            f"projects/{project_name}/activities/{activity_id}/reactions",
+            reaction=reaction,
+        )
+        response.raise_for_status()
+
+    def delete_activity_reaction(
+        self, project_name: str, activity_id: str, reaction: str
+    ) -> None:
+        response = self.delete(
+            f"projects/{project_name}/activities/{activity_id}"
+            f"/reactions/{reaction}"
+        )
+        response.raise_for_status()
+
+    def suggest_entity_mention(
+        self,
+        project_name: str,
+        entity_id: str,
+        entity_type: Literal["folder", "task", "version"],
+    ) -> dict[str, dict[str, Any]]:
+        """Suggest entities for mention in activity body.
+
+        At this moment does not change data only returns suggestions.
+
+        Args:
+            project_name (str): Project name to search in.
+            entity_id (str): Entity id.
+            entity_type (str): Entity type of the entity.
+
+        Returns:
+            list[dict[str, Any]]: List of suggested entities with
+                their details.
+
+        """
+        response = self.post(
+            f"projects/{project_name}/suggest",
+            entity_id=entity_id,
+            entity_type=entity_type,
+        )
+        response.raise_for_status()
+        return response.data
+
+    def get_raw_entity_watchers(
+        self, project_name: str, entity_id: str, entity_type: str
+    ) -> dict[str, Any]:
+        """Get entity watchers (raw response)."""
+        response = self.get(
+            f"projects/{project_name}/{entity_type}/{entity_id}/watchers"
+        )
+        response.raise_for_status()
+        return response.data
+
+    def get_entity_watchers(
+        self, project_name: str, entity_id: str, entity_type: str
+    ) -> list[str]:
+        """List watchers of an entity."""
+        data = self.get_raw_entity_watchers(
+            project_name, entity_id, entity_type
+        )
+        return data["watchers"]
+
+    def set_entity_watchers(
+        self,
+        project_name: str,
+        entity_id: str,
+        entity_type: str,
+        watchers: list[str],
+    ):
+        """Change watchers of an entity."""
+        response = self.post(
+            f"projects/{project_name}/{entity_type}/{entity_id}/watchers",
+            watchers=watchers,
+        )
+        response.raise_for_status()
+
     def send_activities_batch_operations(
         self,
         project_name: str,

ayon_api/_api_helpers/attributes.py

@@ -139,7 +139,7 @@ class AttributesAPI(BaseServerAPI):
 
         self.reset_attributes_schema()
 
-    def remove_attribute_config(self, attribute_name: str) -> None:
+    def delete_attribute_config(self, attribute_name: str) -> None:
         """Remove attribute from server.
 
         This can't be un-done, please use carefully.
@@ -156,6 +156,17 @@ class AttributesAPI(BaseServerAPI):
 
         self.reset_attributes_schema()
 
+    def remove_attribute_config(self, attribute_name: str) -> None:
+        """Remove attribute from server.
+
+        DEPRECATED: Use 'delete_attribute_config' instead.
+
+        Args:
+            attribute_name (str): Name of attribute to remove.
+
+        """
+        return self.delete_attribute_config(attribute_name)
+
     def get_attributes_for_type(
         self, entity_type: AttributeScope
     ) -> dict[str, AttributeSchemaDataDict]:

ayon_api/_api_helpers/lists.py

@@ -316,6 +316,7 @@ class ListsAPI(BaseServerAPI):
         self,
         project_name: str,
         list_id: str,
+        entity_id: str,
         *,
         position: Optional[int] = None,
         label: Optional[str] = None,
@@ -329,6 +330,7 @@ class ListsAPI(BaseServerAPI):
         Args:
             project_name (str): Project name where entity list lives.
             list_id (str): Entity list id where item will be added.
+            entity_id (str): Id of entity added to the list.
             position (Optional[int]): Position of item in entity list.
             label (Optional[str]): Label of item in entity list.
             attrib (Optional[dict[str, Any]]): Item attribute values.
@@ -342,9 +344,10 @@ class ListsAPI(BaseServerAPI):
         """
         if item_id is None:
             item_id = create_entity_id()
+
         kwargs = {
             "id": item_id,
-            "entityId": list_id,
+            "entityId": entity_id,
         }
         for key, value in (
             ("position", position),

ayon_api/_api_helpers/projects.py

@@ -174,6 +174,7 @@ class ProjectsAPI(BaseServerAPI):
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        include_skeleton: bool = False,
     ) -> Generator[ProjectDict, None, None]:
         """Query available project entities.
 
@@ -184,12 +185,17 @@ class ProjectsAPI(BaseServerAPI):
                 are returned if 'None' is passed.
             library (Optional[bool]): Filter standard/library projects. Both
                 are returned if 'None' is passed.
+            include_skeleton (bool): Include skeleton projects.
 
         Returns:
             Generator[ProjectDict, None, None]: Available projects.
 
         """
-        for project_name in self.get_project_names(active, library):
+        for project_name in self.get_project_names(
+            active=active,
+            library=library,
+            include_skeleton=include_skeleton,
+        ):
             project = self.get_rest_project(project_name)
             if project:
                 yield project
@@ -198,6 +204,7 @@ class ProjectsAPI(BaseServerAPI):
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        include_skeleton: bool = False,
     ) -> list[ProjectListDict]:
         """Receive available projects.
 
@@ -208,6 +215,7 @@ class ProjectsAPI(BaseServerAPI):
                 are returned if 'None' is passed.
             library (Optional[bool]): Filter standard/library projects. Both
                 are returned if 'None' is passed.
+            include_skeleton (bool): Include skeleton projects.
 
         Returns:
             list[ProjectListDict]: List of available projects.
@@ -219,10 +227,14 @@ class ProjectsAPI(BaseServerAPI):
         if library is not None:
             library = "true" if library else "false"
 
-        query = prepare_query_string({
+        query_data = {
             "active": active,
             "library": library,
-        })
+        }
+        if include_skeleton:
+            query_data["skeleton"] = "true"
+
+        query = prepare_query_string(query_data)
         response = self.get(f"projects{query}")
         response.raise_for_status()
         data = response.data
@@ -232,6 +244,7 @@ class ProjectsAPI(BaseServerAPI):
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        include_skeleton: bool = False,
     ) -> list[str]:
         """Receive available project names.
 
@@ -242,6 +255,7 @@ class ProjectsAPI(BaseServerAPI):
                 are returned if 'None' is passed.
             library (Optional[bool]): Filter standard/library projects. Both
                 are returned if 'None' is passed.
+            include_skeleton (bool): Include skeleton projects.
 
         Returns:
             list[str]: List of available project names.
@@ -249,13 +263,18 @@ class ProjectsAPI(BaseServerAPI):
         """
         return [
             project["name"]
-            for project in self.get_rest_projects_list(active, library)
+            for project in self.get_rest_projects_list(
+                active=active,
+                library=library,
+                include_skeleton=include_skeleton,
+            )
         ]
 
     def get_projects(
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        include_skeleton: bool = False,
         fields: Optional[Iterable[str]] = None,
         own_attributes: bool = False,
     ) -> Generator[ProjectDict, None, None]:
@@ -266,6 +285,7 @@ class ProjectsAPI(BaseServerAPI):
                 Filter is disabled when 'None' is passed.
             library (Optional[bool]): Filter library projects. Filter is
                 disabled when 'None' is passed.
+            include_skeleton (bool): Include skeleton projects.
             fields (Optional[Iterable[str]]): fields to be queried
                 for project.
             own_attributes (Optional[bool]): Attribute values that are
@@ -280,7 +300,11 @@ class ProjectsAPI(BaseServerAPI):
 
         graphql_fields, fetch_type = self._get_project_graphql_fields(fields)
         if fetch_type == ProjectFetchType.RESTList:
-            yield from self.get_rest_projects_list(active, library)
+            yield from self.get_rest_projects_list(
+                active=active,
+                library=library,
+                include_skeleton=include_skeleton,
+            )
             return
 
         projects_by_name = {}
@@ -288,6 +312,7 @@ class ProjectsAPI(BaseServerAPI):
             projects = list(self._get_graphql_projects(
                 active,
                 library,
+                include_skeleton=include_skeleton,
                 fields=graphql_fields,
                 own_attributes=own_attributes,
             ))
@@ -296,7 +321,11 @@ class ProjectsAPI(BaseServerAPI):
                 return
             projects_by_name = {p["name"]: p for p in projects}
 
-        for project in self.get_rest_projects(active=active, library=library):
+        for project in self.get_rest_projects(
+            active=active,
+            library=library,
+            include_skeleton=include_skeleton,
+        ):
             if own_attributes:
                 fill_own_attribs(project)
 
@@ -356,6 +385,8 @@ class ProjectsAPI(BaseServerAPI):
         project_code: str,
         library_project: bool = False,
         preset_name: Optional[str] = None,
+        data: dict[str, Any] | None = None,
+        skeleton: bool = False,
     ) -> ProjectDict:
         """Create project using AYON settings.
 
@@ -375,6 +406,8 @@ class ProjectsAPI(BaseServerAPI):
             library_project (Optional[bool]): Project is library project.
             preset_name (Optional[str]): Name of anatomy preset. Default is
                 used if not passed.
+            data (dict[str, Any]): Project data.
+            skeleton (bool): Project is skeleton project.
 
         Raises:
             ValueError: When project name already exists.
@@ -395,12 +428,19 @@ class ProjectsAPI(BaseServerAPI):
 
         preset = self.get_project_anatomy_preset(preset_name)
 
+        if data is None:
+            data = {}
+
+        if skeleton:
+            data["skeleton"] = True
+
         result = self.post(
             "projects",
             name=project_name,
             code=project_code,
             anatomy=preset,
-            library=library_project
+            library=library_project,
+            data=data,
         )
 
         if result.status != 201:
@@ -498,6 +538,73 @@ class ProjectsAPI(BaseServerAPI):
                 f"Failed to delete project \"{project_name}\". {detail}"
             )
 
+    def get_raw_project_folders(self) -> dict[str, Any]:
+        """Get project folders (raw data)."""
+        response = self.get("projectFolders")
+        response.raise_for_status()
+        return response.data
+
+    def get_project_folders(self) -> list[dict[str, Any]]:
+        data = self.get_raw_project_folders()
+        return data["folders"]
+
+    def create_project_folder(
+        self,
+        label: str,
+        parent_id: str | None = None,
+        data: dict[str, Any] | None = None,
+    ) -> str:
+        """Create project folder."""
+        kwargs = {}
+        if parent_id is not None:
+            kwargs["parentId"] = parent_id
+        if data:
+            kwargs["data"] = data
+
+        response = self.post("projectFolders", label=label, **kwargs)
+        response.raise_for_status()
+        return response.data["id"]
+
+    def update_project_folder(
+        self,
+        folder_id: str,
+        label: str | None = None,
+        parent_id: str | None = None,
+        data: dict[str, Any] | None = None,
+    ) -> None:
+        body = {
+            key: value
+            for key, value in (
+                ("label", label),
+                ("parentId", parent_id),
+                ("data", data),
+            )
+            if value is not None
+        }
+        response = self.patch(f"projectFolders/{folder_id}", **body)
+        response.raise_for_status()
+
+    def set_project_folders_order(self, folder_ids: list[str]) -> None:
+        """Set project folders order."""
+        response = self.post("projectFolders/order", order=folder_ids)
+        response.raise_for_status()
+
+    def assign_projects_to_project_folder(
+        self, folder_id: str, project_names: list[str],
+    ) -> None:
+        """Assign project folder to project."""
+        response = self.post(
+            "projectFolders/assign",
+            folderId=folder_id,
+            projectNames=project_names,
+        )
+        response.raise_for_status()
+
+    def delete_project_folder(self, folder_id: str):
+        """Delete project folder."""
+        response = self.delete(f"projectFolders/{folder_id}")
+        response.raise_for_status()
+
     def get_project_root_overrides(
         self, project_name: str
     ) -> dict[str, dict[str, str]]:
@@ -792,8 +899,9 @@ class ProjectsAPI(BaseServerAPI):
 
     def _get_graphql_projects(
         self,
-        active: Optional[bool],
-        library: Optional[bool],
+        active: bool | None,
+        library: bool | None,
+        include_skeleton: bool,
         fields: set[str],
         own_attributes: bool,
         project_name: Optional[str] = None
@@ -810,6 +918,9 @@ class ProjectsAPI(BaseServerAPI):
         if project_name is not None:
             query.set_variable_value("projectName", project_name)
 
+        if include_skeleton:
+            query.set_variable_value("skeleton", True)
+
         attributes = {}
         if "allAttrib" in fields:
             attributes = self.get_attributes_for_type("project")

ayon_api/exceptions.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import copy
 
 try:
@@ -21,13 +23,23 @@ class UrlError(Exception):
     UI if needed.
     """
 
-    def __init__(self, message, title, hints=None):
+
+    def __init__(
+        self,
+        message: str,
+        title: str,
+        hints: list[str] | None = None,
+    ) -> None:
         if hints is None:
             hints = []
 
         self.title = title
         self.hints = hints
-        super(UrlError, self).__init__(message)
+        super().__init__(message)
+
+
+class UrlNotReached(UrlError):
+    pass
 
 
 class ServerError(Exception):

ayon_api/graphql_queries.py

@@ -91,8 +91,10 @@ def project_graphql_query(fields):
 def projects_graphql_query(fields):
     query = GraphQlQuery("ProjectsQuery")
     project_name_var = query.add_variable("projectName", "String!")
+    skeleton_var = query.add_variable("skeleton", "Boolean!")
     projects_field = query.add_field_with_edges("projects")
     projects_field.set_filter("name", project_name_var)
+    projects_field.set_filter("includeSkeleton", skeleton_var)
 
     nested_fields = fields_to_dict(fields)
 

ayon_api/server_api.py

@@ -16,7 +16,7 @@ import platform
 import uuid
 from contextlib import contextmanager
 import typing
-from typing import Optional, Iterable, Generator, Any, Union
+from typing import Optional, Iterable, Generator, Any, Union, Literal
 
 import requests
 
@@ -1361,6 +1361,176 @@ class ServerAPI(
     def delete(self, entrypoint: str, **kwargs):
         return self.raw_delete(entrypoint, params=kwargs)
 
+    def get_server_config(self):
+        response = self.get("config")
+        response.raise_for_status()
+        return response.data
+
+    def set_server_config(
+        self,
+        studio_name: str | None = None,
+        customization: dict[str, Any] | None = None,
+        authentication: dict[str, Any] | None = None,
+        project_options: dict[str, Any] | None = None,
+        changelog: dict[str, Any] | None = None,
+    ) -> None:
+        body = {
+            key: value
+            for key, value in (
+                ("studio_name", studio_name),
+                ("customization", customization),
+                ("authentication", authentication),
+                ("project_options", project_options),
+                ("changelog", changelog),
+            )
+            if value is not None
+        }
+        response = self.post("config", **body)
+        response.raise_for_status()
+
+    def get_server_config_overrides(self):
+        response = self.get("config/overrides")
+        response.raise_for_status()
+        return response.data
+
+    def get_server_config_value(self, key: str):
+        response = self.get(f"config/value/{key}")
+        response.raise_for_status()
+        return response.data
+
+    def download_server_config_file(
+        self,
+        file_type: Literal["login_background", "studio_logo"],
+        filepath: str,
+        *,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> TransferProgress:
+        """Download server config file.
+
+        Validate if server has config file available first. Method crashes
+            if the file is not available.
+
+        Args:
+            file_type (Literal["login_background", "studio_logo"]): File to
+                download.
+            filepath (str): Target filepath.
+            chunk_size (int | None): Size of chunks used for download.
+            progress (TransferProgress | None): Object to track download
+                progress.
+
+        """
+        return self.download_file(
+            f"api/config/files/{file_type}",
+            filepath,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
+    def download_server_config_file_to_stream(
+        self,
+        file_type: Literal["login_background", "studio_logo"],
+        stream: StreamType,
+        *,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> TransferProgress:
+        """Download server config file to byte stream.
+
+        Validate if server has config file available first. Method crashes
+            if the file is not available.
+
+        Args:
+            file_type (Literal["login_background", "studio_logo"]): File to
+                download.
+            stream (StreamType): Stream where downloaded content is stored.
+            chunk_size (int | None): Size of chunks used for download.
+            progress (TransferProgress | None): Object to track download
+                progress.
+
+        """
+        return self.download_file_to_stream(
+            f"api/config/files/{file_type}",
+            stream,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
+    def upload_server_config_file(
+        self,
+        file_type: Literal["login_background", "studio_logo"],
+        filepath: str,
+        *,
+        content_type: str | None = None,
+        filename: str | None = None,
+        chunk_size: int | None = None,
+        progress: TransferProgress | None = None,
+    ) -> requests.Response:
+        """Upload server config file from byte stream.
+
+        TODO create filename using file_type and extension from content_type
+            if filename is not specified
+
+        Args:
+            file_type (Literal["login_background", "studio_logo"]): File to
+                download.
+            filepath (str): Filepath used to store the file.
+            chunk_size (int | None): Size of chunks used for download.
+            progress (TransferProgress | None): Object to track download
+                progress.
+
+        Returns:
+            requests.Response: Response from upload.
+
+        """
+        if not filename:
+            filename = os.path.basename(filepath)
+        return self.upload_file(
+            f"api/config/files/{file_type}",
+            filepath,
+            filename=filename,
+            content_type=content_type,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
+    def upload_server_config_file_from_stream(
+        self,
+        file_type: Literal["login_background", "studio_logo"],
+        stream: StreamType,
+        filename: str,
+        *,
+        content_type: str | None = None,
+        chunk_size: int | None = None,
+        progress: TransferProgress | None = None,
+    ) -> requests.Response:
+        """Upload server config file from byte stream.
+
+        TODO create filename using file_type and extension from content_type
+            if filename is not specified
+
+        Args:
+            file_type (Literal["login_background", "studio_logo"]): File to
+                download.
+            stream (StreamType): Stream where downloaded content is stored.
+            filename (str): Filename used to store the file.
+            chunk_size (int | None): Size of chunks used for download.
+            progress (TransferProgress | None): Object to track download
+                progress.
+
+        Returns:
+            requests.Response: Response from upload.
+
+        """
+        return self.upload_file_from_stream(
+            f"api/config/files/{file_type}",
+            stream,
+            filename=filename,
+            content_type=content_type,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
     def _endpoint_to_url(
         self,
         endpoint: str,

ayon_api/typing.py

@@ -103,7 +103,8 @@ AttributeScope = Literal[
     "version",
     "representation",
     "workfile",
-    "user"
+    "user",
+    "list",
 ]
 
 AttributeType = Literal[