ayon-python-api 1.2.2__py3-none-any.whl → 1.2.3__py3-none-any.whl

ayon_api/__init__.py

@@ -222,11 +222,17 @@ from ._api import (
     create_representation,
     update_representation,
     delete_representation,
+    get_workfile_entities,
+    get_workfile_entity,
+    get_workfile_entity_by_id,
+    create_workfile_entity,
+    update_workfile_entity,
+    delete_workfile_entity,
     get_workfiles_info,
     get_workfile_info,
     get_workfile_info_by_id,
-    delete_workfile_info,
     update_workfile_info,
+    delete_workfile_info,
     get_full_link_type_name,
     get_link_types,
     get_link_type,
@@ -491,11 +497,17 @@ __all__ = (
     "create_representation",
     "update_representation",
     "delete_representation",
+    "get_workfile_entities",
+    "get_workfile_entity",
+    "get_workfile_entity_by_id",
+    "create_workfile_entity",
+    "update_workfile_entity",
+    "delete_workfile_entity",
     "get_workfiles_info",
     "get_workfile_info",
     "get_workfile_info_by_id",
-    "delete_workfile_info",
     "update_workfile_info",
+    "delete_workfile_info",
     "get_full_link_type_name",
     "get_link_types",
     "get_link_type",

ayon_api/_api.py

@@ -6157,8 +6157,9 @@ def delete_representation(
     )
 
 
-def get_workfiles_info(
+def get_workfile_entities(
     project_name: str,
+    *,
     workfile_ids: Optional[Iterable[str]] = None,
     task_ids: Optional[Iterable[str]] = None,
     paths: Optional[Iterable[str]] = None,
@@ -6167,7 +6168,6 @@ def get_workfiles_info(
     tags: Optional[Iterable[str]] = None,
     has_links: Optional[str] = None,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Generator[WorkfileInfoDict, None, None]:
     """Workfile info entities by passed filters.
 
@@ -6186,8 +6186,6 @@ def get_workfiles_info(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Generator[WorkfileInfoDict, None, None]: Queried workfile info
@@ -6195,7 +6193,7 @@ def get_workfiles_info(
 
     """
     con = get_server_api_connection()
-    return con.get_workfiles_info(
+    return con.get_workfile_entities(
         project_name=project_name,
         workfile_ids=workfile_ids,
         task_ids=task_ids,
@@ -6205,16 +6203,15 @@ def get_workfiles_info(
         tags=tags,
         has_links=has_links,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def get_workfile_info(
+def get_workfile_entity(
     project_name: str,
     task_id: str,
     path: str,
+    *,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Optional[WorkfileInfoDict]:
     """Workfile info entity by task id and workfile path.
 
@@ -6225,28 +6222,25 @@ def get_workfile_info(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Optional[WorkfileInfoDict]: Workfile info entity or None.
 
     """
     con = get_server_api_connection()
-    return con.get_workfile_info(
+    return con.get_workfile_entity(
         project_name=project_name,
         task_id=task_id,
         path=path,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def get_workfile_info_by_id(
+def get_workfile_entity_by_id(
     project_name: str,
     workfile_id: str,
+    *,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Optional[WorkfileInfoDict]:
     """Workfile info entity by id.
 
@@ -6256,23 +6250,119 @@ def get_workfile_info_by_id(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Optional[WorkfileInfoDict]: Workfile info entity or None.
 
     """
     con = get_server_api_connection()
-    return con.get_workfile_info_by_id(
+    return con.get_workfile_entity_by_id(
         project_name=project_name,
         workfile_id=workfile_id,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def delete_workfile_info(
+def create_workfile_entity(
+    project_name: str,
+    path: str,
+    task_id: str,
+    *,
+    thumbnail_id: Optional[str] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
+    tags: Optional[list[str]] = None,
+    status: Optional[str] = None,
+    active: Optional[bool] = None,
+    workfile_id: Optional[str] = None,
+) -> str:
+    """Create new workfile.
+
+    Args:
+        project_name (str): Project name.
+        path (str): Representation name.
+        task_id (str): Parent task id.
+        thumbnail_id (Optional[str]): Thumbnail id.
+        attrib (Optional[dict[str, Any]]): Representation attributes.
+        data (Optional[dict[str, Any]]): Representation data.
+        tags (Optional[Iterable[str]]): Representation tags.
+        status (Optional[str]): Representation status.
+        active (Optional[bool]): Representation active state.
+        workfile_id (Optional[str]): Workfile info id. If not
+            passed new id is generated.
+
+    Returns:
+        str: Workfile info id.
+
+    """
+    con = get_server_api_connection()
+    return con.create_workfile_entity(
+        project_name=project_name,
+        path=path,
+        task_id=task_id,
+        thumbnail_id=thumbnail_id,
+        attrib=attrib,
+        data=data,
+        tags=tags,
+        status=status,
+        active=active,
+        workfile_id=workfile_id,
+    )
+
+
+def update_workfile_entity(
+    project_name: str,
+    workfile_id: str,
+    *,
+    path: Optional[str] = None,
+    task_id: Optional[str] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
+    tags: Optional[Iterable[str]] = None,
+    status: Optional[str] = None,
+    active: Optional[bool] = None,
+    thumbnail_id: Optional[str] = NOT_SET,
+    created_by: Optional[str] = None,
+    updated_by: Optional[str] = None,
+) -> None:
+    """Update workfile entity on server.
+
+    Update of ``attrib`` does change only passed attributes. If you want
+        to unset value, use ``None``.
+
+    Args:
+        project_name (str): Project name.
+        workfile_id (str): Workfile id.
+        path (Optional[str]): New rootless workfile path..
+        task_id (Optional[str]): New parent task id.
+        attrib (Optional[dict[str, Any]]): New attributes.
+        data (Optional[dict[str, Any]]): New data.
+        tags (Optional[Iterable[str]]): New tags.
+        status (Optional[str]): New status.
+        active (Optional[bool]): New active state.
+        thumbnail_id (Optional[str]): New thumbnail id.
+        created_by (Optional[str]): New created by username.
+        updated_by (Optional[str]): New updated by username.
+
+    """
+    con = get_server_api_connection()
+    return con.update_workfile_entity(
+        project_name=project_name,
+        workfile_id=workfile_id,
+        path=path,
+        task_id=task_id,
+        attrib=attrib,
+        data=data,
+        tags=tags,
+        status=status,
+        active=active,
+        thumbnail_id=thumbnail_id,
+        created_by=created_by,
+        updated_by=updated_by,
+    )
+
+
+def delete_workfile_entity(
     project_name: str,
     workfile_id: str,
 ) -> None:
@@ -6284,12 +6374,127 @@ def delete_workfile_info(
 
     """
     con = get_server_api_connection()
-    return con.delete_workfile_info(
+    return con.delete_workfile_entity(
         project_name=project_name,
         workfile_id=workfile_id,
     )
 
 
+def get_workfiles_info(
+    project_name: str,
+    workfile_ids: Optional[Iterable[str]] = None,
+    task_ids: Optional[Iterable[str]] = None,
+    paths: Optional[Iterable[str]] = None,
+    path_regex: Optional[str] = None,
+    statuses: Optional[Iterable[str]] = None,
+    tags: Optional[Iterable[str]] = None,
+    has_links: Optional[str] = None,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Generator[WorkfileInfoDict, None, None]:
+    """DEPRECATED Workfile info entities by passed filters.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        workfile_ids (Optional[Iterable[str]]): Workfile ids.
+        task_ids (Optional[Iterable[str]]): Task ids.
+        paths (Optional[Iterable[str]]): Rootless workfiles paths.
+        path_regex (Optional[str]): Regex filter for workfile path.
+        statuses (Optional[Iterable[str]]): Workfile info statuses used
+            for filtering.
+        tags (Optional[Iterable[str]]): Workfile info tags used
+            for filtering.
+        has_links (Optional[Literal[IN, OUT, ANY]]): Filter
+            representations with IN/OUT/ANY links.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Generator[WorkfileInfoDict, None, None]: Queried workfile info
+            entites.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfiles_info(
+        project_name=project_name,
+        workfile_ids=workfile_ids,
+        task_ids=task_ids,
+        paths=paths,
+        path_regex=path_regex,
+        statuses=statuses,
+        tags=tags,
+        has_links=has_links,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
+def get_workfile_info(
+    project_name: str,
+    task_id: str,
+    path: str,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Optional[WorkfileInfoDict]:
+    """DEPRECATED Workfile info entity by task id and workfile path.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        task_id (str): Task id.
+        path (str): Rootless workfile path.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfile_info(
+        project_name=project_name,
+        task_id=task_id,
+        path=path,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
+def get_workfile_info_by_id(
+    project_name: str,
+    workfile_id: str,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Optional[WorkfileInfoDict]:
+    """DEPRECATED Workfile info entity by id.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        workfile_id (str): Workfile info id.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfile_info_by_id(
+        project_name=project_name,
+        workfile_id=workfile_id,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
 def update_workfile_info(
     project_name: str,
     workfile_id: str,
@@ -6304,7 +6509,7 @@ def update_workfile_info(
     created_by: Optional[str] = None,
     updated_by: Optional[str] = None,
 ) -> None:
-    """Update workfile entity on server.
+    """DEPRECATED Update workfile entity on server.
 
     Update of ``attrib`` does change only passed attributes. If you want
         to unset value, use ``None``.
@@ -6341,6 +6546,24 @@ def update_workfile_info(
     )
 
 
+def delete_workfile_info(
+    project_name: str,
+    workfile_id: str,
+) -> None:
+    """DEPRECATED Delete workfile entity on server.
+
+    Args:
+        project_name (str): Project name.
+        workfile_id (str): Workfile id to delete.
+
+    """
+    con = get_server_api_connection()
+    return con.delete_workfile_info(
+        project_name=project_name,
+        workfile_id=workfile_id,
+    )
+
+
 def get_full_link_type_name(
     link_type_name: str,
     input_type: str,

ayon_api/_api_helpers/base.py

@@ -109,6 +109,11 @@ class BaseServerAPI:
     ) -> Optional[ProjectDict]:
         raise NotImplementedError()
 
+    def get_user(
+        self, username: Optional[str] = None
+    ) -> Optional[dict[str, Any]]:
+        raise NotImplementedError()
+
     def _prepare_fields(
         self,
         entity_type: str,

ayon_api/_api_helpers/workfiles.py

@@ -5,7 +5,8 @@ import typing
 from typing import Optional, Iterable, Generator, Any
 
 from ayon_api.graphql_queries import workfiles_info_graphql_query
-from ayon_api.utils import NOT_SET
+from ayon_api.utils import NOT_SET, create_entity_id
+
 from .base import BaseServerAPI, _PLACEHOLDER
 
 if typing.TYPE_CHECKING:
@@ -13,9 +14,10 @@ if typing.TYPE_CHECKING:
 
 
 class WorkfilesAPI(BaseServerAPI):
-    def get_workfiles_info(
+    def get_workfile_entities(
         self,
         project_name: str,
+        *,
         workfile_ids: Optional[Iterable[str]] = None,
         task_ids: Optional[Iterable[str]] =None,
         paths: Optional[Iterable[str]] =None,
@@ -24,7 +26,6 @@ class WorkfilesAPI(BaseServerAPI):
         tags: Optional[Iterable[str]] = None,
         has_links: Optional[str]=None,
         fields: Optional[Iterable[str]] = None,
-        own_attributes=_PLACEHOLDER,
     ) -> Generator[WorkfileInfoDict, None, None]:
         """Workfile info entities by passed filters.
 
@@ -43,8 +44,6 @@ class WorkfilesAPI(BaseServerAPI):
             fields (Optional[Iterable[str]]): Fields to be queried for
                 representation. All possible fields are returned if 'None' is
                 passed.
-            own_attributes (Optional[bool]): DEPRECATED: Not supported for
-                workfiles.
 
         Returns:
             Generator[WorkfileInfoDict, None, None]: Queried workfile info
@@ -94,16 +93,6 @@ class WorkfilesAPI(BaseServerAPI):
             fields = set(fields)
             self._prepare_fields("workfile", fields)
 
-        if own_attributes is not _PLACEHOLDER:
-            warnings.warn(
-                (
-                    "'own_attributes' is not supported for workfiles. The"
-                    " argument will be removed form function signature in"
-                    " future (apx. version 1.0.10 or 1.1.0)."
-                ),
-                DeprecationWarning
-            )
-
         query = workfiles_info_graphql_query(fields)
 
         for attr, filter_value in filters.items():
@@ -114,13 +103,13 @@ class WorkfilesAPI(BaseServerAPI):
                 self._convert_entity_data(workfile_info)
                 yield workfile_info
 
-    def get_workfile_info(
+    def get_workfile_entity(
         self,
         project_name: str,
         task_id: str,
         path: str,
+        *,
         fields: Optional[Iterable[str]] = None,
-        own_attributes=_PLACEHOLDER,
     ) -> Optional[WorkfileInfoDict]:
         """Workfile info entity by task id and workfile path.
 
@@ -131,8 +120,6 @@ class WorkfilesAPI(BaseServerAPI):
             fields (Optional[Iterable[str]]): Fields to be queried for
                 representation. All possible fields are returned if 'None' is
                 passed.
-            own_attributes (Optional[bool]): DEPRECATED: Not supported for
-                workfiles.
 
         Returns:
             Optional[WorkfileInfoDict]: Workfile info entity or None.
@@ -141,22 +128,21 @@ class WorkfilesAPI(BaseServerAPI):
         if not task_id or not path:
             return None
 
-        for workfile_info in self.get_workfiles_info(
+        for workfile_info in self.get_workfile_entities(
             project_name,
             task_ids=[task_id],
             paths=[path],
             fields=fields,
-            own_attributes=own_attributes
         ):
             return workfile_info
         return None
 
-    def get_workfile_info_by_id(
+    def get_workfile_entity_by_id(
         self,
         project_name: str,
         workfile_id: str,
+        *,
         fields: Optional[Iterable[str]] = None,
-        own_attributes=_PLACEHOLDER,
     ) -> Optional[WorkfileInfoDict]:
         """Workfile info entity by id.
 
@@ -166,8 +152,6 @@ class WorkfilesAPI(BaseServerAPI):
             fields (Optional[Iterable[str]]): Fields to be queried for
                 representation. All possible fields are returned if 'None' is
                 passed.
-            own_attributes (Optional[bool]): DEPRECATED: Not supported for
-                workfiles.
 
         Returns:
             Optional[WorkfileInfoDict]: Workfile info entity or None.
@@ -176,36 +160,85 @@ class WorkfilesAPI(BaseServerAPI):
         if not workfile_id:
             return None
 
-        for workfile_info in self.get_workfiles_info(
+        for workfile_info in self.get_workfile_entities(
             project_name,
             workfile_ids=[workfile_id],
             fields=fields,
-            own_attributes=own_attributes
         ):
             return workfile_info
         return None
 
-    def delete_workfile_info(
+    def create_workfile_entity(
         self,
         project_name: str,
-        workfile_id: str,
-    ) -> None:
-        """Delete workfile entity on server.
+        path: str,
+        task_id: str,
+        *,
+        thumbnail_id: Optional[str] = None,
+        attrib: Optional[dict[str, Any]] = None,
+        data: Optional[dict[str, Any]] = None,
+        tags: Optional[list[str]] = None,
+        status: Optional[str] = None,
+        active: Optional[bool] = None,
+        workfile_id: Optional[str] = None,
+    ) -> str:
+        """Create new workfile.
 
         Args:
             project_name (str): Project name.
-            workfile_id (str): Workfile id to delete.
+            path (str): Representation name.
+            task_id (str): Parent task id.
+            thumbnail_id (Optional[str]): Thumbnail id.
+            attrib (Optional[dict[str, Any]]): Representation attributes.
+            data (Optional[dict[str, Any]]): Representation data.
+            tags (Optional[Iterable[str]]): Representation tags.
+            status (Optional[str]): Representation status.
+            active (Optional[bool]): Representation active state.
+            workfile_id (Optional[str]): Workfile info id. If not
+                passed new id is generated.
+
+        Returns:
+            str: Workfile info id.
 
         """
-        response = self.delete(
-            f"projects/{project_name}/workfiles/{workfile_id}"
+        if workfile_id is None:
+            workfile_id = create_entity_id()
+
+        create_data = {
+            "id": workfile_id,
+            "path": path,
+            "taskId": task_id,
+        }
+        for key, value in (
+            ("thumbnailId", thumbnail_id),
+            ("attrib", attrib),
+            ("data", data),
+            ("tags", tags),
+            ("status", status),
+            ("active", active),
+        ):
+            if value is not None:
+                create_data[key] = value
+
+        major, minor, patch, _, _ = self.get_server_version_tuple()
+        if (major, minor, patch) < (1, 1, 3):
+            user = self.get_user()
+            username = user["name"]
+            create_data["createdBy"] = username
+            create_data["updatedBy"] = username
+
+        response = self.post(
+            f"projects/{project_name}/workfiles",
+            **create_data
         )
         response.raise_for_status()
+        return workfile_id
 
-    def update_workfile_info(
+    def update_workfile_entity(
         self,
         project_name: str,
         workfile_id: str,
+        *,
         path: Optional[str] = None,
         task_id: Optional[str] = None,
         attrib: Optional[dict[str, Any]] = None,
@@ -263,3 +296,226 @@ class WorkfilesAPI(BaseServerAPI):
             **update_data
         )
         response.raise_for_status()
+
+    def delete_workfile_entity(
+        self,
+        project_name: str,
+        workfile_id: str,
+    ) -> None:
+        """Delete workfile entity on server.
+
+        Args:
+            project_name (str): Project name.
+            workfile_id (str): Workfile id to delete.
+
+        """
+        response = self.delete(
+            f"projects/{project_name}/workfiles/{workfile_id}"
+        )
+        response.raise_for_status()
+
+    # --- DEPRECATED ---
+    def get_workfiles_info(
+        self,
+        project_name: str,
+        workfile_ids: Optional[Iterable[str]] = None,
+        task_ids: Optional[Iterable[str]] =None,
+        paths: Optional[Iterable[str]] =None,
+        path_regex: Optional[str] = None,
+        statuses: Optional[Iterable[str]] = None,
+        tags: Optional[Iterable[str]] = None,
+        has_links: Optional[str]=None,
+        fields: Optional[Iterable[str]] = None,
+        own_attributes=_PLACEHOLDER,
+    ) -> Generator[WorkfileInfoDict, None, None]:
+        """DEPRECATED Workfile info entities by passed filters.
+
+        Args:
+            project_name (str): Project under which the entity is located.
+            workfile_ids (Optional[Iterable[str]]): Workfile ids.
+            task_ids (Optional[Iterable[str]]): Task ids.
+            paths (Optional[Iterable[str]]): Rootless workfiles paths.
+            path_regex (Optional[str]): Regex filter for workfile path.
+            statuses (Optional[Iterable[str]]): Workfile info statuses used
+                for filtering.
+            tags (Optional[Iterable[str]]): Workfile info tags used
+                for filtering.
+            has_links (Optional[Literal[IN, OUT, ANY]]): Filter
+                representations with IN/OUT/ANY links.
+            fields (Optional[Iterable[str]]): Fields to be queried for
+                representation. All possible fields are returned if 'None' is
+                passed.
+            own_attributes (Optional[bool]): DEPRECATED: Not supported for
+                workfiles.
+
+        Returns:
+            Generator[WorkfileInfoDict, None, None]: Queried workfile info
+                entites.
+
+        """
+        if own_attributes is not _PLACEHOLDER:
+            warnings.warn(
+                (
+                    "'own_attributes' is not supported for workfiles. The"
+                    " argument will be removed form function signature in"
+                    " future (apx. version 1.0.10 or 1.1.0)."
+                ),
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+        return self.get_workfile_entities(
+            project_name,
+            workfile_ids=workfile_ids,
+            task_ids=task_ids,
+            paths=paths,
+            path_regex=path_regex,
+            statuses=statuses,
+            tags=tags,
+            has_links=has_links,
+            fields=fields,
+        )
+
+    def get_workfile_info(
+        self,
+        project_name: str,
+        task_id: str,
+        path: str,
+        fields: Optional[Iterable[str]] = None,
+        own_attributes=_PLACEHOLDER,
+    ) -> Optional[WorkfileInfoDict]:
+        """DEPRECATED Workfile info entity by task id and workfile path.
+
+        Args:
+            project_name (str): Project under which the entity is located.
+            task_id (str): Task id.
+            path (str): Rootless workfile path.
+            fields (Optional[Iterable[str]]): Fields to be queried for
+                representation. All possible fields are returned if 'None' is
+                passed.
+            own_attributes (Optional[bool]): DEPRECATED: Not supported for
+                workfiles.
+
+        Returns:
+            Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+        """
+        if own_attributes is not _PLACEHOLDER:
+            warnings.warn(
+                (
+                    "'own_attributes' is not supported for workfiles. The"
+                    " argument will be removed form function signature in"
+                    " future (apx. version 1.0.10 or 1.1.0)."
+                ),
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+        return self.get_workfile_entity(
+            project_name, task_id, path,fields=fields
+        )
+
+    def get_workfile_info_by_id(
+        self,
+        project_name: str,
+        workfile_id: str,
+        fields: Optional[Iterable[str]] = None,
+        own_attributes=_PLACEHOLDER,
+    ) -> Optional[WorkfileInfoDict]:
+        """DEPRECATED Workfile info entity by id.
+
+        Args:
+            project_name (str): Project under which the entity is located.
+            workfile_id (str): Workfile info id.
+            fields (Optional[Iterable[str]]): Fields to be queried for
+                representation. All possible fields are returned if 'None' is
+                passed.
+            own_attributes (Optional[bool]): DEPRECATED: Not supported for
+                workfiles.
+
+        Returns:
+            Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+        """
+        if own_attributes is not _PLACEHOLDER:
+            warnings.warn(
+                (
+                    "'own_attributes' is not supported for workfiles. The"
+                    " argument will be removed form function signature in"
+                    " future (apx. version 1.0.10 or 1.1.0)."
+                ),
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        return self.get_workfile_entity_by_id(
+            project_name,
+            workfile_id,
+            fields=fields,
+        )
+
+    def update_workfile_info(
+        self,
+        project_name: str,
+        workfile_id: str,
+        path: Optional[str] = None,
+        task_id: Optional[str] = None,
+        attrib: Optional[dict[str, Any]] = None,
+        data: Optional[dict[str, Any]] = None,
+        tags: Optional[Iterable[str]] = None,
+        status: Optional[str] = None,
+        active: Optional[bool] = None,
+        thumbnail_id: Optional[str] = NOT_SET,
+        created_by: Optional[str] = None,
+        updated_by: Optional[str] = None,
+    ) -> None:
+        """DEPRECATED Update workfile entity on server.
+
+        Update of ``attrib`` does change only passed attributes. If you want
+            to unset value, use ``None``.
+
+        Args:
+            project_name (str): Project name.
+            workfile_id (str): Workfile id.
+            path (Optional[str]): New rootless workfile path..
+            task_id (Optional[str]): New parent task id.
+            attrib (Optional[dict[str, Any]]): New attributes.
+            data (Optional[dict[str, Any]]): New data.
+            tags (Optional[Iterable[str]]): New tags.
+            status (Optional[str]): New status.
+            active (Optional[bool]): New active state.
+            thumbnail_id (Optional[str]): New thumbnail id.
+            created_by (Optional[str]): New created by username.
+            updated_by (Optional[str]): New updated by username.
+
+        """
+        return self.update_workfile_entity(
+            project_name,
+            workfile_id,
+            path=path,
+            task_id=task_id,
+            attrib=attrib,
+            data=data,
+            tags=tags,
+            status=status,
+            active=active,
+            thumbnail_id=thumbnail_id,
+            created_by=created_by,
+            updated_by=updated_by,
+        )
+
+    def delete_workfile_info(
+        self,
+        project_name: str,
+        workfile_id: str,
+    ) -> None:
+        """DEPRECATED Delete workfile entity on server.
+
+        Args:
+            project_name (str): Project name.
+            workfile_id (str): Workfile id to delete.
+
+        """
+        return self.delete_workfile_entity(
+            project_name,
+            workfile_id,
+        )

ayon_api/entity_hub.py

@@ -283,14 +283,14 @@ class EntityHub:
                     self.project_name,
                     entity_id,
                     fields=self._get_folder_fields(),
-                    own_attributes=True
+                    own_attributes=True,
                 )
             elif entity_type == "task":
                 entity_data = self._connection.get_task_by_id(
                     self.project_name,
                     entity_id,
                     fields=self._get_task_fields(),
-                    own_attributes=True
+                    own_attributes=True,
                 )
             elif entity_type == "product":
                 entity_data = self._connection.get_product_by_id(
@@ -781,6 +781,7 @@ class EntityHub:
                 parent_ids=[entity.id],
                 fields=folder_fields,
                 own_attributes=True,
+                active=None,
             ))
 
         elif entity.entity_type == "folder":
@@ -789,6 +790,7 @@ class EntityHub:
                 parent_ids=[entity.id],
                 fields=folder_fields,
                 own_attributes=True,
+                active=None,
             ))
 
             tasks = list(self._connection.get_tasks(
@@ -796,6 +798,7 @@ class EntityHub:
                 folder_ids=[entity.id],
                 fields=task_fields,
                 own_attributes=True,
+                active=None,
             ))
 
         children_ids = {
@@ -897,7 +900,7 @@ class EntityHub:
         project_name = self.project_name
         project = self._connection.get_project(
             project_name,
-            own_attributes=True
+            own_attributes=True,
         )
         if not project:
             raise ValueError(f"Project \"{project_name}\" was not found.")
@@ -949,11 +952,13 @@ class EntityHub:
             project_entity.name,
             fields=folder_fields,
             own_attributes=True,
+            active=None,
         )
         tasks = self._connection.get_tasks(
             project_entity.name,
             fields=task_fields,
             own_attributes=True,
+            active=None,
         )
         folders_by_parent_id = collections.defaultdict(list)
         for folder in folders:

ayon_api/graphql.py

@@ -857,8 +857,8 @@ class GraphQlQueryEdgeField(BaseGraphQlQueryField):
         self._edge_children.append(field)
         field.set_parent(self)
 
-    def add_edge_field(self, name: str) -> GraphQlQueryEdgeField:
-        item = GraphQlQueryEdgeField(name, self, self._order)
+    def add_edge_field(self, name: str) -> GraphQlQueryField:
+        item = GraphQlQueryField(name, self, self._order)
         self.add_obj_edge_field(item)
         return item
 

ayon_api/operations.py

@@ -340,7 +340,7 @@ def new_representation_entity(
     return output
 
 
-def new_workfile_info(
+def new_workfile_entity(
     filepath: str,
     task_id: str,
     status: Optional[str] = None,
@@ -396,6 +396,28 @@ def new_workfile_info(
     return output
 
 
+def new_workfile_info(
+    filepath: str,
+    task_id: str,
+    status: Optional[str] = None,
+    tags: Optional[list[str]] = None,
+    attribs: Optional[dict[str, Any]] = None,
+    description: Optional[str] = None,
+    data: Optional[dict[str, Any]] = None,
+    entity_id: Optional[str] = None,
+) -> NewWorkfileDict:
+    return new_workfile_entity(
+        filepath,
+        task_id,
+        status,
+        tags,
+        attribs,
+        description,
+        data,
+        entity_id,
+    )
+
+
 class AbstractOperation(ABC):
     """Base operation class.
 
@@ -1544,3 +1566,143 @@ class OperationsSession(object):
         return self.delete_entity(
             project_name, "representation", representation_id
         )
+
+    def create_workfile_entity(
+        self,
+        project_name: str,
+        path: str,
+        task_id: str,
+        *,
+        thumbnail_id: Optional[str] = None,
+        attrib: Optional[dict[str, Any]] = None,
+        data: Optional[dict[str, Any]] = None,
+        tags: Optional[list[str]] = None,
+        status: Optional[str] = None,
+        active: Optional[bool] = None,
+        workfile_id: Optional[str] = None,
+    ) -> CreateOperation:
+        """Create new workfile entity.
+
+        Args:
+            project_name (str): Project name.
+            path (str): Representation name.
+            task_id (str): Parent task id.
+            thumbnail_id (Optional[str]): Thumbnail id.
+            attrib (Optional[dict[str, Any]]): Representation attributes.
+            data (Optional[dict[str, Any]]): Representation data.
+            tags (Optional[Iterable[str]]): Representation tags.
+            status (Optional[str]): Representation status.
+            active (Optional[bool]): Representation active state.
+            workfile_id (Optional[str]): Workfile info id. If not
+                passed new id is generated.
+
+        Returns:
+            CreateOperation: Object of create operation.
+
+        """
+        if workfile_id is None:
+            workfile_id = create_entity_id()
+
+        create_data = {
+            "id": workfile_id,
+            "path": path,
+            "taskId": task_id,
+        }
+        for key, value in (
+            ("thumbnailId", thumbnail_id),
+            ("attrib", attrib),
+            ("data", data),
+            ("tags", tags),
+            ("status", status),
+            ("active", active),
+        ):
+            if value is not None:
+                create_data[key] = value
+
+        return self.create_entity(
+            project_name,
+            "workfile",
+            create_data
+        )
+
+    def update_workfile_entity(
+        self,
+        project_name: str,
+        workfile_id: str,
+        path: Optional[str] = None,
+        task_id: Optional[str] = None,
+        attrib: Optional[dict[str, Any]] = None,
+        data: Optional[dict[str, Any]] = None,
+        tags: Optional[Iterable[str]] = None,
+        status: Optional[str] = None,
+        active: Optional[bool] = None,
+        thumbnail_id: Optional[str] = NOT_SET,
+        created_by: Optional[str] = None,
+        updated_by: Optional[str] = None,
+    ) -> UpdateOperation:
+        """Update workfile entity on server.
+
+        Update of ``data`` will override existing value on folder entity.
+
+        Update of ``attrib`` does change only passed attributes. If you want
+            to unset value, use ``None``.
+
+        Args:
+            project_name (str): Project name.
+            workfile_id (str): Workfile id.
+            path (Optional[str]): New rootless workfile path..
+            task_id (Optional[str]): New parent task id.
+            attrib (Optional[dict[str, Any]]): New attributes.
+            data (Optional[dict[str, Any]]): New data.
+            tags (Optional[Iterable[str]]): New tags.
+            status (Optional[str]): New status.
+            active (Optional[bool]): New active state.
+            thumbnail_id (Optional[str]): New thumbnail id.
+            created_by (Optional[str]): New created by username.
+            updated_by (Optional[str]): New updated by username.
+
+        Returns:
+            UpdateOperation: Object of update operation.
+
+        """
+        update_data = {}
+        for key, value in (
+            ("path", path),
+            ("taskId", task_id),
+            ("attrib", attrib),
+            ("data", data),
+            ("tags", tags),
+            ("status", status),
+            ("active", active),
+            ("thumbnailId", thumbnail_id),
+            ("createdBy", created_by),
+            ("updatedBy", updated_by),
+        ):
+            if value is not None:
+                update_data[key] = value
+
+        return self.update_entity(
+            project_name,
+            "workfile",
+            workfile_id,
+            update_data
+        )
+
+    def delete_workfile_entity(
+        self,
+        project_name: str,
+        workfile_id: str,
+    ) -> DeleteOperation:
+        """Delete workfile entity.
+
+        Args:
+            project_name (str): Project name.
+            workfile_id (str): Workfile info id to delete.
+
+        Returns:
+            DeleteOperation: Object of delete operation.
+
+        """
+        return self.delete_entity(
+            project_name, "workfile", workfile_id
+        )

ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for AYON server."""
-__version__ = "1.2.2"
+__version__ = "1.2.3"

{ayon_python_api-1.2.2.dist-info → ayon_python_api-1.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 1.2.2
+Version: 1.2.3
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon_python_api-1.2.2.dist-info → ayon_python_api-1.2.3.dist-info}/RECORD

@@ -1,21 +1,21 @@
-ayon_api/__init__.py,sha256=SlnRKMsuFP59JzPOFfaE2M4KjHWP45jeX-K17_Pbt_A,13171
-ayon_api/_api.py,sha256=iLtkHqmwHXQUyj0wWrrPAv9l2OWDV0CWnnRPzCjsoWc,224635
+ayon_api/__init__.py,sha256=qFwQM02QfmS8uhIGHzAZxpPuDWAsPb95cNu68lsycEc,13517
+ayon_api/_api.py,sha256=RLYgANdtsiTuRKez96j9lNji47IUhKfojnesdedlH78,231455
 ayon_api/constants.py,sha256=Um8haZtPB3c7SJumuM1v6DGIZNonKQqufZ9Ul5DCr7g,4035
-ayon_api/entity_hub.py,sha256=UK4MVHb52p0TGAkr4scc1uDOiUrh5TaiNps06g072ro,117130
+ayon_api/entity_hub.py,sha256=1pu7kn_uj2aiKvnhiPvAnSZRyr-_D5v8i5GVNxIU2Nc,117270
 ayon_api/events.py,sha256=RQ_ct_GTb3KbZ6QWBkYn5m-ZUc6NJDAFFsoy2P_w3dQ,1370
 ayon_api/exceptions.py,sha256=FOOSgShGEqno6U3kxSOdALkWuIhfhuYzSup0TjwkgkM,3495
-ayon_api/graphql.py,sha256=Q0iwvp6d7xa4UP0Q_aezObWnVWAYu5pUwi07sGCET9w,29757
+ayon_api/graphql.py,sha256=PgsdNVAwZymEOoFqUuTtnswv8bjtV0IIfBij2R9WKPU,29749
 ayon_api/graphql_queries.py,sha256=g55raaoHO1LwazFzGGGiJkAY5ZHzczJx19HLJDuEY2U,26452
-ayon_api/operations.py,sha256=nESvtCLxZYoPKBAkUDUyXdj2uF4A8x6eMxA8wbONh8Y,47340
+ayon_api/operations.py,sha256=eN0H2ok5hbPSIeBDO6DteJgjRTo28vIj3_x1aVBxyYU,52343
 ayon_api/server_api.py,sha256=nKpXLQkfl7-Y3AoxEMA_0U-ggbfMyil2k3aCBTBenIQ,67182
 ayon_api/typing.py,sha256=6l6PqH2hqET4Jbhg90kNtHUP81nMmsNzmTdXpnX2Q9s,11014
 ayon_api/utils.py,sha256=vzcH8uAKLjeDT5SqZ1k4ckAoOI2DirtD0qglgnRaG5U,31612
-ayon_api/version.py,sha256=9_UMKBhUL8MnVnyc2ExekSHvbVI0En4XgerN-I-PZGo,74
+ayon_api/version.py,sha256=0Wo0gnyDXrc4BvsuxAzI76d6IFh75FNRyTZg-ULj2e0,74
 ayon_api/_api_helpers/__init__.py,sha256=15wxNshWe1htzZhFnwTTflBfQ3tYJzTe6-0hrEUCQbw,1076
 ayon_api/_api_helpers/actions.py,sha256=OBRAEJSVnhGP0xf8ktQL3M7Ubz64nDmn957qZehaRQ0,10578
 ayon_api/_api_helpers/activities.py,sha256=0iknRHukYsVf0M6KRChBs3EsQH8bgg-yzhAx-1VivYs,10445
 ayon_api/_api_helpers/attributes.py,sha256=bdC6KzoszFZmwBGmbwcGdG5jZDmGHW9wQ0z-ffCvn1w,4674
-ayon_api/_api_helpers/base.py,sha256=5iH2VV9omTwXyhYkBpaUUkE613pTlOyhHePcQl-KV_M,3323
+ayon_api/_api_helpers/base.py,sha256=2aeQWDAS0OcI1uI0NebY61sFOruXJWXZUjQbxccbSng,3458
 ayon_api/_api_helpers/bundles_addons.py,sha256=kSlMsJz4J5NyHGdzcngTikznh9MmWbB2VN-hfwb4L8U,30232
 ayon_api/_api_helpers/dependency_packages.py,sha256=bPYvrCLaOmC7KvJxfrhKU-sPZkvxkg_rnr8Nf7DjWhI,8193
 ayon_api/_api_helpers/events.py,sha256=vCH5L4whFlx44nH0bRWuZhyy7F4Uw1uTpcCkDMKTYwk,16572
@@ -30,9 +30,9 @@ ayon_api/_api_helpers/secrets.py,sha256=L74qN38Bp22tDs9CQHWdgw3gsJm7GbnHKU75mCaW
 ayon_api/_api_helpers/tasks.py,sha256=PHYzOdyMJph0QnFILPgL6Glk2eQDGs5Vs61wV_fu2s8,18093
 ayon_api/_api_helpers/thumbnails.py,sha256=bqnPClpDsp7ED7fqt3ly1tA9pg88RLHj-W4GKZlWCa8,10129
 ayon_api/_api_helpers/versions.py,sha256=3GT2ub7Xei_y3eoEp8iZW6Ur1swBZ_0tk4xFY7684fY,22048
-ayon_api/_api_helpers/workfiles.py,sha256=MR9FAFgfuf1-XIBOrZC5cAM1JR_bOkwQkX3IyA7fGN0,8937
-ayon_python_api-1.2.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-ayon_python_api-1.2.2.dist-info/METADATA,sha256=hxwf_KSX4vHsOgufQvUAZHcMfaYOzvzwDhv69hh0FAU,16175
-ayon_python_api-1.2.2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-ayon_python_api-1.2.2.dist-info/top_level.txt,sha256=PKrQbX5Cz53_UmSTR_nIySnBkGyHcBTS88SCw9tuVlc,9
-ayon_python_api-1.2.2.dist-info/RECORD,,
+ayon_api/_api_helpers/workfiles.py,sha256=_JJ-e95SSbyQI0u9FniaAxsAe4HHUwadKlKSkV7amIY,17636
+ayon_python_api-1.2.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ayon_python_api-1.2.3.dist-info/METADATA,sha256=gf0t7X79IYnDOZoH_pCEsKVKvjhrub7ZuJVqLRATFcY,16175
+ayon_python_api-1.2.3.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+ayon_python_api-1.2.3.dist-info/top_level.txt,sha256=PKrQbX5Cz53_UmSTR_nIySnBkGyHcBTS88SCw9tuVlc,9
+ayon_python_api-1.2.3.dist-info/RECORD,,