Add WebhookEventType and ActorJobStatus from Open API specs

Author: vdusek

src/apify_client/_models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2026-01-14T18:43:23+00:00
+#   timestamp: 2026-01-14T19:13:07+00:00
 
 from __future__ import annotations
 
@@ -370,6 +370,22 @@ class GetEnvVarResponse(BaseModel):
     data: EnvVar
 
 
+class WebhookEventType(Enum):
+    """Type of event that triggers the webhook."""
+
+    ACTOR_BUILD_ABORTED = 'ACTOR.BUILD.ABORTED'
+    ACTOR_BUILD_CREATED = 'ACTOR.BUILD.CREATED'
+    ACTOR_BUILD_FAILED = 'ACTOR.BUILD.FAILED'
+    ACTOR_BUILD_SUCCEEDED = 'ACTOR.BUILD.SUCCEEDED'
+    ACTOR_BUILD_TIMED_OUT = 'ACTOR.BUILD.TIMED_OUT'
+    ACTOR_RUN_ABORTED = 'ACTOR.RUN.ABORTED'
+    ACTOR_RUN_CREATED = 'ACTOR.RUN.CREATED'
+    ACTOR_RUN_FAILED = 'ACTOR.RUN.FAILED'
+    ACTOR_RUN_RESURRECTED = 'ACTOR.RUN.RESURRECTED'
+    ACTOR_RUN_SUCCEEDED = 'ACTOR.RUN.SUCCEEDED'
+    ACTOR_RUN_TIMED_OUT = 'ACTOR.RUN.TIMED_OUT'
+
+
 class WebhookCondition(BaseModel):
     actor_id: Annotated[str | None, Field(alias='actorId', examples=['hksJZtadYvn4mBuin'])] = None
     actor_task_id: Annotated[str | None, Field(alias='actorTaskId', examples=['asdLZtadYvn4mBZmm'])] = None
@@ -392,7 +408,7 @@ class WebhookShort(BaseModel):
     user_id: Annotated[str, Field(alias='userId', examples=['wRsJZtadYvn4mBZmm'])]
     is_ad_hoc: Annotated[bool | None, Field(alias='isAdHoc', examples=[False])] = None
     should_interpolate_strings: Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])] = None
-    event_types: Annotated[list[str], Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']])]
+    event_types: Annotated[list[WebhookEventType], Field(alias='eventTypes', examples=['ACTOR.RUN.SUCCEEDED'])]
     condition: WebhookCondition
     ignore_ssl_errors: Annotated[bool, Field(alias='ignoreSslErrors', examples=[False])]
     do_not_retry: Annotated[bool, Field(alias='doNotRetry', examples=[False])]
@@ -409,6 +425,19 @@ class GetListOfWebhooksResponse(BaseModel):
     data: ListOfWebhooks
 
 
+class ActorJobStatus(Enum):
+    """Status of an Actor job (run or build)."""
+
+    READY = 'READY'
+    RUNNING = 'RUNNING'
+    SUCCEEDED = 'SUCCEEDED'
+    FAILED = 'FAILED'
+    TIMING_OUT = 'TIMING-OUT'
+    TIMED_OUT = 'TIMED-OUT'
+    ABORTING = 'ABORTING'
+    ABORTED = 'ABORTED'
+
+
 class BuildsMeta(BaseModel):
     origin: Annotated[str, Field(examples=['WEB'])]
     client_ip: Annotated[str | None, Field(alias='clientIp', examples=['172.234.12.34'])] = None
@@ -418,7 +447,7 @@ class BuildsMeta(BaseModel):
 class BuildShort(BaseModel):
     id: Annotated[str, Field(examples=['HG7ML7M8z78YcAPEB'])]
     act_id: Annotated[str | None, Field(alias='actId', examples=['janedoe~my-actor'])] = None
-    status: Annotated[str, Field(examples=['SUCCEEDED'])]
+    status: ActorJobStatus
     started_at: Annotated[str, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
     finished_at: Annotated[str, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]
     usage_total_usd: Annotated[float, Field(alias='usageTotalUsd', examples=[0.02])]
@@ -531,7 +560,7 @@ class Build(BaseModel):
     user_id: Annotated[str, Field(alias='userId', examples=['klmdEpoiojmdEMlk3'])]
     started_at: Annotated[str, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
     finished_at: Annotated[str | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])] = None
-    status: Annotated[str, Field(examples=['SUCCEEDED'])]
+    status: ActorJobStatus
     meta: BuildsMeta
     stats: BuildStats | None = None
     options: BuildOptions | None = None
@@ -872,7 +901,7 @@ class RunShort(BaseModel):
     id: Annotated[str, Field(examples=['HG7ML7M8z78YcAPEB'])]
     act_id: Annotated[str, Field(alias='actId', examples=['HDSasDasz78YcAPEB'])]
     actor_task_id: Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])] = None
