hatchet-sdk 1.12.0__py3-none-any.whl → 1.12.1__py3-none-any.whl

hatchet_sdk/clients/events.py

@@ -10,8 +10,12 @@ from hatchet_sdk.clients.rest.api.event_api import EventApi
 from hatchet_sdk.clients.rest.api.workflow_runs_api import WorkflowRunsApi
 from hatchet_sdk.clients.rest.api_client import ApiClient
 from hatchet_sdk.clients.rest.models.v1_event_list import V1EventList
+from hatchet_sdk.clients.rest.models.v1_task_status import V1TaskStatus
 from hatchet_sdk.clients.rest.tenacity_utils import tenacity_retry
-from hatchet_sdk.clients.v1.api_client import BaseRestClient
+from hatchet_sdk.clients.v1.api_client import (
+    BaseRestClient,
+    maybe_additional_metadata_to_kv,
+)
 from hatchet_sdk.config import ClientConfig
 from hatchet_sdk.connection import new_conn
 from hatchet_sdk.contracts.events_pb2 import (
@@ -211,9 +215,24 @@ class EventClient(BaseRestClient):
         keys: list[str] | None = None,
         since: datetime.datetime | None = None,
         until: datetime.datetime | None = None,
+        workflow_ids: list[str] | None = None,
+        workflow_run_statuses: list[V1TaskStatus] | None = None,
+        event_ids: list[str] | None = None,
+        additional_metadata: JSONSerializableMapping | None = None,
+        scopes: list[str] | None = None,
     ) -> V1EventList:
         return await asyncio.to_thread(
-            self.list, offset=offset, limit=limit, keys=keys, since=since, until=until
+            self.list,
+            offset=offset,
+            limit=limit,
+            keys=keys,
+            since=since,
+            until=until,
+            workflow_ids=workflow_ids,
+            workflow_run_statuses=workflow_run_statuses,
+            event_ids=event_ids,
+            additional_metadata=additional_metadata,
+            scopes=scopes,
         )
 
     def list(
@@ -223,6 +242,11 @@ class EventClient(BaseRestClient):
         keys: list[str] | None = None,
         since: datetime.datetime | None = None,
         until: datetime.datetime | None = None,
+        workflow_ids: list[str] | None = None,
+        workflow_run_statuses: list[V1TaskStatus] | None = None,
+        event_ids: list[str] | None = None,
+        additional_metadata: JSONSerializableMapping | None = None,
+        scopes: list[str] | None = None,
     ) -> V1EventList:
         with self.client() as client:
             return self._ea(client).v1_event_list(
@@ -232,4 +256,11 @@ class EventClient(BaseRestClient):
                 keys=keys,
                 since=since,
                 until=until,
+                workflow_ids=workflow_ids,
+                workflow_run_statuses=workflow_run_statuses,
+                event_ids=event_ids,
+                additional_metadata=maybe_additional_metadata_to_kv(
+                    additional_metadata
+                ),
+                scopes=scopes,
             )

hatchet_sdk/clients/rest/__init__.py

