stackgen-sdk 0.1.1__py3-none-any.whl

stackgen/generated/models/schedule_run_status.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.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 ScheduleRunStatus(str, Enum):
+    """
+    Status of a schedule execution run.
+    """
+
+    """
+    allowed enum values
+    """
+    RUNNING = 'running'
+    SUCCESS = 'success'
+    FAILED = 'failed'
+    SKIPPED = 'skipped'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ScheduleRunStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/schedule_target_type.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.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 ScheduleTargetType(str, Enum):
+    """
+    Whether the schedule or webhook targets an agent, a workflow, or an installed app. App targets POST a fixed payload to endpoint_path on the catalog install URL (schedules on cron; webhooks on inbound trigger). 
+    """
+
+    """
+    allowed enum values
+    """
+    AGENT = 'agent'
+    WORKFLOW = 'workflow'
+    APP = 'app'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ScheduleTargetType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/session.py

@@ -0,0 +1,141 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from stackgen.generated.models.artifact_info import ArtifactInfo
+from stackgen.generated.models.session_responder_kind import SessionResponderKind
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Session(BaseModel):
+    """
+    Detailed, rich view of a conversation session offering profound insights and a 'wow' factor for users.
+    """ # noqa: E501
+    session_id: Optional[StrictStr] = Field(default=None, description="Logical session identifier.")
+    agent_name: Optional[StrictStr] = Field(default=None, description="Agent that handled this session.")
+    started_by: Optional[StrictStr] = Field(default=None, description="User email of the person who initiated the session.")
+    started_by_id: Optional[StrictStr] = Field(default=None, description="ID of the person who initiated the session.")
+    started_at: Optional[datetime] = Field(default=None, description="Timestamp of the first event.")
+    last_activity: Optional[datetime] = Field(default=None, description="Timestamp of the most recent event.")
+    duration_ms: Optional[StrictInt] = Field(default=None, description="Total active duration of the session in milliseconds.")
+    primary_query: Optional[StrictStr] = Field(default=None, description="The full initial request or primary prompt that started the session.")
+    summary: Optional[StrictStr] = Field(default=None, description="AI-generated, rich-text summary of the session's overall outcome, key decisions, or final state.")
+    total_cost: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Total estimated cost in USD for this session. Returns -1 if the cost is not yet calculated or the session is actively running.")
+    artifacts: Optional[List[ArtifactInfo]] = Field(default=None, description="List of artifacts (files, images, etc.) uploaded or generated during the session.")
+    event_counts: Optional[Dict[str, StrictInt]] = Field(default=None, description="Dictionary mapping event types (e.g., 'chat_request', 'tool_call', 'error') to their respective counts within the session.")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="AI-generated labels categorizing the session for quick filtering (e.g., 'Security', 'Database', 'High Cost').")
+    workflow_name: Optional[StrictStr] = Field(default=None, description="Name of the workflow that was executed in this session. Empty for direct agent chat sessions.")
+    prompt: Optional[StrictStr] = Field(default=None, description="Short snippet of the original user request (max 120 chars). Mirrors the list view's prompt so detail and list agree.")
+    source_app: Optional[StrictStr] = Field(default=None, description="Installed application that initiated the session, when applicable.")
+    responder_kind: Optional[SessionResponderKind] = None
+    responder_name: Optional[StrictStr] = Field(default=None, description="Display name of the primary responder (agent name, workflow name, or app id).")
+    title: Optional[StrictStr] = Field(default=None, description="User-assigned display name for this session. When set, shown instead of the prompt snippet.")
+    starred: Optional[StrictBool] = Field(default=None, description="Whether the user has starred (favourited) this session.")
+    archived: Optional[StrictBool] = Field(default=None, description="Whether the conversation is archived and omitted from active history.")
+    source_metadata: Optional[Dict[str, StrictStr]] = Field(default=None, description="Arbitrary key-value metadata from the initiating app. Examples: alert_id, dashboard_url, severity, etc. ")
+    required_completion_tools: Optional[List[StrictStr]] = Field(default=None, description="Immutable session policy listing tool names that must SUCCESSFULLY execute at least once before each Plan/ReAcTree Chat may finish. Empty when no completion gate was set for this session. ")
+    __properties: ClassVar[List[str]] = ["session_id", "agent_name", "started_by", "started_by_id", "started_at", "last_activity", "duration_ms", "primary_query", "summary", "total_cost", "artifacts", "event_counts", "tags", "workflow_name", "prompt", "source_app", "responder_kind", "responder_name", "title", "starred", "archived", "source_metadata", "required_completion_tools"]
+
+    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 Session 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in artifacts (list)
+        _items = []
+        if self.artifacts:
+            for _item_artifacts in self.artifacts:
+                if _item_artifacts:
+                    _items.append(_item_artifacts.to_dict())
+            _dict['artifacts'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Session from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "session_id": obj.get("session_id"),
+            "agent_name": obj.get("agent_name"),
+            "started_by": obj.get("started_by"),
+            "started_by_id": obj.get("started_by_id"),
+            "started_at": obj.get("started_at"),
+            "last_activity": obj.get("last_activity"),
+            "duration_ms": obj.get("duration_ms"),
+            "primary_query": obj.get("primary_query"),
+            "summary": obj.get("summary"),
+            "total_cost": obj.get("total_cost"),
+            "artifacts": [ArtifactInfo.from_dict(_item) for _item in obj["artifacts"]] if obj.get("artifacts") is not None else None,
+            "event_counts": obj.get("event_counts"),
+            "tags": obj.get("tags"),
+            "workflow_name": obj.get("workflow_name"),
+            "prompt": obj.get("prompt"),
+            "source_app": obj.get("source_app"),
+            "responder_kind": obj.get("responder_kind"),
+            "responder_name": obj.get("responder_name"),
+            "title": obj.get("title"),
+            "starred": obj.get("starred"),
+            "archived": obj.get("archived"),
+            "source_metadata": obj.get("source_metadata"),
+            "required_completion_tools": obj.get("required_completion_tools")
+        })
+        return _obj
+
+

