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

hatchet_sdk/clients/rest/api/workflow_runs_api.py

@@ -915,6 +915,284 @@ class WorkflowRunsApi:
             _request_auth=_request_auth,
         )
 
+    @validate_call
+    def v1_workflow_run_get_status(
+        self,
+        v1_workflow_run: Annotated[
+            str,
+            Field(
+                min_length=36,
+                strict=True,
+                max_length=36,
+                description="The workflow run id to get the status for",
+            ),
+        ],
+        _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,
+    ) -> V1TaskStatus:
+        """Get workflow run status
+
+        Get the status of a workflow run.
+
+        :param v1_workflow_run: The workflow run id to get the status for (required)
+        :type v1_workflow_run: 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_workflow_run_get_status_serialize(
+            v1_workflow_run=v1_workflow_run,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "V1TaskStatus",
+            "400": "APIErrors",
+            "403": "APIErrors",
+            "404": "APIErrors",
+            "501": "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_workflow_run_get_status_with_http_info(
+        self,
+        v1_workflow_run: Annotated[
+            str,
+            Field(
+                min_length=36,
+                strict=True,
+                max_length=36,
+                description="The workflow run id to get the status for",
+            ),
+        ],
+        _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[V1TaskStatus]:
+        """Get workflow run status
+
+        Get the status of a workflow run.
+
+        :param v1_workflow_run: The workflow run id to get the status for (required)
+        :type v1_workflow_run: 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_workflow_run_get_status_serialize(
+            v1_workflow_run=v1_workflow_run,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "V1TaskStatus",
+            "400": "APIErrors",
+            "403": "APIErrors",
+            "404": "APIErrors",
+            "501": "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_workflow_run_get_status_without_preload_content(
+        self,
+        v1_workflow_run: Annotated[
+            str,
+            Field(
+                min_length=36,
+                strict=True,
+                max_length=36,
+                description="The workflow run id to get the status for",
+            ),
+        ],
+        _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:
+        """Get workflow run status
+
+        Get the status of a workflow run.
+
+        :param v1_workflow_run: The workflow run id to get the status for (required)
+        :type v1_workflow_run: 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_workflow_run_get_status_serialize(
+            v1_workflow_run=v1_workflow_run,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "V1TaskStatus",
+            "400": "APIErrors",
+            "403": "APIErrors",
+            "404": "APIErrors",
+            "501": "APIErrors",
+        }
+        response_data = self.api_client.call_api(
+            *_param, _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+    def _v1_workflow_run_get_status_serialize(
+        self,
+        v1_workflow_run,
+        _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 v1_workflow_run is not None:
+            _path_params["v1-workflow-run"] = v1_workflow_run
+        # 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/workflow-runs/{v1-workflow-run}/status",
+            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_workflow_run_get_timings(
         self,
@@ -1264,6 +1542,12 @@ class WorkflowRunsApi:
                 description="The external id of the event that triggered the workflow run"
             ),
         ] = None,
+        include_payloads: Annotated[
+            Optional[StrictBool],
+            Field(
+                description="A flag for whether or not to include the input and output payloads in the response. Defaults to `true` if unset."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1304,6 +1588,8 @@ class WorkflowRunsApi:
         :type parent_task_external_id: str
         :param triggering_event_external_id: The external id of the event that triggered the workflow run
         :type triggering_event_external_id: str
+        :param include_payloads: A flag for whether or not to include the input and output payloads in the response. Defaults to `true` if unset.
+        :type include_payloads: bool
         :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
@@ -1339,6 +1625,7 @@ class WorkflowRunsApi:
             worker_id=worker_id,
             parent_task_external_id=parent_task_external_id,
             triggering_event_external_id=triggering_event_external_id,
+            include_payloads=include_payloads,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1411,6 +1698,12 @@ class WorkflowRunsApi:
                 description="The external id of the event that triggered the workflow run"
             ),
         ] = None,
+        include_payloads: Annotated[
+            Optional[StrictBool],
+            Field(
+                description="A flag for whether or not to include the input and output payloads in the response. Defaults to `true` if unset."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1451,6 +1744,8 @@ class WorkflowRunsApi:
         :type parent_task_external_id: str
         :param triggering_event_external_id: The external id of the event that triggered the workflow run
         :type triggering_event_external_id: str
+        :param include_payloads: A flag for whether or not to include the input and output payloads in the response. Defaults to `true` if unset.
+        :type include_payloads: bool
         :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
@@ -1486,6 +1781,7 @@ class WorkflowRunsApi:
             worker_id=worker_id,
             parent_task_external_id=parent_task_external_id,
             triggering_event_external_id=triggering_event_external_id,
+            include_payloads=include_payloads,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1558,6 +1854,12 @@ class WorkflowRunsApi:
                 description="The external id of the event that triggered the workflow run"
             ),
         ] = None,
+        include_payloads: Annotated[
+            Optional[StrictBool],
+            Field(
+                description="A flag for whether or not to include the input and output payloads in the response. Defaults to `true` if unset."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1598,6 +1900,8 @@ class WorkflowRunsApi:
         :type parent_task_external_id: str
         :param triggering_event_external_id: The external id of the event that triggered the workflow run
         :type triggering_event_external_id: str
+        :param include_payloads: A flag for whether or not to include the input and output payloads in the response. Defaults to `true` if unset.
+        :type include_payloads: bool
         :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
@@ -1633,6 +1937,7 @@ class WorkflowRunsApi:
             worker_id=worker_id,
             parent_task_external_id=parent_task_external_id,
             triggering_event_external_id=triggering_event_external_id,
+            include_payloads=include_payloads,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1664,6 +1969,7 @@ class WorkflowRunsApi:
         worker_id,
         parent_task_external_id,
         triggering_event_external_id,
+        include_payloads,
         _request_auth,
         _content_type,
         _headers,
@@ -1751,6 +2057,10 @@ class WorkflowRunsApi:
                 ("triggering_event_external_id", triggering_event_external_id)
             )
 
+        if include_payloads is not None:
+
+            _query_params.append(("include_payloads", include_payloads))
+
         # process the header parameters
         # process the form parameters
         # process the body parameter

hatchet_sdk/clients/rest/models/__init__.py

@@ -171,6 +171,7 @@ from hatchet_sdk.clients.rest.models.tenant_resource_policy import TenantResourc
 from hatchet_sdk.clients.rest.models.tenant_step_run_queue_metrics import (
     TenantStepRunQueueMetrics,
 )
+from hatchet_sdk.clients.rest.models.tenant_ui_version import TenantUIVersion
 from hatchet_sdk.clients.rest.models.tenant_version import TenantVersion
 from hatchet_sdk.clients.rest.models.trigger_workflow_run_request import (
     TriggerWorkflowRunRequest,
@@ -200,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,
 )
@@ -225,6 +227,9 @@ from hatchet_sdk.clients.rest.models.v1_task_timing_list import V1TaskTimingList
 from hatchet_sdk.clients.rest.models.v1_trigger_workflow_run_request import (
     V1TriggerWorkflowRunRequest,
 )
+from hatchet_sdk.clients.rest.models.v1_update_filter_request import (
+    V1UpdateFilterRequest,
+)
 from hatchet_sdk.clients.rest.models.v1_workflow_run import V1WorkflowRun
 from hatchet_sdk.clients.rest.models.v1_workflow_run_details import V1WorkflowRunDetails
 from hatchet_sdk.clients.rest.models.v1_workflow_run_display_name import (

hatchet_sdk/clients/rest/models/create_tenant_request.py

@@ -22,6 +22,9 @@ from typing import Any, ClassVar, Dict, List, Optional, Set
 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):
     """
@@ -30,7 +33,17 @@ class CreateTenantRequest(BaseModel):
 
     name: StrictStr = Field(description="The name of the tenant.")
     slug: StrictStr = Field(description="The slug of the tenant.")
-    __properties: ClassVar[List[str]] = ["name", "slug"]
+    ui_version: Optional[TenantUIVersion] = Field(
+        default=None,
+        description="The UI version of the tenant. Defaults to V0.",
+        alias="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,
@@ -80,5 +93,12 @@ class CreateTenantRequest(BaseModel):
         if not isinstance(obj, dict):
             return cls.model_validate(obj)
 
-        _obj = cls.model_validate({"name": obj.get("name"), "slug": obj.get("slug")})
+        _obj = cls.model_validate(
+            {
+                "name": obj.get("name"),
+                "slug": obj.get("slug"),
+                "uiVersion": obj.get("uiVersion"),
+                "engineVersion": obj.get("engineVersion"),
+            }
+        )
         return _obj

hatchet_sdk/clients/rest/models/tenant.py

@@ -23,6 +23,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing_extensions import Self
 
 from hatchet_sdk.clients.rest.models.api_resource_meta import APIResourceMeta
+from hatchet_sdk.clients.rest.models.tenant_ui_version import TenantUIVersion
 from hatchet_sdk.clients.rest.models.tenant_version import TenantVersion
 
 
@@ -45,6 +46,9 @@ class Tenant(BaseModel):
         alias="alertMemberEmails",
     )
     version: TenantVersion = Field(description="The version of the tenant.")
+    ui_version: Optional[TenantUIVersion] = Field(
+        default=None, description="The UI of the tenant.", alias="uiVersion"
+    )
     __properties: ClassVar[List[str]] = [
         "metadata",
         "name",
@@ -52,6 +56,7 @@ class Tenant(BaseModel):
         "analyticsOptOut",
         "alertMemberEmails",
         "version",
+        "uiVersion",
     ]
 
     model_config = ConfigDict(
@@ -117,6 +122,7 @@ class Tenant(BaseModel):
                 "analyticsOptOut": obj.get("analyticsOptOut"),
                 "alertMemberEmails": obj.get("alertMemberEmails"),
                 "version": obj.get("version"),
+                "uiVersion": obj.get("uiVersion"),
             }
         )
         return _obj