-    status: Annotated[str, Field(examples=['SUCCEEDED'])]
+    status: ActorJobStatus
     started_at: Annotated[str, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
     finished_at: Annotated[str, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]
     build_id: Annotated[str, Field(alias='buildId', examples=['HG7ML7M8z78YcAPEB'])]
@@ -957,7 +986,7 @@ class Run(BaseModel):
     actor_task_id: Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])] = None
     started_at: Annotated[str, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
     finished_at: Annotated[str | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])] = None
-    status: Annotated[str, Field(examples=['RUNNING'])]
+    status: ActorJobStatus
     status_message: Annotated[str | None, Field(alias='statusMessage', examples=['Actor is running'])] = None
     is_status_message_terminal: Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[False])] = None
     meta: RunMeta
@@ -1077,7 +1106,7 @@ class Webhook(BaseModel):
     user_id: Annotated[str, Field(alias='userId', examples=['wRsJZtadYvn4mBZmm'])]
     is_ad_hoc: Annotated[bool | None, Field(alias='isAdHoc', examples=[False])] = None
     should_interpolate_strings: Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])] = None
-    event_types: Annotated[list[str], Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']])]
+    event_types: Annotated[list[WebhookEventType], Field(alias='eventTypes', examples=['ACTOR.RUN.SUCCEEDED'])]
     condition: WebhookCondition
     ignore_ssl_errors: Annotated[bool, Field(alias='ignoreSslErrors', examples=[False])]
     do_not_retry: Annotated[bool | None, Field(alias='doNotRetry', examples=[False])] = None
@@ -1607,7 +1636,7 @@ class ProlongRequestLockResponse(BaseModel):
 
 class WebhookCreate(BaseModel):
     is_ad_hoc: Annotated[bool | None, Field(alias='isAdHoc', examples=[False])] = None
-    event_types: Annotated[list[str], Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']])]
+    event_types: Annotated[list[WebhookEventType], Field(alias='eventTypes', examples=['ACTOR.RUN.SUCCEEDED'])]
     condition: WebhookCondition
     idempotency_key: Annotated[str | None, Field(alias='idempotencyKey', examples=['fdSJmdP3nfs7sfk3y'])] = None
     ignore_ssl_errors: Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])] = None
@@ -1633,7 +1662,9 @@ class GetWebhookResponse(BaseModel):
 
 class WebhookUpdate(BaseModel):
     is_ad_hoc: Annotated[bool | None, Field(alias='isAdHoc', examples=[False])] = None
-    event_types: Annotated[list[str] | None, Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']])] = None
+    event_types: Annotated[
+        list[WebhookEventType] | None, Field(alias='eventTypes', examples=['ACTOR.RUN.SUCCEEDED'])
+    ] = None
     condition: WebhookCondition | None = None
     ignore_ssl_errors: Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])] = None
     do_not_retry: Annotated[bool | None, Field(alias='doNotRetry', examples=[False])] = None

src/apify_client/_resource_clients/log.py

@@ -415,7 +415,7 @@ def _log_run_data(self, run_data: Run | None) -> bool:
               `True` if more data is expected, `False` otherwise.
         """
         if run_data is not None:
-            status = run_data.status if run_data.status else 'Unknown status'
+            status = run_data.status.value if run_data.status else 'Unknown status'
             status_message = run_data.status_message or ''
             new_status_message = f'Status: {status}, Message: {status_message}'
 

tests/unit/test_logging.py

@@ -9,11 +9,11 @@
 from unittest.mock import patch
 
 import pytest
-from apify_shared.consts import ActorJobStatus
 from werkzeug import Request, Response
 
 from apify_client import ApifyClient, ApifyClientAsync
 from apify_client._logging import RedirectLogFormatter
+from apify_client._models import ActorJobStatus
 from apify_client._resource_clients.log import StatusMessageWatcher, StreamedLog
 
 if TYPE_CHECKING:
@@ -82,15 +82,15 @@ def __init__(self) -> None:
             ('Final message', ActorJobStatus.SUCCEEDED, True),
         ]
 
-    def _create_minimal_run_data(self, message: str, status: str, *, is_terminal: bool) -> dict:
+    def _create_minimal_run_data(self, message: str, status: ActorJobStatus, *, is_terminal: bool) -> dict:
         """Create minimal valid Run data for testing."""
         return {
             'id': _MOCKED_RUN_ID,
             'actId': _MOCKED_ACTOR_ID,
             'userId': 'test_user_id',
             'startedAt': '2019-11-30T07:34:24.202Z',
             'finishedAt': '2019-12-12T09:30:12.202Z',
-            'status': status,
+            'status': status.value,
             'statusMessage': message,
             'isStatusMessageTerminal': is_terminal,
             'meta': {'origin': 'WEB'},