stackgen/generated/models/session_responder_kind.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.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 SessionResponderKind(str, Enum):
+    """
+    Kind of primary responder for a session.
+    """
+
+    """
+    allowed enum values
+    """
+    AGENT = 'agent'
+    WORKFLOW = 'workflow'
+    APP = 'app'
+    SCHEDULE = 'schedule'
+    WEBHOOK = 'webhook'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SessionResponderKind from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/signal_severity.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.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 SignalSeverity(str, Enum):
+    """
+    Normalized monitor signal severity used for alerts table badges and severity filtering. Maps multiple upstream source_severity strings into a single bucket (for example warning and medium both map to Medium).
+    """
+
+    """
+    allowed enum values
+    """
+    CRITICAL = 'Critical'
+    HIGH = 'High'
+    MEDIUM = 'Medium'
+    LOW = 'Low'
+    INFO = 'info'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SignalSeverity from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stackgen/generated/models/sync_response.py

@@ -0,0 +1,136 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from stackgen.generated.models.alert_sync_run_status import AlertSyncRunStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SyncResponse(BaseModel):
+    """
+    State of an alert sync run — returned immediately on start and updated on poll.
+    """ # noqa: E501
+    sync_run_id: StrictStr = Field(description="UUID of the alert_sync_runs row. Use this to poll GET /api/v1/alerts/sync/{id}.")
+    triggered_by: StrictStr = Field(description="What triggered this sync (manual, schedule, webhook, or chat_correlate).")
+    source: Optional[StrictStr] = Field(default=None, description="Alert source type being synced (e.g. \"grafana\"). Null means the default source.")
+    integration_name: Optional[StrictStr] = Field(default=None, description="Integration instance name being synced (e.g. \"prod-grafana\"). Null means the first available.")
+    started_at: Optional[datetime] = Field(default=None, description="When the sync run started.")
+    finished_at: Optional[datetime] = Field(default=None, description="When the sync run completed or failed. Null while still running.")
+    status: AlertSyncRunStatus
+    alerts_created: StrictInt = Field(description="Number of new alert rows created (0 while running).")
+    alerts_updated: StrictInt = Field(description="Number of existing alert rows updated (0 while running).")
+    alerts_resolved: StrictInt = Field(description="Number of alerts marked resolved (0 while running).")
+    error: Optional[StrictStr] = Field(default=None, description="Error message when status is \"failed\".")
+    __properties: ClassVar[List[str]] = ["sync_run_id", "triggered_by", "source", "integration_name", "started_at", "finished_at", "status", "alerts_created", "alerts_updated", "alerts_resolved", "error"]
+
+    @field_validator('triggered_by')
+    def triggered_by_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['manual', 'schedule', 'webhook', 'chat_correlate']):
+            raise ValueError("must be one of enum values ('manual', 'schedule', 'webhook', 'chat_correlate')")
+        return value
+
+    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 SyncResponse 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,
+        )
+        # set to None if source (nullable) is None
+        # and model_fields_set contains the field
+        if self.source is None and "source" in self.model_fields_set:
+            _dict['source'] = None
+
+        # set to None if integration_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.integration_name is None and "integration_name" in self.model_fields_set:
+            _dict['integration_name'] = None
+
+        # set to None if finished_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.finished_at is None and "finished_at" in self.model_fields_set:
+            _dict['finished_at'] = None
+
+        # set to None if error (nullable) is None
+        # and model_fields_set contains the field
+        if self.error is None and "error" in self.model_fields_set:
+            _dict['error'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SyncResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sync_run_id": obj.get("sync_run_id"),
+            "triggered_by": obj.get("triggered_by"),
+            "source": obj.get("source"),
+            "integration_name": obj.get("integration_name"),
+            "started_at": obj.get("started_at"),
+            "finished_at": obj.get("finished_at"),
+            "status": obj.get("status"),
+            "alerts_created": obj.get("alerts_created"),
+            "alerts_updated": obj.get("alerts_updated"),
+            "alerts_resolved": obj.get("alerts_resolved"),
+            "error": obj.get("error")
+        })
+        return _obj
+
+