hatchet_sdk/clients/rest/models/tenant_ui_version.py

@@ -0,0 +1,37 @@
+# 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
+from enum import Enum
+
+from typing_extensions import Self
+
+
+class TenantUIVersion(str, Enum):
+    """
+    TenantUIVersion
+    """
+
+    """
+    allowed enum values
+    """
+    V0 = "V0"
+    V1 = "V1"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TenantUIVersion from a JSON string"""
+        return cls(json.loads(json_str))

hatchet_sdk/clients/rest/models/update_tenant_request.py

@@ -22,6 +22,7 @@ from typing import Any, ClassVar, Dict, List, Optional, Set
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, 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
 
 
@@ -66,6 +67,9 @@ class UpdateTenantRequest(BaseModel):
     version: Optional[TenantVersion] = Field(
         default=None, description="The version of the tenant."
     )
+    ui_version: Optional[TenantUIVersion] = Field(
+        default=None, description="The UI of the tenant.", alias="uiVersion"
+    )
     __properties: ClassVar[List[str]] = [
         "name",
         "analyticsOptOut",
@@ -75,6 +79,7 @@ class UpdateTenantRequest(BaseModel):
         "enableTenantResourceLimitAlerts",
         "maxAlertingFrequency",
         "version",
+        "uiVersion",
     ]
 
     model_config = ConfigDict(
@@ -139,6 +144,7 @@ class UpdateTenantRequest(BaseModel):
                 ),
                 "maxAlertingFrequency": obj.get("maxAlertingFrequency"),
                 "version": obj.get("version"),
+                "uiVersion": obj.get("uiVersion"),
             }
         )
         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