hatchet-sdk 1.18.1__py3-none-any.whl → 1.19.0__py3-none-any.whl

hatchet_sdk/v0/clients/rest/exceptions.py

@@ -1,200 +0,0 @@
-# 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 typing import Any, Optional
-
-from typing_extensions import Self
-
-
-class OpenApiException(Exception):
-    """The base exception class for all OpenAPIExceptions"""
-
-
-class ApiTypeError(OpenApiException, TypeError):
-    def __init__(
-        self, msg, path_to_item=None, valid_classes=None, key_type=None
-    ) -> None:
-        """Raises an exception for TypeErrors
-
-        Args:
-            msg (str): the exception message
-
-        Keyword Args:
-            path_to_item (list): a list of keys an indices to get to the
-                                 current_item
-                                 None if unset
-            valid_classes (tuple): the primitive classes that current item
-                                   should be an instance of
-                                   None if unset
-            key_type (bool): False if our value is a value in a dict
-                             True if it is a key in a dict
-                             False if our item is an item in a list
-                             None if unset
-        """
-        self.path_to_item = path_to_item
-        self.valid_classes = valid_classes
-        self.key_type = key_type
-        full_msg = msg
-        if path_to_item:
-            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
-        super(ApiTypeError, self).__init__(full_msg)
-
-
-class ApiValueError(OpenApiException, ValueError):
-    def __init__(self, msg, path_to_item=None) -> None:
-        """
-        Args:
-            msg (str): the exception message
-
-        Keyword Args:
-            path_to_item (list) the path to the exception in the
-                received_data dict. None if unset
-        """
-
-        self.path_to_item = path_to_item
-        full_msg = msg
-        if path_to_item:
-            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
-        super(ApiValueError, self).__init__(full_msg)
-
-
-class ApiAttributeError(OpenApiException, AttributeError):
-    def __init__(self, msg, path_to_item=None) -> None:
-        """
-        Raised when an attribute reference or assignment fails.
-
-        Args:
-            msg (str): the exception message
-
-        Keyword Args:
-            path_to_item (None/list) the path to the exception in the
-                received_data dict
-        """
-        self.path_to_item = path_to_item
-        full_msg = msg
-        if path_to_item:
-            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
-        super(ApiAttributeError, self).__init__(full_msg)
-
-
-class ApiKeyError(OpenApiException, KeyError):
-    def __init__(self, msg, path_to_item=None) -> None:
-        """
-        Args:
-            msg (str): the exception message
-
-        Keyword Args:
-            path_to_item (None/list) the path to the exception in the
-                received_data dict
-        """
-        self.path_to_item = path_to_item
-        full_msg = msg
-        if path_to_item:
-            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
-        super(ApiKeyError, self).__init__(full_msg)
-
-
-class ApiException(OpenApiException):
-
-    def __init__(
-        self,
-        status=None,
-        reason=None,
-        http_resp=None,
-        *,
-        body: Optional[str] = None,
-        data: Optional[Any] = None,
-    ) -> None:
-        self.status = status
-        self.reason = reason
-        self.body = body
-        self.data = data
-        self.headers = None
-
-        if http_resp:
-            if self.status is None:
-                self.status = http_resp.status
-            if self.reason is None:
-                self.reason = http_resp.reason
-            if self.body is None:
-                try:
-                    self.body = http_resp.data.decode("utf-8")
-                except Exception:
-                    pass
-            self.headers = http_resp.getheaders()
-
-    @classmethod
-    def from_response(
-        cls,
-        *,
-        http_resp,
-        body: Optional[str],
-        data: Optional[Any],
-    ) -> Self:
-        if http_resp.status == 400:
-            raise BadRequestException(http_resp=http_resp, body=body, data=data)
-
-        if http_resp.status == 401:
-            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
-
-        if http_resp.status == 403:
-            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
-
-        if http_resp.status == 404:
-            raise NotFoundException(http_resp=http_resp, body=body, data=data)
-
-        if 500 <= http_resp.status <= 599:
-            raise ServiceException(http_resp=http_resp, body=body, data=data)
-        raise ApiException(http_resp=http_resp, body=body, data=data)
-
-    def __str__(self):
-        """Custom error messages for exception"""
-        error_message = "({0})\n" "Reason: {1}\n".format(self.status, self.reason)
-        if self.headers:
-            error_message += "HTTP response headers: {0}\n".format(self.headers)
-
-        if self.data or self.body:
-            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
-
-        return error_message
-
-
-class BadRequestException(ApiException):
-    pass
-
-
-class NotFoundException(ApiException):
-    pass
-
-
-class UnauthorizedException(ApiException):
-    pass
-
-
-class ForbiddenException(ApiException):
-    pass
-
-
-class ServiceException(ApiException):
-    pass
-
-
-def render_path(path_to_item):
-    """Returns a string representation of a path"""
-    result = ""
-    for pth in path_to_item:
-        if isinstance(pth, int):
-            result += "[{0}]".format(pth)
-        else:
-            result += "['{0}']".format(pth)
-    return result