stackgen/generated/models/trigger_webhook202_response.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from stackgen.generated.models.schedule_target_type import ScheduleTargetType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TriggerWebhook202Response(BaseModel):
+    """
+    Acknowledgement returned when a public webhook trigger starts dispatch. session_id and trace_id are not included here because dispatch is asynchronous; poll GET /api/v1/webhooks/{webhook_id}/runs/{invocation_id} until those fields are populated. 
+    """ # noqa: E501
+    run_id: Optional[StrictStr] = Field(default=None, description="Temporal dispatch workflow run ID.")
+    message: Optional[StrictStr] = Field(default=None, description="Human-readable trigger status message.")
+    webhook_id: Optional[StrictStr] = Field(default=None, description="Webhook configuration that accepted this trigger.")
+    invocation_id: Optional[StrictStr] = Field(default=None, description="Invocation row ID for GET /api/v1/webhooks/{webhook_id}/runs/{invocation_id}. Empty when invocation history is unavailable or the target does not record invocations (for example app-forward webhooks). ")
+    target_type: Optional[ScheduleTargetType] = None
+    target_name: Optional[StrictStr] = Field(default=None, description="Target agent, workflow, or app name snapshot at trigger time.")
+    __properties: ClassVar[List[str]] = ["run_id", "message", "webhook_id", "invocation_id", "target_type", "target_name"]
+
+    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 TriggerWebhook202Response 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 TriggerWebhook202Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "run_id": obj.get("run_id"),
+            "message": obj.get("message"),
+            "webhook_id": obj.get("webhook_id"),
+            "invocation_id": obj.get("invocation_id"),
+            "target_type": obj.get("target_type"),
+            "target_name": obj.get("target_name")
+        })
+        return _obj
+
+

