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

hatchet_sdk/clients/rest/api/event_api.py

@@ -12,6 +12,7 @@
 """  # noqa: E501
 
 import warnings
+from datetime import datetime
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 from pydantic import Field, StrictFloat, StrictInt, StrictStr, validate_call
@@ -38,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
 
@@ -2548,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,
@@ -2566,6 +2831,42 @@ class EventApi:
         keys: Annotated[
             Optional[List[StrictStr]], Field(description="A list of keys to filter by")
         ] = None,
+        since: Annotated[
+            Optional[datetime],
+            Field(description="Consider events that occurred after this time"),
+        ] = None,
+        until: Annotated[
+            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)],
@@ -2590,6 +2891,20 @@ class EventApi:
         :type limit: int
         :param keys: A list of keys to filter by
         :type keys: List[str]
+        :param since: Consider events that occurred after this time
+        :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
@@ -2617,6 +2932,13 @@ class EventApi:
             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,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -2655,6 +2977,42 @@ class EventApi:
         keys: Annotated[
             Optional[List[StrictStr]], Field(description="A list of keys to filter by")
         ] = None,
+        since: Annotated[
+            Optional[datetime],
+            Field(description="Consider events that occurred after this time"),
+        ] = None,
+        until: Annotated[
+            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)],
@@ -2679,6 +3037,20 @@ class EventApi:
         :type limit: int
         :param keys: A list of keys to filter by
         :type keys: List[str]
+        :param since: Consider events that occurred after this time
+        :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
@@ -2706,6 +3078,13 @@ class EventApi:
             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,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -2744,6 +3123,42 @@ class EventApi:
         keys: Annotated[
             Optional[List[StrictStr]], Field(description="A list of keys to filter by")
         ] = None,
+        since: Annotated[
+            Optional[datetime],
+            Field(description="Consider events that occurred after this time"),
+        ] = None,
+        until: Annotated[
+            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)],
@@ -2768,6 +3183,20 @@ class EventApi:
         :type limit: int
         :param keys: A list of keys to filter by
         :type keys: List[str]
+        :param since: Consider events that occurred after this time
+        :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
@@ -2795,6 +3224,13 @@ class EventApi:
             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,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -2817,6 +3253,13 @@ class EventApi:
         offset,
         limit,
         keys,
+        since,
+        until,
+        workflow_ids,
+        workflow_run_statuses,
+        event_ids,
+        additional_metadata,
+        scopes,
         _request_auth,
         _content_type,
         _headers,
@@ -2827,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] = {}
@@ -2854,6 +3302,48 @@ class EventApi:
 
             _query_params.append(("keys", keys))
 
+        if since is not None:
+            if isinstance(since, datetime):
+                _query_params.append(
+                    (
+                        "since",
+                        since.strftime(self.api_client.configuration.datetime_format),
+                    )
+                )
+            else:
+                _query_params.append(("since", since))
+
+        if until is not None:
+            if isinstance(until, datetime):
+                _query_params.append(
+                    (
+                        "until",
+                        until.strftime(self.api_client.configuration.datetime_format),
+                    )
+                )
+            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