hatchet_sdk/v0/clients/rest/models/__init__.py

@@ -1,274 +0,0 @@
-# coding: utf-8
-
-# flake8: noqa
-"""
-    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 hatchet_sdk.v0.clients.rest.models.accept_invite_request import AcceptInviteRequest
-
-# import models into model package
-from hatchet_sdk.v0.clients.rest.models.api_error import APIError
-from hatchet_sdk.v0.clients.rest.models.api_errors import APIErrors
-from hatchet_sdk.v0.clients.rest.models.api_meta import APIMeta
-from hatchet_sdk.v0.clients.rest.models.api_meta_auth import APIMetaAuth
-from hatchet_sdk.v0.clients.rest.models.api_meta_integration import APIMetaIntegration
-from hatchet_sdk.v0.clients.rest.models.api_meta_posthog import APIMetaPosthog
-from hatchet_sdk.v0.clients.rest.models.api_resource_meta import APIResourceMeta
-from hatchet_sdk.v0.clients.rest.models.api_token import APIToken
-from hatchet_sdk.v0.clients.rest.models.bulk_create_event_request import (
-    BulkCreateEventRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.cancel_event_request import CancelEventRequest
-from hatchet_sdk.v0.clients.rest.models.concurrency_limit_strategy import (
-    ConcurrencyLimitStrategy,
-)
-from hatchet_sdk.v0.clients.rest.models.create_api_token_request import (
-    CreateAPITokenRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.create_api_token_response import (
-    CreateAPITokenResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.create_cron_workflow_trigger_request import (
-    CreateCronWorkflowTriggerRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.create_event_request import CreateEventRequest
-from hatchet_sdk.v0.clients.rest.models.create_pull_request_from_step_run import (
-    CreatePullRequestFromStepRun,
-)
-from hatchet_sdk.v0.clients.rest.models.create_sns_integration_request import (
-    CreateSNSIntegrationRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.create_tenant_alert_email_group_request import (
-    CreateTenantAlertEmailGroupRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.create_tenant_invite_request import (
-    CreateTenantInviteRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.create_tenant_request import CreateTenantRequest
-from hatchet_sdk.v0.clients.rest.models.cron_workflows import CronWorkflows
-from hatchet_sdk.v0.clients.rest.models.cron_workflows_list import CronWorkflowsList
-from hatchet_sdk.v0.clients.rest.models.cron_workflows_method import CronWorkflowsMethod
-from hatchet_sdk.v0.clients.rest.models.cron_workflows_order_by_field import (
-    CronWorkflowsOrderByField,
-)
-from hatchet_sdk.v0.clients.rest.models.event import Event
-from hatchet_sdk.v0.clients.rest.models.event_data import EventData
-from hatchet_sdk.v0.clients.rest.models.event_key_list import EventKeyList
-from hatchet_sdk.v0.clients.rest.models.event_list import EventList
-from hatchet_sdk.v0.clients.rest.models.event_order_by_direction import (
-    EventOrderByDirection,
-)
-from hatchet_sdk.v0.clients.rest.models.event_order_by_field import EventOrderByField
-from hatchet_sdk.v0.clients.rest.models.event_update_cancel200_response import (
-    EventUpdateCancel200Response,
-)
-from hatchet_sdk.v0.clients.rest.models.event_workflow_run_summary import (
-    EventWorkflowRunSummary,
-)
-from hatchet_sdk.v0.clients.rest.models.events import Events
-from hatchet_sdk.v0.clients.rest.models.get_step_run_diff_response import (
-    GetStepRunDiffResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.info_get_version200_response import (
-    InfoGetVersion200Response,
-)
-from hatchet_sdk.v0.clients.rest.models.job import Job
-from hatchet_sdk.v0.clients.rest.models.job_run import JobRun
-from hatchet_sdk.v0.clients.rest.models.job_run_status import JobRunStatus
-from hatchet_sdk.v0.clients.rest.models.list_api_tokens_response import (
-    ListAPITokensResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.list_pull_requests_response import (
-    ListPullRequestsResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.list_slack_webhooks import ListSlackWebhooks
-from hatchet_sdk.v0.clients.rest.models.list_sns_integrations import ListSNSIntegrations
-from hatchet_sdk.v0.clients.rest.models.log_line import LogLine
-from hatchet_sdk.v0.clients.rest.models.log_line_level import LogLineLevel
-from hatchet_sdk.v0.clients.rest.models.log_line_list import LogLineList
-from hatchet_sdk.v0.clients.rest.models.log_line_order_by_direction import (
-    LogLineOrderByDirection,
-)
-from hatchet_sdk.v0.clients.rest.models.log_line_order_by_field import (
-    LogLineOrderByField,
-)
-from hatchet_sdk.v0.clients.rest.models.pagination_response import PaginationResponse
-from hatchet_sdk.v0.clients.rest.models.pull_request import PullRequest
-from hatchet_sdk.v0.clients.rest.models.pull_request_state import PullRequestState
-from hatchet_sdk.v0.clients.rest.models.queue_metrics import QueueMetrics
-from hatchet_sdk.v0.clients.rest.models.rate_limit import RateLimit
-from hatchet_sdk.v0.clients.rest.models.rate_limit_list import RateLimitList
-from hatchet_sdk.v0.clients.rest.models.rate_limit_order_by_direction import (
-    RateLimitOrderByDirection,
-)
-from hatchet_sdk.v0.clients.rest.models.rate_limit_order_by_field import (
-    RateLimitOrderByField,
-)
-from hatchet_sdk.v0.clients.rest.models.recent_step_runs import RecentStepRuns
-from hatchet_sdk.v0.clients.rest.models.reject_invite_request import RejectInviteRequest
-from hatchet_sdk.v0.clients.rest.models.replay_event_request import ReplayEventRequest
-from hatchet_sdk.v0.clients.rest.models.replay_workflow_runs_request import (
-    ReplayWorkflowRunsRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.replay_workflow_runs_response import (
-    ReplayWorkflowRunsResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.rerun_step_run_request import (
-    RerunStepRunRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.schedule_workflow_run_request import (
-    ScheduleWorkflowRunRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.scheduled_run_status import ScheduledRunStatus
-from hatchet_sdk.v0.clients.rest.models.scheduled_workflows import ScheduledWorkflows
-from hatchet_sdk.v0.clients.rest.models.scheduled_workflows_list import (
-    ScheduledWorkflowsList,
-)
-from hatchet_sdk.v0.clients.rest.models.scheduled_workflows_method import (
-    ScheduledWorkflowsMethod,
-)
-from hatchet_sdk.v0.clients.rest.models.scheduled_workflows_order_by_field import (
-    ScheduledWorkflowsOrderByField,
-)
-from hatchet_sdk.v0.clients.rest.models.semaphore_slots import SemaphoreSlots
-from hatchet_sdk.v0.clients.rest.models.slack_webhook import SlackWebhook
-from hatchet_sdk.v0.clients.rest.models.sns_integration import SNSIntegration
-from hatchet_sdk.v0.clients.rest.models.step import Step
-from hatchet_sdk.v0.clients.rest.models.step_run import StepRun
-from hatchet_sdk.v0.clients.rest.models.step_run_archive import StepRunArchive
-from hatchet_sdk.v0.clients.rest.models.step_run_archive_list import StepRunArchiveList
-from hatchet_sdk.v0.clients.rest.models.step_run_diff import StepRunDiff
-from hatchet_sdk.v0.clients.rest.models.step_run_event import StepRunEvent
-from hatchet_sdk.v0.clients.rest.models.step_run_event_list import StepRunEventList
-from hatchet_sdk.v0.clients.rest.models.step_run_event_reason import StepRunEventReason
-from hatchet_sdk.v0.clients.rest.models.step_run_event_severity import (
-    StepRunEventSeverity,
-)
-from hatchet_sdk.v0.clients.rest.models.step_run_status import StepRunStatus
-from hatchet_sdk.v0.clients.rest.models.tenant import Tenant
-from hatchet_sdk.v0.clients.rest.models.tenant_alert_email_group import (
-    TenantAlertEmailGroup,
-)
-from hatchet_sdk.v0.clients.rest.models.tenant_alert_email_group_list import (
-    TenantAlertEmailGroupList,
-)
-from hatchet_sdk.v0.clients.rest.models.tenant_alerting_settings import (
-    TenantAlertingSettings,
-)
-from hatchet_sdk.v0.clients.rest.models.tenant_invite import TenantInvite
-from hatchet_sdk.v0.clients.rest.models.tenant_invite_list import TenantInviteList
-from hatchet_sdk.v0.clients.rest.models.tenant_list import TenantList
-from hatchet_sdk.v0.clients.rest.models.tenant_member import TenantMember
-from hatchet_sdk.v0.clients.rest.models.tenant_member_list import TenantMemberList
-from hatchet_sdk.v0.clients.rest.models.tenant_member_role import TenantMemberRole
-from hatchet_sdk.v0.clients.rest.models.tenant_queue_metrics import TenantQueueMetrics
-from hatchet_sdk.v0.clients.rest.models.tenant_resource import TenantResource
-from hatchet_sdk.v0.clients.rest.models.tenant_resource_limit import TenantResourceLimit
-from hatchet_sdk.v0.clients.rest.models.tenant_resource_policy import (
-    TenantResourcePolicy,
-)
-from hatchet_sdk.v0.clients.rest.models.tenant_step_run_queue_metrics import (
-    TenantStepRunQueueMetrics,
-)
-from hatchet_sdk.v0.clients.rest.models.trigger_workflow_run_request import (
-    TriggerWorkflowRunRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.update_tenant_alert_email_group_request import (
-    UpdateTenantAlertEmailGroupRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.update_tenant_invite_request import (
-    UpdateTenantInviteRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.update_tenant_request import UpdateTenantRequest
-from hatchet_sdk.v0.clients.rest.models.update_worker_request import UpdateWorkerRequest
-from hatchet_sdk.v0.clients.rest.models.user import User
-from hatchet_sdk.v0.clients.rest.models.user_change_password_request import (
-    UserChangePasswordRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.user_login_request import UserLoginRequest
-from hatchet_sdk.v0.clients.rest.models.user_register_request import UserRegisterRequest
-from hatchet_sdk.v0.clients.rest.models.user_tenant_memberships_list import (
-    UserTenantMembershipsList,
-)
-from hatchet_sdk.v0.clients.rest.models.user_tenant_public import UserTenantPublic
-from hatchet_sdk.v0.clients.rest.models.webhook_worker import WebhookWorker
-from hatchet_sdk.v0.clients.rest.models.webhook_worker_create_request import (
-    WebhookWorkerCreateRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.webhook_worker_create_response import (
-    WebhookWorkerCreateResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.webhook_worker_created import (
-    WebhookWorkerCreated,
-)
-from hatchet_sdk.v0.clients.rest.models.webhook_worker_list_response import (
-    WebhookWorkerListResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.webhook_worker_request import (
-    WebhookWorkerRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.webhook_worker_request_list_response import (
-    WebhookWorkerRequestListResponse,
-)
-from hatchet_sdk.v0.clients.rest.models.webhook_worker_request_method import (
-    WebhookWorkerRequestMethod,
-)
-from hatchet_sdk.v0.clients.rest.models.worker import Worker
-from hatchet_sdk.v0.clients.rest.models.worker_label import WorkerLabel
-from hatchet_sdk.v0.clients.rest.models.worker_list import WorkerList
-from hatchet_sdk.v0.clients.rest.models.worker_runtime_info import WorkerRuntimeInfo
-from hatchet_sdk.v0.clients.rest.models.worker_runtime_sdks import WorkerRuntimeSDKs
-from hatchet_sdk.v0.clients.rest.models.worker_type import WorkerType
-from hatchet_sdk.v0.clients.rest.models.workflow import Workflow
-from hatchet_sdk.v0.clients.rest.models.workflow_concurrency import WorkflowConcurrency
-from hatchet_sdk.v0.clients.rest.models.workflow_kind import WorkflowKind
-from hatchet_sdk.v0.clients.rest.models.workflow_list import WorkflowList
-from hatchet_sdk.v0.clients.rest.models.workflow_metrics import WorkflowMetrics
-from hatchet_sdk.v0.clients.rest.models.workflow_run import WorkflowRun
-from hatchet_sdk.v0.clients.rest.models.workflow_run_list import WorkflowRunList
-from hatchet_sdk.v0.clients.rest.models.workflow_run_order_by_direction import (
-    WorkflowRunOrderByDirection,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_run_order_by_field import (
-    WorkflowRunOrderByField,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_run_shape import WorkflowRunShape
-from hatchet_sdk.v0.clients.rest.models.workflow_run_status import WorkflowRunStatus
-from hatchet_sdk.v0.clients.rest.models.workflow_run_triggered_by import (
-    WorkflowRunTriggeredBy,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_runs_cancel_request import (
-    WorkflowRunsCancelRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_runs_metrics import WorkflowRunsMetrics
-from hatchet_sdk.v0.clients.rest.models.workflow_runs_metrics_counts import (
-    WorkflowRunsMetricsCounts,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_tag import WorkflowTag
-from hatchet_sdk.v0.clients.rest.models.workflow_trigger_cron_ref import (
-    WorkflowTriggerCronRef,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_trigger_event_ref import (
-    WorkflowTriggerEventRef,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_triggers import WorkflowTriggers
-from hatchet_sdk.v0.clients.rest.models.workflow_update_request import (
-    WorkflowUpdateRequest,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_version import WorkflowVersion
-from hatchet_sdk.v0.clients.rest.models.workflow_version_definition import (
-    WorkflowVersionDefinition,
-)
-from hatchet_sdk.v0.clients.rest.models.workflow_version_meta import WorkflowVersionMeta
-from hatchet_sdk.v0.clients.rest.models.workflow_workers_count import (
-    WorkflowWorkersCount,
-)

hatchet_sdk/v0/clients/rest/models/accept_invite_request.py

@@ -1,83 +0,0 @@
-# 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
-from typing_extensions import Annotated, Self
-
-
-class AcceptInviteRequest(BaseModel):
-    """
-    AcceptInviteRequest
-    """  # noqa: E501
-
-    invite: Annotated[str, Field(min_length=36, strict=True, max_length=36)]
-    __properties: ClassVar[List[str]] = ["invite"]
-
-    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 AcceptInviteRequest 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 AcceptInviteRequest from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({"invite": obj.get("invite")})
-        return _obj

hatchet_sdk/v0/clients/rest/models/api_error.py

@@ -1,102 +0,0 @@
-# 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, StrictInt, StrictStr
-from typing_extensions import Self
-
-
-class APIError(BaseModel):
-    """
-    APIError
-    """  # noqa: E501
-
-    code: Optional[StrictInt] = Field(
-        default=None, description="a custom Hatchet error code"
-    )
-    var_field: Optional[StrictStr] = Field(
-        default=None,
-        description="the field that this error is associated with, if applicable",
-        alias="field",
-    )
-    description: StrictStr = Field(description="a description for this error")
-    docs_link: Optional[StrictStr] = Field(
-        default=None,
-        description="a link to the documentation for this error, if it exists",
-    )
-    __properties: ClassVar[List[str]] = ["code", "field", "description", "docs_link"]
-
-    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 APIError 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 APIError from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate(
-            {
-                "code": obj.get("code"),
-                "field": obj.get("field"),
-                "description": obj.get("description"),
-                "docs_link": obj.get("docs_link"),
-            }
-        )
-        return _obj