cognite-toolkit 0.7.45__py3-none-any.whl → 0.7.46__py3-none-any.whl

cognite_toolkit/_cdf_tk/client/api/workflows.py

@@ -0,0 +1,119 @@
+from collections.abc import Iterable, Sequence
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.workflow import WorkflowRequest, WorkflowResponse
+
+from .workflow_triggers import WorkflowTriggersAPI
+from .workflow_versions import WorkflowVersionsAPI
+
+
+class WorkflowsAPI(CDFResourceAPI[ExternalId, WorkflowRequest, WorkflowResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path="/workflows", item_limit=1),
+                "retrieve": Endpoint(method="GET", path="/workflows/{workflowExternalId}", item_limit=1),
+                "delete": Endpoint(method="POST", path="/workflows/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/workflows", item_limit=100),
+            },
+        )
+        self.versions = WorkflowVersionsAPI(http_client)
+        self.triggers = WorkflowTriggersAPI(http_client)
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[WorkflowResponse]:
+        return PagedResponse[WorkflowResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[ExternalId]:
+        return ResponseItems[ExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[WorkflowRequest]) -> list[WorkflowResponse]:
+        """Create or update workflows in CDF.
+
+        Args:
+            items: List of WorkflowRequest objects to create or update.
+        Returns:
+            List of created/updated WorkflowResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    # This is a duplicate of the create method, included to standardize the API interface.
+    def update(self, items: Sequence[WorkflowRequest]) -> list[WorkflowResponse]:
+        """Create or update workflows in CDF.
+
+        Args:
+            items: List of WorkflowRequest objects to create or update.
+        Returns:
+            List of created/updated WorkflowResponse objects.
+        """
+        return self.create(items)
+
+    def retrieve(self, items: Sequence[ExternalId]) -> list[WorkflowResponse]:
+        """Retrieve a workflow from CDF by external ID.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+
+        Returns:
+            The retrieved WorkflowResponse object, or None if not found.
+        """
+        result: list[WorkflowResponse] = []
+        for item in items:
+            endpoint = f"/workflows/{item.external_id}"
+            retrieved = self._request_item_response([item], "retrieve", endpoint=endpoint)
+            result.extend(retrieved)
+        return result
+
+    def delete(self, items: Sequence[ExternalId]) -> None:
+        """Delete workflows from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[WorkflowResponse]:
+        """Iterate over all workflows in CDF.
+
+        Args:
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of WorkflowResponse objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int = 100,
+    ) -> Iterable[list[WorkflowResponse]]:
+        """Iterate over all workflows in CDF.
+
+        Args:
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of WorkflowResponse objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(
+        self,
+        limit: int | None = 100,
+    ) -> list[WorkflowResponse]:
+        """List all workflows in CDF.
+
+        Returns:
+            List of WorkflowResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/cdf_client/api.py

@@ -13,12 +13,6 @@ from typing import Any, Generic, Literal, TypeAlias, TypeVar
 
 from pydantic import BaseModel, JsonValue
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import (
-    RequestUpdateable,
-    T_Identifier,
-    T_RequestResource,
-    T_ResponseResource,
-)
 from cognite_toolkit._cdf_tk.client.http_client import (
     HTTPClient,
     ItemsRequest2,
@@ -26,9 +20,15 @@ from cognite_toolkit._cdf_tk.client.http_client import (
     RequestMessage2,
     SuccessResponse2,
 )
+from cognite_toolkit._cdf_tk.client.resource_classes.base import (
+    RequestUpdateable,
+    T_Identifier,
+    T_RequestResource,
+    T_ResponseResource,
+)
 from cognite_toolkit._cdf_tk.utils.collection import chunker_sequence
 
-from .responses import PagedResponse, ResponseItems
+from .responses import PagedResponse
 
 _T_BaseModel = TypeVar("_T_BaseModel", bound=BaseModel)
 
@@ -41,7 +41,7 @@ class Endpoint:
     concurrency_max_workers: int = 1
 
 
-APIMethod: TypeAlias = Literal["create", "retrieve", "update", "delete", "list"]
+APIMethod: TypeAlias = Literal["create", "retrieve", "update", "delete", "list", "upsert"]
 
 
 class CDFResourceAPI(Generic[T_Identifier, T_RequestResource, T_ResponseResource], ABC):
@@ -74,15 +74,12 @@ class CDFResourceAPI(Generic[T_Identifier, T_RequestResource, T_ResponseResource
         return [item.as_update(mode=mode) for item in items]
 
     @abstractmethod
-    def _page_response(self, response: SuccessResponse2 | ItemsSuccessResponse2) -> PagedResponse[T_ResponseResource]:
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[T_ResponseResource]:
         """Parse a single item response."""
         raise NotImplementedError()
 
-    @abstractmethod
-    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[T_Identifier]:
-        """Parse a reference response."""
-        raise NotImplementedError()
-
     def _make_url(self, path: str = "") -> str:
         """Create the full URL for this resource endpoint."""
         return self._http_client.config.create_api_url(path)
@@ -95,7 +92,7 @@ class CDFResourceAPI(Generic[T_Identifier, T_RequestResource, T_ResponseResource
         for response in self._chunk_requests(
             items, "update", serialization=partial(self._serialize_updates, mode=mode)
         ):
-            response_items.extend(self._page_response(response).items)
+            response_items.extend(self._validate_page_response(response).items)
         return response_items
 
     def _request_item_response(
@@ -108,21 +105,9 @@ class CDFResourceAPI(Generic[T_Identifier, T_RequestResource, T_ResponseResource
     ) -> list[T_ResponseResource]:
         response_items: list[T_ResponseResource] = []
         for response in self._chunk_requests(items, method, self._serialize_items, params, extra_body, endpoint):
-            response_items.extend(self._page_response(response).items)
+            response_items.extend(self._validate_page_response(response).items)
         return response_items
 
-    def _request_reference_response(
-        self,
-        items: Sequence[BaseModel],
-        method: APIMethod,
-        params: dict[str, Any] | None = None,
-        extra_body: dict[str, Any] | None = None,
-    ) -> list[T_Identifier]:
-        all_ids: list[T_Identifier] = []
-        for response in self._chunk_requests(items, method, self._serialize_items, params, extra_body):
-            all_ids.extend(self._reference_response(response).items)
-        return all_ids
-
     def _request_no_response(
         self,
         items: Sequence[BaseModel],
@@ -192,7 +177,7 @@ class CDFResourceAPI(Generic[T_Identifier, T_RequestResource, T_ResponseResource
         """
         response_items: list[T_ResponseResource] = []
         for response in self._chunk_requests_items_split_retries(items, method, params, extra_body):
-            response_items.extend(self._page_response(response).items)
+            response_items.extend(self._validate_page_response(response).items)
         return response_items
 
     def _chunk_requests_items_split_retries(
@@ -254,7 +239,7 @@ class CDFResourceAPI(Generic[T_Identifier, T_RequestResource, T_ResponseResource
             grouped_items[key].append(item)
         return grouped_items
 
-    def _iterate(
+    def _paginate(
         self,
         limit: int,
         cursor: str | None = None,
@@ -305,22 +290,35 @@ class CDFResourceAPI(Generic[T_Identifier, T_RequestResource, T_ResponseResource
         )
         result = self._http_client.request_single_retries(request)
         response = result.get_success_or_raise()
-        return self._page_response(response)
+        return self._validate_page_response(response)
 
-    def _list(
-        self, limit: int | None = None, params: dict[str, Any] | None = None, endpoint_path: str | None = None
-    ) -> list[T_ResponseResource]:
-        """List all resources, handling pagination automatically."""
-        all_items: list[T_ResponseResource] = []
-        next_cursor: str | None = None
+    def _iterate(
+        self,
+        limit: int | None = None,
+        cursor: str | None = None,
+        params: dict[str, Any] | None = None,
+        body: dict[str, Any] | None = None,
+        endpoint_path: str | None = None,
+    ) -> Iterable[list[T_ResponseResource]]:
+        """Iterate over all resources, handling pagination automatically."""
+        next_cursor = cursor
         total = 0
         endpoint = self._method_endpoint_map["list"]
         while True:
             page_limit = endpoint.item_limit if limit is None else min(limit - total, endpoint.item_limit)
-            page = self._iterate(limit=page_limit, cursor=next_cursor, params=params, endpoint_path=endpoint_path)
-            all_items.extend(page.items)
+            page = self._paginate(
+                limit=page_limit, cursor=next_cursor, params=params, body=body, endpoint_path=endpoint_path
+            )
+            yield page.items
             total += len(page.items)
             if page.next_cursor is None or (limit is not None and total >= limit):
                 break
             next_cursor = page.next_cursor
-        return all_items
+
+    def _list(
+        self, limit: int | None = None, params: dict[str, Any] | None = None, endpoint_path: str | None = None
+    ) -> list[T_ResponseResource]:
+        """List all resources, handling pagination automatically."""
+        return [
+            item for batch in self._iterate(limit=limit, params=params, endpoint_path=endpoint_path) for item in batch
+        ]

cognite_toolkit/_cdf_tk/client/http_client/_data_classes2.py

@@ -1,5 +1,4 @@
 import gzip
-import sys
 from abc import ABC, abstractmethod
 from collections import UserList
 from collections.abc import Sequence
@@ -13,11 +12,6 @@ from cognite_toolkit._cdf_tk.client.http_client._exception import ToolkitAPIErro
 from cognite_toolkit._cdf_tk.client.http_client._tracker import ItemsRequestTracker
 from cognite_toolkit._cdf_tk.utils.useful_types import PrimitiveType
 
-if sys.version_info >= (3, 11):
-    pass
-else:
-    pass
-
 
 class HTTPResult2(BaseModel):
     def get_success_or_raise(self) -> "SuccessResponse2":
@@ -25,7 +19,11 @@ class HTTPResult2(BaseModel):
         if isinstance(self, SuccessResponse2):
             return self
         elif isinstance(self, FailedResponse2):
-            raise ToolkitAPIError(f"Request failed with status code {self.status_code}: {self.error.message}")
+            raise ToolkitAPIError(
+                f"Request failed with status code {self.status_code}: {self.error.message}",
+                missing=self.error.missing,  # type: ignore[arg-type]
+                duplicated=self.error.duplicated,  # type: ignore[arg-type]
+            )
         elif isinstance(self, FailedRequest2):
             raise ToolkitAPIError(f"Request failed with error: {self.error}")
         else:

cognite_toolkit/_cdf_tk/client/http_client/_exception.py

@@ -1,4 +1,13 @@
+from typing import Any
+
+
 class ToolkitAPIError(Exception):
     """Base class for all exceptions raised by the Cognite Toolkit API client."""
 
-    pass
+    def __init__(
+        self, message: str, missing: list[dict[str, Any]] | None = None, duplicated: list[dict[str, Any]] | None = None
+    ) -> None:
+        super().__init__(message)
+        self.message = message
+        self.missing = missing
+        self.duplicated = duplicated

cognite_toolkit/_cdf_tk/client/request_classes/base.py

@@ -0,0 +1,19 @@
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict
+from pydantic.alias_generators import to_camel
+
+
+class BaseModelRequest(BaseModel):
+    """Base class for all object. This includes resources and nested objects."""
+
+    model_config = ConfigDict(alias_generator=to_camel, extra="ignore", populate_by_name=True)
+
+    def dump(self, camel_case: bool = True) -> dict[str, Any]:
+        """Dump the object to a dictionary.
+
+        Args:
+            camel_case (bool): Whether to use camelCase for the keys. Default is True.
+
+        """
+        return self.model_dump(mode="json", by_alias=camel_case, exclude_unset=True)

cognite_toolkit/_cdf_tk/client/request_classes/filters.py

@@ -0,0 +1,38 @@
+import sys
+
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId, InternalId
+
+from .base import BaseModelRequest
+
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+class Filter(BaseModelRequest): ...
+
+
+class ClassicFilter(Filter):
+    asset_subtree_ids: list[ExternalId | InternalId] | None = None
+    data_set_ids: list[ExternalId | InternalId] | None = None
+
+    @classmethod
+    def from_asset_subtree_and_data_sets(
+        cls,
+        asset_subtree_id: str | int | list[str | int] | None = None,
+        data_set_id: str | int | list[str | int] | None = None,
+    ) -> Self:
+        return cls(
+            asset_subtree_ids=cls._as_internal_or_external_id_list(asset_subtree_id),
+            data_set_ids=cls._as_internal_or_external_id_list(data_set_id),
+        )
+
+    @classmethod
+    def _as_internal_or_external_id_list(
+        cls, id: str | int | list[str | int] | None
+    ) -> list[ExternalId | InternalId] | None:
+        if id is None:
+            return None
+        ids = id if isinstance(id, list) else [id]
+        return [ExternalId(external_id=item) if isinstance(item, str) else InternalId(id=item) for item in ids]

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/agent.py

@@ -2,7 +2,7 @@ from typing import Annotated, Any, Literal
 
 from pydantic import BeforeValidator, Field
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestResource, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestResource, ResponseResource
 from tests.test_unit.test_cdf_tk.test_tk_warnings.test_warnings_metatest import get_all_subclasses
 
 from .identifiers import ExternalId

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/annotation.py

@@ -2,7 +2,7 @@ from typing import Any, Literal, TypeAlias
 
 from pydantic import Field, JsonValue
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestUpdateable, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestUpdateable, ResponseResource
 
 from .identifiers import InternalId
 

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/asset.py

@@ -2,7 +2,7 @@ from typing import ClassVar, Literal
 
 from pydantic import JsonValue
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestUpdateable, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestUpdateable, ResponseResource
 
 from .identifiers import ExternalId
 

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_constraints.py

@@ -4,7 +4,7 @@ from typing import Annotated, Any, Literal
 from pydantic import Field, TypeAdapter, field_serializer
 from pydantic_core.core_schema import FieldSerializationInfo
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject
 
 from ._references import ContainerReference
 

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_container.py

@@ -3,7 +3,7 @@ from typing import Literal
 
 from pydantic import JsonValue
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestResource, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestResource, ResponseResource
 
 from ._constraints import Constraint
 from ._data_types import DataType

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_data_model.py

@@ -4,7 +4,7 @@ from typing import Any
 from pydantic import field_serializer
 from pydantic_core.core_schema import FieldSerializationInfo
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestResource, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestResource, ResponseResource
 
 from ._references import DataModelReference, ViewReference
 from ._view import ViewResponse

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_data_types.py

@@ -3,7 +3,7 @@ from typing import Annotated, Literal
 
 from pydantic import Field, TypeAdapter
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject
 
 from ._references import ContainerReference, ViewReference
 

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_indexes.py

@@ -3,7 +3,7 @@ from typing import Annotated, Literal
 
 from pydantic import Field, TypeAdapter
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject
 
 
 class IndexDefinition(BaseModelObject, ABC):

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_instance.py

@@ -3,7 +3,7 @@ from typing import Any, Generic, Literal
 
 from pydantic import JsonValue, field_serializer, field_validator
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import (
+from cognite_toolkit._cdf_tk.client.resource_classes.base import (
     BaseModelObject,
     RequestResource,
     ResponseResource,

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_references.py

@@ -2,7 +2,7 @@ from typing import Literal
 
 from pydantic import Field
 
-from cognite_toolkit._cdf_tk.client.data_classes.identifiers import Identifier
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import Identifier
 
 
 class SpaceReference(Identifier):

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_space.py

@@ -1,6 +1,6 @@
 from abc import ABC
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestResource, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestResource, ResponseResource
 
 from ._references import SpaceReference
 

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_view.py

@@ -4,7 +4,7 @@ from typing import Any, Literal
 from pydantic import Field, JsonValue, field_serializer, model_validator
 from pydantic_core.core_schema import FieldSerializationInfo
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestResource, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestResource, ResponseResource
 
 from ._data_types import DirectNodeRelation
 from ._references import ContainerReference, ViewReference

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/data_modeling/_view_property.py

@@ -4,7 +4,7 @@ from typing import Annotated, Any, Literal
 from pydantic import Field, JsonValue, TypeAdapter, field_serializer
 from pydantic_core.core_schema import FieldSerializationInfo
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject
 
 from ._data_types import DataType
 from ._references import ContainerDirectReference, ContainerReference, NodeReference, ViewDirectReference, ViewReference

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/dataset.py

@@ -1,6 +1,6 @@
 from typing import ClassVar
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import (
+from cognite_toolkit._cdf_tk.client.resource_classes.base import (
     BaseModelObject,
     RequestUpdateable,
     ResponseResource,

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/event.py

@@ -1,6 +1,6 @@
 from typing import ClassVar
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import (
+from cognite_toolkit._cdf_tk.client.resource_classes.base import (
     BaseModelObject,
     RequestUpdateable,
     ResponseResource,

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/extraction_pipeline.py

@@ -1,6 +1,6 @@
 from typing import ClassVar
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import (
+from cognite_toolkit._cdf_tk.client.resource_classes.base import (
     BaseModelObject,
     RequestUpdateable,
     ResponseResource,

cognite_toolkit/_cdf_tk/client/{data_classes → resource_classes}/filemetadata.py

@@ -2,7 +2,7 @@ from typing import ClassVar, Literal
 
 from pydantic import Field, JsonValue
 
-from cognite_toolkit._cdf_tk.client.data_classes.base import BaseModelObject, RequestUpdateable, ResponseResource
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestUpdateable, ResponseResource
 
 from .identifiers import ExternalId
 from .instance_api import NodeReference

cognite_toolkit/_cdf_tk/client/resource_classes/function.py

@@ -0,0 +1,53 @@
+from typing import Literal, TypeAlias
+
+from cognite_toolkit._cdf_tk.client.resource_classes.base import BaseModelObject, RequestResource, ResponseResource
+
+from .identifiers import ExternalId
+
+FunctionStatus: TypeAlias = Literal["Queued", "Deploying", "Ready", "Failed"]
+
+
+class FunctionBase(BaseModelObject):
+    """Base class for Function with common fields."""
+
+    external_id: str | None = None
+    name: str
+    file_id: int
+    description: str | None = None
+    owner: str | None = None
+    function_path: str | None = None
+    secrets: dict[str, str] | None = None
+    env_vars: dict[str, str] | None = None
+    cpu: float | None = None
+    memory: float | None = None
+    runtime: Literal["py310", "py311", "py312"] | None = None
+    runtime_version: str | None = None
+    metadata: dict[str, str] | None = None
+    index_url: str | None = None
+    extra_index_urls: list[str] | None = None
+
+
+class FunctionRequest(FunctionBase, RequestResource):
+    """Request resource for creating/updating functions."""
+
+    def as_id(self) -> ExternalId:
+        if self.external_id is None:
+            raise ValueError("Cannot create ExternalId: external_id is None")
+        return ExternalId(external_id=self.external_id)
+
+
+class FunctionAPIError(BaseModelObject):
+    code: int
+    message: str
+
+
+class FunctionResponse(FunctionBase, ResponseResource[FunctionRequest]):
+    """Response resource for functions."""
+
+    id: int
+    created_time: int
+    status: FunctionStatus | None = None
+    error: FunctionAPIError | None = None
+
+    def as_request_resource(self) -> FunctionRequest:
+        return FunctionRequest.model_validate(self.dump(), extra="ignore")

cognite_toolkit/_cdf_tk/client/resource_classes/function_schedule.py

@@ -0,0 +1,61 @@
+from pydantic import Field, JsonValue
+
+from cognite_toolkit._cdf_tk.client.resource_classes.base import (
+    BaseModelObject,
+    Identifier,
+    RequestResource,
+    ResponseResource,
+)
+
+
+class FunctionScheduleId(Identifier):
+    """Identifier for a function schedule."""
+
+    function_external_id: str
+    name: str
+
+    def __str__(self) -> str:
+        return f"functionExternalId='{self.function_external_id}', name='{self.name}'"
+
+
+class FunctionScheduleCredentials(BaseModelObject):
+    """Credentials for function schedule authentication."""
+
+    client_id: str
+    client_secret: str
+
+
+class FunctionSchedule(BaseModelObject):
+    """Base class for function schedule with common fields."""
+
+    name: str
+    cron_expression: str
+    description: str | None = None
+    data: dict[str, JsonValue] | None = None
+
+
+class FunctionScheduleRequest(FunctionSchedule, RequestResource):
+    """Request resource for creating/updating function schedules."""
+
+    function_id: int
+    function_external_id: str | None = Field(None, exclude=True)
+    nonce: str
+
+    def as_id(self) -> FunctionScheduleId:
+        if self.function_external_id is None:
+            raise ValueError("function_external_id must be set to create FunctionScheduleId")
+        return FunctionScheduleId(function_external_id=self.function_external_id, name=self.name)
+
+
+class FunctionScheduleResponse(FunctionSchedule, ResponseResource[FunctionScheduleRequest]):
+    """Response resource for function schedules."""
+
+    id: int
+    created_time: int
+    when: str
+    function_id: int | None = None
+    function_external_id: str | None = None
+    session_id: int | None = None
+
+    def as_request_resource(self) -> FunctionScheduleRequest:
+        raise NotImplementedError("Cannot convert to request resource as 'nonce' is missing.")