stackgen/generated/models/webhook_run.py

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+"""
+    StackGen External API
+
+    Allowlisted StackGen API surface for the public SDK. Managed via api-docs/product/allowlists/external.yaml.
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from stackgen.generated.models.schedule_run_status import ScheduleRunStatus
+from stackgen.generated.models.schedule_target_type import ScheduleTargetType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebhookRun(BaseModel):
+    """
+    A single named webhook invocation. List responses include metadata and payload size/truncation information but omit the payload body. 
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="Unique webhook invocation identifier.")
+    webhook_id: Optional[StrictStr] = Field(default=None, description="Webhook configuration that received this invocation.")
+    webhook_name: Optional[StrictStr] = Field(default=None, description="Webhook name snapshot at invocation time.")
+    target_type: Optional[ScheduleTargetType] = None
+    target_name: Optional[StrictStr] = Field(default=None, description="Target agent or workflow name snapshot at invocation time.")
+    status: Optional[ScheduleRunStatus] = None
+    started_at: Optional[datetime] = Field(default=None, description="Timestamp when the webhook was accepted.")
+    finished_at: Optional[datetime] = Field(default=None, description="Timestamp when dispatch completed, if known.")
+    duration_ms: Optional[StrictInt] = Field(default=None, description="Dispatch duration in milliseconds when finished_at is present.")
+    error: Optional[StrictStr] = Field(default=None, description="Error message if dispatch failed.")
+    run_id: Optional[StrictStr] = Field(default=None, description="Downstream Temporal execution run ID, empty until available.")
+    trace_id: Optional[StrictStr] = Field(default=None, description="Execution trace identifier used by the subscribe endpoint.")
+    session_id: Optional[StrictStr] = Field(default=None, description="Downstream session identifier for the dispatched run. Used to correlate this invocation with execution_agent_summaries and the NATS session stream. Empty until dispatch starts a run. ")
+    subscribe_url: Optional[StrictStr] = Field(default=None, description="Relative SSE subscribe URL for the execution trace.")
+    client_ip: Optional[StrictStr] = Field(default=None, description="Source IP address observed by the webhook handler.")
+    payload_bytes: Optional[StrictInt] = Field(default=None, description="Original serialized payload size in bytes.")
+    payload_truncated: Optional[StrictBool] = Field(default=None, description="Whether the stored payload was replaced by a bounded preview.")
+    payload_preview: Optional[StrictStr] = Field(default=None, description="Bounded payload preview, populated when payload_truncated is true.")
+    __properties: ClassVar[List[str]] = ["id", "webhook_id", "webhook_name", "target_type", "target_name", "status", "started_at", "finished_at", "duration_ms", "error", "run_id", "trace_id", "session_id", "subscribe_url", "client_ip", "payload_bytes", "payload_truncated", "payload_preview"]
+
+    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 WebhookRun 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,
+        )
+        # set to None if finished_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.finished_at is None and "finished_at" in self.model_fields_set:
+            _dict['finished_at'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WebhookRun from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "webhook_id": obj.get("webhook_id"),
+            "webhook_name": obj.get("webhook_name"),
+            "target_type": obj.get("target_type"),
+            "target_name": obj.get("target_name"),
+            "status": obj.get("status"),
+            "started_at": obj.get("started_at"),
+            "finished_at": obj.get("finished_at"),
+            "duration_ms": obj.get("duration_ms"),
+            "error": obj.get("error"),
+            "run_id": obj.get("run_id"),
+            "trace_id": obj.get("trace_id"),
+            "session_id": obj.get("session_id"),
+            "subscribe_url": obj.get("subscribe_url"),
+            "client_ip": obj.get("client_ip"),
+            "payload_bytes": obj.get("payload_bytes"),
+            "payload_truncated": obj.get("payload_truncated"),
+            "payload_preview": obj.get("payload_preview")
+        })
+        return _obj
+
+