@@ -237,6 +237,7 @@ from hatchet_sdk.clients.rest.models.v1_create_filter_request import (
 from hatchet_sdk.clients.rest.models.v1_dag_children import V1DagChildren
 from hatchet_sdk.clients.rest.models.v1_event import V1Event
 from hatchet_sdk.clients.rest.models.v1_event_list import V1EventList
+from hatchet_sdk.clients.rest.models.v1_event_triggered_run import V1EventTriggeredRun
 from hatchet_sdk.clients.rest.models.v1_event_workflow_run_summary import (
     V1EventWorkflowRunSummary,
 )

hatchet_sdk/clients/rest/api/event_api.py

@@ -39,6 +39,7 @@ from hatchet_sdk.clients.rest.models.event_update_cancel200_response import (
 from hatchet_sdk.clients.rest.models.events import Events
 from hatchet_sdk.clients.rest.models.replay_event_request import ReplayEventRequest
 from hatchet_sdk.clients.rest.models.v1_event_list import V1EventList
+from hatchet_sdk.clients.rest.models.v1_task_status import V1TaskStatus
 from hatchet_sdk.clients.rest.models.workflow_run_status import WorkflowRunStatus
 from hatchet_sdk.clients.rest.rest import RESTResponseType
 
@@ -2549,6 +2550,269 @@ class EventApi:
             _request_auth=_request_auth,
         )
 
+    @validate_call
+    def v1_event_key_list(
+        self,
+        tenant: Annotated[
+            str,
+            Field(
+                min_length=36, strict=True, max_length=36, description="The tenant id"
+            ),
+        ],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
+            ],
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> EventKeyList:
+        """List event keys
+
+        Lists all event keys for a tenant.
+
+        :param tenant: The tenant id (required)
+        :type tenant: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """  # noqa: E501
+
+        _param = self._v1_event_key_list_serialize(
+            tenant=tenant,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "EventKeyList",
+            "400": "APIErrors",
+            "403": "APIErrors",
+        }
+        response_data = self.api_client.call_api(
+            *_param, _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+    @validate_call
+    def v1_event_key_list_with_http_info(
+        self,
+        tenant: Annotated[
+            str,
+            Field(
+                min_length=36, strict=True, max_length=36, description="The tenant id"
+            ),
+        ],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
+            ],
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[EventKeyList]:
+        """List event keys
+
+        Lists all event keys for a tenant.
+
+        :param tenant: The tenant id (required)
+        :type tenant: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """  # noqa: E501
+
+        _param = self._v1_event_key_list_serialize(
+            tenant=tenant,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "EventKeyList",
+            "400": "APIErrors",
+            "403": "APIErrors",
+        }
+        response_data = self.api_client.call_api(
+            *_param, _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+    @validate_call
+    def v1_event_key_list_without_preload_content(
+        self,
+        tenant: Annotated[
+            str,
+            Field(
+                min_length=36, strict=True, max_length=36, description="The tenant id"
+            ),
+        ],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
+            ],
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """List event keys
+
+        Lists all event keys for a tenant.
+
+        :param tenant: The tenant id (required)
+        :type tenant: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """  # noqa: E501
+
+        _param = self._v1_event_key_list_serialize(
+            tenant=tenant,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "EventKeyList",
+            "400": "APIErrors",
+            "403": "APIErrors",
+        }
+        response_data = self.api_client.call_api(
+            *_param, _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+    def _v1_event_key_list_serialize(
+        self,
+        tenant,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {}
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if tenant is not None:
+            _path_params["tenant"] = tenant
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+        # set the HTTP header `Accept`
+        if "Accept" not in _header_params:
+            _header_params["Accept"] = self.api_client.select_header_accept(
+                ["application/json"]
+            )
+
+        # authentication setting
+        _auth_settings: List[str] = ["cookieAuth", "bearerAuth"]
+
+        return self.api_client.param_serialize(
+            method="GET",
+            resource_path="/api/v1/stable/tenants/{tenant}/events/keys",
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth,
+        )
+
     @validate_call
     def v1_event_list(
         self,
@@ -2575,6 +2839,34 @@ class EventApi:
             Optional[datetime],
             Field(description="Consider events that occurred before this time"),
         ] = None,
+        workflow_ids: Annotated[
+            Optional[
+                List[Annotated[str, Field(min_length=36, strict=True, max_length=36)]]
+            ],
+            Field(
+                description="Filter to events that are associated with a specific workflow run"
+            ),
+        ] = None,
+        workflow_run_statuses: Annotated[
+            Optional[List[V1TaskStatus]],
+            Field(
+                description="Filter to events that are associated with workflow runs matching a certain status"
+            ),
+        ] = None,
+        event_ids: Annotated[
+            Optional[
+                List[Annotated[str, Field(min_length=36, strict=True, max_length=36)]]
+            ],
+            Field(description="Filter to specific events by their ids"),
+        ] = None,
+        additional_metadata: Annotated[
+            Optional[List[Annotated[str, Field(min_length=1, strict=True)]]],
+            Field(description="Filter by additional metadata on the events"),
+        ] = None,
+        scopes: Annotated[
+            Optional[List[Annotated[str, Field(min_length=1, strict=True)]]],
+            Field(description="The scopes to filter by"),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -2603,6 +2895,16 @@ class EventApi:
         :type since: datetime
         :param until: Consider events that occurred before this time
         :type until: datetime
+        :param workflow_ids: Filter to events that are associated with a specific workflow run
+        :type workflow_ids: List[str]
+        :param workflow_run_statuses: Filter to events that are associated with workflow runs matching a certain status
+        :type workflow_run_statuses: List[V1TaskStatus]
+        :param event_ids: Filter to specific events by their ids
+        :type event_ids: List[str]
+        :param additional_metadata: Filter by additional metadata on the events
+        :type additional_metadata: List[str]
+        :param scopes: The scopes to filter by
+        :type scopes: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -2632,6 +2934,11 @@ class EventApi:
             keys=keys,
             since=since,
             until=until,
+            workflow_ids=workflow_ids,
+            workflow_run_statuses=workflow_run_statuses,
+            event_ids=event_ids,
+            additional_metadata=additional_metadata,
+            scopes=scopes,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -2678,6 +2985,34 @@ class EventApi:
             Optional[datetime],
             Field(description="Consider events that occurred before this time"),
         ] = None,
+        workflow_ids: Annotated[
+            Optional[
+                List[Annotated[str, Field(min_length=36, strict=True, max_length=36)]]
+            ],
+            Field(
+                description="Filter to events that are associated with a specific workflow run"
+            ),
+        ] = None,
+        workflow_run_statuses: Annotated[
+            Optional[List[V1TaskStatus]],
+            Field(
+                description="Filter to events that are associated with workflow runs matching a certain status"
+            ),
+        ] = None,
+        event_ids: Annotated[
+            Optional[
+                List[Annotated[str, Field(min_length=36, strict=True, max_length=36)]]
+            ],
+            Field(description="Filter to specific events by their ids"),
+        ] = None,
+        additional_metadata: Annotated[
+            Optional[List[Annotated[str, Field(min_length=1, strict=True)]]],
+            Field(description="Filter by additional metadata on the events"),
+        ] = None,
+        scopes: Annotated[
+            Optional[List[Annotated[str, Field(min_length=1, strict=True)]]],
+            Field(description="The scopes to filter by"),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -2706,6 +3041,16 @@ class EventApi:
         :type since: datetime
         :param until: Consider events that occurred before this time
         :type until: datetime
+        :param workflow_ids: Filter to events that are associated with a specific workflow run
+        :type workflow_ids: List[str]
+        :param workflow_run_statuses: Filter to events that are associated with workflow runs matching a certain status
+        :type workflow_run_statuses: List[V1TaskStatus]
+        :param event_ids: Filter to specific events by their ids
+        :type event_ids: List[str]
+        :param additional_metadata: Filter by additional metadata on the events
+        :type additional_metadata: List[str]
+        :param scopes: The scopes to filter by
+        :type scopes: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -2735,6 +3080,11 @@ class EventApi:
             keys=keys,
             since=since,
             until=until,
+            workflow_ids=workflow_ids,
+            workflow_run_statuses=workflow_run_statuses,
+            event_ids=event_ids,
+            additional_metadata=additional_metadata,
+            scopes=scopes,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -2781,6 +3131,34 @@ class EventApi:
             Optional[datetime],
             Field(description="Consider events that occurred before this time"),
         ] = None,
+        workflow_ids: Annotated[
+            Optional[
+                List[Annotated[str, Field(min_length=36, strict=True, max_length=36)]]
+            ],
+            Field(
+                description="Filter to events that are associated with a specific workflow run"
+            ),
+        ] = None,
+        workflow_run_statuses: Annotated[
+            Optional[List[V1TaskStatus]],
+            Field(
+                description="Filter to events that are associated with workflow runs matching a certain status"
+            ),
+        ] = None,
+        event_ids: Annotated[
+            Optional[
+                List[Annotated[str, Field(min_length=36, strict=True, max_length=36)]]
+            ],
+            Field(description="Filter to specific events by their ids"),
+        ] = None,
+        additional_metadata: Annotated[
+            Optional[List[Annotated[str, Field(min_length=1, strict=True)]]],
+            Field(description="Filter by additional metadata on the events"),
+        ] = None,
+        scopes: Annotated[
+            Optional[List[Annotated[str, Field(min_length=1, strict=True)]]],
+            Field(description="The scopes to filter by"),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -2809,6 +3187,16 @@ class EventApi:
         :type since: datetime
         :param until: Consider events that occurred before this time
         :type until: datetime
+        :param workflow_ids: Filter to events that are associated with a specific workflow run
+        :type workflow_ids: List[str]
+        :param workflow_run_statuses: Filter to events that are associated with workflow runs matching a certain status
+        :type workflow_run_statuses: List[V1TaskStatus]
+        :param event_ids: Filter to specific events by their ids
+        :type event_ids: List[str]
+        :param additional_metadata: Filter by additional metadata on the events
+        :type additional_metadata: List[str]
+        :param scopes: The scopes to filter by
+        :type scopes: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -2838,6 +3226,11 @@ class EventApi:
             keys=keys,
             since=since,
             until=until,
+            workflow_ids=workflow_ids,
+            workflow_run_statuses=workflow_run_statuses,
+            event_ids=event_ids,
+            additional_metadata=additional_metadata,
+            scopes=scopes,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -2862,6 +3255,11 @@ class EventApi:
         keys,
         since,
         until,
+        workflow_ids,
+        workflow_run_statuses,
+        event_ids,
+        additional_metadata,
+        scopes,
         _request_auth,
         _content_type,
         _headers,
@@ -2872,6 +3270,11 @@ class EventApi:
 
         _collection_formats: Dict[str, str] = {
             "keys": "multi",
+            "workflowIds": "multi",
+            "workflowRunStatuses": "multi",
+            "eventIds": "multi",
+            "additionalMetadata": "multi",
+            "scopes": "multi",
         }
 
         _path_params: Dict[str, str] = {}
@@ -2921,6 +3324,26 @@ class EventApi:
             else:
                 _query_params.append(("until", until))
 
+        if workflow_ids is not None:
+
+            _query_params.append(("workflowIds", workflow_ids))
+
+        if workflow_run_statuses is not None:
+
+            _query_params.append(("workflowRunStatuses", workflow_run_statuses))
+
+        if event_ids is not None:
+
+            _query_params.append(("eventIds", event_ids))
+
+        if additional_metadata is not None:
+
+            _query_params.append(("additionalMetadata", additional_metadata))
+
+        if scopes is not None:
+
+            _query_params.append(("scopes", scopes))
+
         # process the header parameters
         # process the form parameters
         # process the body parameter

hatchet_sdk/clients/rest/models/__init__.py

@@ -201,6 +201,7 @@ from hatchet_sdk.clients.rest.models.v1_create_filter_request import (
 from hatchet_sdk.clients.rest.models.v1_dag_children import V1DagChildren
 from hatchet_sdk.clients.rest.models.v1_event import V1Event
 from hatchet_sdk.clients.rest.models.v1_event_list import V1EventList
+from hatchet_sdk.clients.rest.models.v1_event_triggered_run import V1EventTriggeredRun
 from hatchet_sdk.clients.rest.models.v1_event_workflow_run_summary import (
     V1EventWorkflowRunSummary,
 )

hatchet_sdk/clients/rest/models/create_tenant_request.py

@@ -23,6 +23,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing_extensions import Self
 
 from hatchet_sdk.clients.rest.models.tenant_ui_version import TenantUIVersion
+from hatchet_sdk.clients.rest.models.tenant_version import TenantVersion
 
 
 class CreateTenantRequest(BaseModel):
@@ -37,7 +38,12 @@ class CreateTenantRequest(BaseModel):
         description="The UI version of the tenant. Defaults to V0.",
         alias="uiVersion",
     )
-    __properties: ClassVar[List[str]] = ["name", "slug", "uiVersion"]
+    engine_version: Optional[TenantVersion] = Field(
+        default=None,
+        description="The engine version of the tenant. Defaults to V0.",
+        alias="engineVersion",
+    )
+    __properties: ClassVar[List[str]] = ["name", "slug", "uiVersion", "engineVersion"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -92,6 +98,7 @@ class CreateTenantRequest(BaseModel):
                 "name": obj.get("name"),
                 "slug": obj.get("slug"),
                 "uiVersion": obj.get("uiVersion"),
+                "engineVersion": obj.get("engineVersion"),
             }
         )
         return _obj

hatchet_sdk/clients/rest/models/v1_event.py

@@ -17,6 +17,7 @@ from __future__ import annotations
 import json
 import pprint
 import re  # noqa: F401
+from datetime import datetime
 from typing import Any, ClassVar, Dict, List, Optional, Set
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
@@ -24,6 +25,7 @@ from typing_extensions import Self
 
 from hatchet_sdk.clients.rest.models.api_resource_meta import APIResourceMeta
 from hatchet_sdk.clients.rest.models.tenant import Tenant
+from hatchet_sdk.clients.rest.models.v1_event_triggered_run import V1EventTriggeredRun
 from hatchet_sdk.clients.rest.models.v1_event_workflow_run_summary import (
     V1EventWorkflowRunSummary,
 )
@@ -51,6 +53,24 @@ class V1Event(BaseModel):
         description="Additional metadata for the event.",
         alias="additionalMetadata",
     )
+    payload: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="The payload of the event, which can be any JSON-serializable object.",
+    )
+    scope: Optional[StrictStr] = Field(
+        default=None,
+        description="The scope of the event, which can be used to filter or categorize events.",
+    )
+    seen_at: Optional[datetime] = Field(
+        default=None,
+        description="The timestamp when the event was seen.",
+        alias="seenAt",
+    )
+    triggered_runs: Optional[List[V1EventTriggeredRun]] = Field(
+        default=None,
+        description="The external IDs of the runs that were triggered by this event.",
+        alias="triggeredRuns",
+    )
     __properties: ClassVar[List[str]] = [
         "metadata",
         "key",
@@ -58,6 +78,10 @@ class V1Event(BaseModel):
         "tenantId",
         "workflowRunSummary",
         "additionalMetadata",
+        "payload",
+        "scope",
+        "seenAt",
+        "triggeredRuns",
     ]
 
     model_config = ConfigDict(
@@ -106,6 +130,13 @@ class V1Event(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of workflow_run_summary
         if self.workflow_run_summary:
             _dict["workflowRunSummary"] = self.workflow_run_summary.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in triggered_runs (list)
+        _items = []
+        if self.triggered_runs:
+            for _item_triggered_runs in self.triggered_runs:
+                if _item_triggered_runs:
+                    _items.append(_item_triggered_runs.to_dict())
+            _dict["triggeredRuns"] = _items
         return _dict
 
     @classmethod
@@ -137,6 +168,17 @@ class V1Event(BaseModel):
                     else None
                 ),
                 "additionalMetadata": obj.get("additionalMetadata"),
+                "payload": obj.get("payload"),
+                "scope": obj.get("scope"),
+                "seenAt": obj.get("seenAt"),
+                "triggeredRuns": (
+                    [
+                        V1EventTriggeredRun.from_dict(_item)
+                        for _item in obj["triggeredRuns"]
+                    ]
+                    if obj.get("triggeredRuns") is not None
+                    else None
+                ),
             }
         )
         return _obj

hatchet_sdk/clients/rest/models/v1_event_triggered_run.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Hatchet API
+
+    The Hatchet API
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Annotated, Self
+
+
+class V1EventTriggeredRun(BaseModel):
+    """
+    V1EventTriggeredRun
+    """  # noqa: E501
+
+    workflow_run_id: Annotated[
+        str, Field(min_length=36, strict=True, max_length=36)
+    ] = Field(
+        description="The external ID of the triggered run.", alias="workflowRunId"
+    )
+    filter_id: Optional[StrictStr] = Field(
+        default=None,
+        description="The ID of the filter that triggered the run, if applicable.",
+        alias="filterId",
+    )
+    __properties: ClassVar[List[str]] = ["workflowRunId", "filterId"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V1EventTriggeredRun from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1EventTriggeredRun from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"workflowRunId": obj.get("workflowRunId"), "filterId": obj.get("filterId")}
+        )
+        return _obj

{hatchet_sdk-1.12.0.dist-info → hatchet_sdk-1.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hatchet-sdk
-Version: 1.12.0
+Version: 1.12.1
 Summary: 
 License: MIT
 Author: Alexander Belanger

{hatchet_sdk-1.12.0.dist-info → hatchet_sdk-1.12.1.dist-info}/RECORD

@@ -4,16 +4,16 @@ hatchet_sdk/clients/admin.py,sha256=B4fav9EYdsMbMqaH3GUEwL8sza1tQ3RORlwGXUb7qp0,
 hatchet_sdk/clients/dispatcher/action_listener.py,sha256=XUDXye-HW4V30DBgjd_dmq7e03AS9eBxUJi1VsvfSqE,13837
 hatchet_sdk/clients/dispatcher/dispatcher.py,sha256=LoxQEX5FS6v-qKRtOXoqsx3VlBUgFgTkbK58LU1eU3I,8176
 hatchet_sdk/clients/event_ts.py,sha256=MudFszIb9IcPKQYvBTzcatPkcWEy3nxbAtEQ0_NYxMg,2094
-hatchet_sdk/clients/events.py,sha256=AjNNoE_77AHqoH16vGn0-YG7f9WiowDUuI0NzB_Q7W8,7522
+hatchet_sdk/clients/events.py,sha256=gqxNZphGFkIzMKyvmLWaaWmFglXR95ZiQxkS_F1rXTY,8740
 hatchet_sdk/clients/listeners/durable_event_listener.py,sha256=jpqnbZsuouWk3XaOIYL9apaGtVk65eKKq66eBP9klBs,4085
 hatchet_sdk/clients/listeners/pooled_listener.py,sha256=1rodfIeqmHRF-u-PB6cBJbOU8NrvToLTyGigJMydpGo,8496
 hatchet_sdk/clients/listeners/run_event_listener.py,sha256=rIjBLRF7d7FBoEq7RKbmbOA84lX_hHSU26trwnthqV8,10230
 hatchet_sdk/clients/listeners/workflow_listener.py,sha256=EhBZZnHiidDLvAc4r54Re_LJXVypinbgTE9qKBybxj8,2054
-hatchet_sdk/clients/rest/__init__.py,sha256=27meuy5OTYKQAd5ZST_CBtod20SsSvkcDpSRKaqlsJA,17379
+hatchet_sdk/clients/rest/__init__.py,sha256=0bOD0KcR1mN8ZxEQuVBLJacaFehKKWGMinLeiVCi8dU,17466
 hatchet_sdk/clients/rest/api/__init__.py,sha256=Hha-Kw2hqeGf7j96pNzl3YlkHaD7HnEWGZCqvr18Vbk,1262
 hatchet_sdk/clients/rest/api/api_token_api.py,sha256=xzqMH_-wajBA0qLLs5Ta7tYg4FOLq0NjATyhZ1SV9jo,33433
 hatchet_sdk/clients/rest/api/default_api.py,sha256=Y0jEhatVpdIX_W2MCt_n40K6iKvVegDB70qxexkeZDI,88677
-hatchet_sdk/clients/rest/api/event_api.py,sha256=zUJXjB4OKT2tS6k0tKhOuUp9N9CCOaU7THI6DWXEa5Q,114856
+hatchet_sdk/clients/rest/api/event_api.py,sha256=R7OsLTAodCpHX8ynX0zxJqr5gB19nlmlohK-jeZPDu8,132097
 hatchet_sdk/clients/rest/api/filter_api.py,sha256=JernNvf6tqv35p85bkgxIxpIkuY8y668XyZONoEQ8oU,62955
 hatchet_sdk/clients/rest/api/github_api.py,sha256=yoCCZ33r5rQYp9b2pp36TGzjq-zORSYX1LMp5Ibsll8,12059
 hatchet_sdk/clients/rest/api/healthcheck_api.py,sha256=fr8DOMqCMe4igJFeyi0C2ZmAMlghJszAl2SQJMnUzKc,18683
@@ -34,7 +34,7 @@ hatchet_sdk/clients/rest/api_client.py,sha256=25vNKzpKVhvrGrU8T2YBLbz0Y7K0pKZwiL
 hatchet_sdk/clients/rest/api_response.py,sha256=rSuCVGY-HE8X_WwteQP5wyANIuS-L5AmtZEUOwTicak,641
 hatchet_sdk/clients/rest/configuration.py,sha256=ijGxGorVe8OEikJruwJ0hPk1Rc0OAKOqeUrfcoEiYH8,19333
 hatchet_sdk/clients/rest/exceptions.py,sha256=5PTEjyGxLeGP8U_qqc79QzR-sN7SOhzBwknSUC-BU4c,6365
-hatchet_sdk/clients/rest/models/__init__.py,sha256=E1zAaEv3GkQtU80XBqEifUO_2GfSgXen56o3C5TlOdA,15737
+hatchet_sdk/clients/rest/models/__init__.py,sha256=rKvfyD9B8tVISjMUxX-P2_wYOXGDdBdid5Af3-4x7h0,15824
 hatchet_sdk/clients/rest/models/accept_invite_request.py,sha256=_otOis3SuTHl0F_hhYD-rYqgyxCXRn83CK_eU9oMdn4,2427
 hatchet_sdk/clients/rest/models/api_error.py,sha256=KodK1_cc28CgYGvX1WhIhTN0pAAkgq8PJXReIrMnqBA,3068
 hatchet_sdk/clients/rest/models/api_errors.py,sha256=RNmnWn1GWlG9xTvpvrTmKq-Pr70x9mcJ4-dNFBemxa8,2917
@@ -57,7 +57,7 @@ hatchet_sdk/clients/rest/models/create_pull_request_from_step_run.py,sha256=YWYB
 hatchet_sdk/clients/rest/models/create_sns_integration_request.py,sha256=8xi59Xun0UGlNxJ7VuqHPAfqqH4takdtmZ673mK_6Og,2517
 hatchet_sdk/clients/rest/models/create_tenant_alert_email_group_request.py,sha256=MgMDiPtElEiiZU6boYVkOl9nSkvP9bnFjUIzByEn7WM,2488
 hatchet_sdk/clients/rest/models/create_tenant_invite_request.py,sha256=fVCrUaEcnKW8ekH4mPZpch1056i4tJVYHRyU9aDVuVE,2648
-hatchet_sdk/clients/rest/models/create_tenant_request.py,sha256=w3UzkUBjxdOlUbmF3DHGcvTCi079tXHrTfY0V-5LCUA,2898
+hatchet_sdk/clients/rest/models/create_tenant_request.py,sha256=ZKDe4BNp5DqVTlc10Ud10BaIwUcGay0i2sPl6W4Iv9Y,3232
 hatchet_sdk/clients/rest/models/cron_workflows.py,sha256=mHYhFHC-0NcA_sosCnYCqRiTYMvSbQQZiRCMTO4kgYc,4310
 hatchet_sdk/clients/rest/models/cron_workflows_list.py,sha256=bLMycEajkleH0-8gGuqDAvZDparvQ4LRKa2sX3bxsG0,3495
 hatchet_sdk/clients/rest/models/cron_workflows_method.py,sha256=zq05HHTwhf-D2kmhbf40ihYCDBihAeEMQEbr7DrtaoM,679
@@ -154,8 +154,9 @@ hatchet_sdk/clients/rest/models/user_tenant_public.py,sha256=-P2vPanI-paZmj_0nm7
 hatchet_sdk/clients/rest/models/v1_cancel_task_request.py,sha256=U0QKLQ7E35sgGSZyi-n3C9omZneqHVBMYymfD5a189g,3178
 hatchet_sdk/clients/rest/models/v1_create_filter_request.py,sha256=2OCv0o9bhgIF20L-KOXTvePbVI_G6eXTunGTNHMYEwg,3117
 hatchet_sdk/clients/rest/models/v1_dag_children.py,sha256=Rk_mKqboHebga12JhnQbN3yhrLXKm_hqtCbTfAdJliU,3135
-hatchet_sdk/clients/rest/models/v1_event.py,sha256=S5VkTg-o2v8ACJi_u6n4rO53K_wR7uiMutLsKv1KWB8,4695
+hatchet_sdk/clients/rest/models/v1_event.py,sha256=OvHE2pSuJZEtIRvV7y1kIL1M63_qz6UGsPCjT5Qz9Fk,6408
 hatchet_sdk/clients/rest/models/v1_event_list.py,sha256=miUX2fVgV_9dFHm6Kx3A09KSI8fRowbEwtfzImuTHfE,3447
+hatchet_sdk/clients/rest/models/v1_event_triggered_run.py,sha256=JBi9i3_XBosPqG95yjL92YdNVc-Yxa92JRaIrhxkEcU,2828
 hatchet_sdk/clients/rest/models/v1_event_workflow_run_summary.py,sha256=X09QH2HU7a7TV4A7xH6P5LxekWlWR_NOsPv9-E3Ncy8,3089
 hatchet_sdk/clients/rest/models/v1_filter.py,sha256=XKP8VAKRt3Ks1dZmo0ggtba5zTjIMWXkZuMSwZhDOLI,3899
 hatchet_sdk/clients/rest/models/v1_filter_list.py,sha256=TFeTo77aAs-3yeCdgCWHn2NRgflP1vpxd1XiylnGp5E,3455
@@ -520,7 +521,7 @@ hatchet_sdk/worker/runner/runner.py,sha256=9Z3Ac6hRh5rjet7-BRtpcFARlhWvy6TNrdsdj
 hatchet_sdk/worker/runner/utils/capture_logs.py,sha256=nHRPSiDBqzhObM7i2X7t03OupVFnE7kQBdR2Ckgg-2w,2709
 hatchet_sdk/worker/worker.py,sha256=SAucu3dg8lkKLbzb3noNWvClZ09lC5tuRcBkYZtIJ-0,16088
 hatchet_sdk/workflow_run.py,sha256=ZwH0HLFGFVXz6jbiqSv4w0Om2XuR52Tzzw6LH4y65jQ,2765
-hatchet_sdk-1.12.0.dist-info/METADATA,sha256=xNcz8LqA7q58RNPD0wc3srFJLdN4mQljSaIAP2n7-jI,3636
-hatchet_sdk-1.12.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-hatchet_sdk-1.12.0.dist-info/entry_points.txt,sha256=Un_76pcLse-ZGBlwebhQpnTPyQrripeHW8J7qmEpGOk,1400
-hatchet_sdk-1.12.0.dist-info/RECORD,,
+hatchet_sdk-1.12.1.dist-info/METADATA,sha256=LX6iYo3SfSNoTbSxjPLdTI8D2ygaNakRRLD_gcD1k58,3636
+hatchet_sdk-1.12.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+hatchet_sdk-1.12.1.dist-info/entry_points.txt,sha256=Un_76pcLse-ZGBlwebhQpnTPyQrripeHW8J7qmEpGOk,1400
+hatchet_sdk-1.12.1.dist-info/RECORD,,