feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 42
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml
 openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a
-config_hash: 4e73c7e12a531edcd1366dab7eccc360
+config_hash: 08e12746cdca1c59c897cf2e50893c3c

api.md

@@ -238,6 +238,7 @@ Types:
 
 ```python
 from imagekit.types import (
+    BaseWebhookEvent,
     UploadPostTransformErrorEvent,
     UploadPostTransformSuccessEvent,
     UploadPreTransformErrorEvent,

src/imagekit/types/__init__.py

@@ -28,6 +28,7 @@
 from .file_copy_params import FileCopyParams as FileCopyParams
 from .file_move_params import FileMoveParams as FileMoveParams
 from .asset_list_params import AssetListParams as AssetListParams
+from .base_webhook_event import BaseWebhookEvent as BaseWebhookEvent
 from .file_copy_response import FileCopyResponse as FileCopyResponse
 from .file_move_response import FileMoveResponse as FileMoveResponse
 from .file_rename_params import FileRenameParams as FileRenameParams

src/imagekit/types/base_webhook_event.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["BaseWebhookEvent"]
+
+
+class BaseWebhookEvent(BaseModel):
+    id: str
+    """Unique identifier for the event."""
+
+    type: str
+    """The type of webhook event."""

src/imagekit/types/upload_post_transform_error_event.py

@@ -7,27 +7,28 @@
 from pydantic import Field as FieldInfo
 
 from .._models import BaseModel
+from .base_webhook_event import BaseWebhookEvent
 
 __all__ = [
     "UploadPostTransformErrorEvent",
-    "Data",
-    "DataTransformation",
-    "DataTransformationError",
-    "Request",
-    "RequestTransformation",
+    "UploadPostTransformErrorEventData",
+    "UploadPostTransformErrorEventDataTransformation",
+    "UploadPostTransformErrorEventDataTransformationError",
+    "UploadPostTransformErrorEventRequest",
+    "UploadPostTransformErrorEventRequestTransformation",
 ]
 
 
-class DataTransformationError(BaseModel):
+class UploadPostTransformErrorEventDataTransformationError(BaseModel):
     reason: str
     """Reason for the post-transformation failure."""
 
 
-class DataTransformation(BaseModel):
-    error: DataTransformationError
+class UploadPostTransformErrorEventDataTransformation(BaseModel):
+    error: UploadPostTransformErrorEventDataTransformationError
 
 
-class Data(BaseModel):
+class UploadPostTransformErrorEventData(BaseModel):
     file_id: str = FieldInfo(alias="fileId")
     """Unique identifier of the originally uploaded file."""
 
@@ -37,13 +38,13 @@ class Data(BaseModel):
     path: str
     """Path of the file."""
 
-    transformation: DataTransformation
+    transformation: UploadPostTransformErrorEventDataTransformation
 
     url: str
     """URL of the attempted post-transformation."""
 
 
-class RequestTransformation(BaseModel):
+class UploadPostTransformErrorEventRequestTransformation(BaseModel):
     type: Literal["transformation", "abs", "gif-to-video", "thumbnail"]
     """Type of the requested post-transformation."""
 
@@ -54,22 +55,19 @@ class RequestTransformation(BaseModel):
     """Value for the requested transformation type."""
 
 
-class Request(BaseModel):
-    transformation: RequestTransformation
+class UploadPostTransformErrorEventRequest(BaseModel):
+    transformation: UploadPostTransformErrorEventRequestTransformation
 
     x_request_id: str
     """Unique identifier for the originating request."""
 
 
-class UploadPostTransformErrorEvent(BaseModel):
-    id: str
-    """Unique identifier for the event."""
-
+class UploadPostTransformErrorEvent(BaseWebhookEvent):
     created_at: datetime
     """Timestamp of when the event occurred in ISO8601 format."""
 
-    data: Data
+    data: UploadPostTransformErrorEventData
 
-    request: Request
+    request: UploadPostTransformErrorEventRequest
 
-    type: Literal["upload.post-transform.error"]
+    type: Literal["upload.post-transform.error"]  # type: ignore

src/imagekit/types/upload_post_transform_success_event.py

@@ -7,11 +7,17 @@
 from pydantic import Field as FieldInfo
 
 from .._models import BaseModel
+from .base_webhook_event import BaseWebhookEvent
 
-__all__ = ["UploadPostTransformSuccessEvent", "Data", "Request", "RequestTransformation"]
+__all__ = [
+    "UploadPostTransformSuccessEvent",
+    "UploadPostTransformSuccessEventData",
+    "UploadPostTransformSuccessEventRequest",
+    "UploadPostTransformSuccessEventRequestTransformation",
+]
 
 
-class Data(BaseModel):
+class UploadPostTransformSuccessEventData(BaseModel):
     file_id: str = FieldInfo(alias="fileId")
     """Unique identifier of the originally uploaded file."""
 
@@ -22,7 +28,7 @@ class Data(BaseModel):
     """URL of the generated post-transformation."""
 
 
-class RequestTransformation(BaseModel):
+class UploadPostTransformSuccessEventRequestTransformation(BaseModel):
     type: Literal["transformation", "abs", "gif-to-video", "thumbnail"]
     """Type of the requested post-transformation."""
 
@@ -33,22 +39,19 @@ class RequestTransformation(BaseModel):
     """Value for the requested transformation type."""
 
 
-class Request(BaseModel):
-    transformation: RequestTransformation
+class UploadPostTransformSuccessEventRequest(BaseModel):
+    transformation: UploadPostTransformSuccessEventRequestTransformation
 
     x_request_id: str
     """Unique identifier for the originating request."""
 
 
-class UploadPostTransformSuccessEvent(BaseModel):
-    id: str
-    """Unique identifier for the event."""
-
+class UploadPostTransformSuccessEvent(BaseWebhookEvent):
     created_at: datetime
     """Timestamp of when the event occurred in ISO8601 format."""
 
-    data: Data
+    data: UploadPostTransformSuccessEventData
 
-    request: Request
+    request: UploadPostTransformSuccessEventRequest
 
-    type: Literal["upload.post-transform.success"]
+    type: Literal["upload.post-transform.success"]  # type: ignore

src/imagekit/types/upload_pre_transform_error_event.py

@@ -4,46 +4,50 @@
 from typing_extensions import Literal
 
 from .._models import BaseModel
+from .base_webhook_event import BaseWebhookEvent
 
-__all__ = ["UploadPreTransformErrorEvent", "Data", "DataTransformation", "DataTransformationError", "Request"]
+__all__ = [
+    "UploadPreTransformErrorEvent",
+    "UploadPreTransformErrorEventData",
+    "UploadPreTransformErrorEventDataTransformation",
+    "UploadPreTransformErrorEventDataTransformationError",
+    "UploadPreTransformErrorEventRequest",
+]
 
 
-class DataTransformationError(BaseModel):
+class UploadPreTransformErrorEventDataTransformationError(BaseModel):
     reason: str
     """Reason for the pre-transformation failure."""
 
 
-class DataTransformation(BaseModel):
-    error: DataTransformationError
+class UploadPreTransformErrorEventDataTransformation(BaseModel):
+    error: UploadPreTransformErrorEventDataTransformationError
 
 
-class Data(BaseModel):
+class UploadPreTransformErrorEventData(BaseModel):
     name: str
     """Name of the file."""
 
     path: str
     """Path of the file."""
 
-    transformation: DataTransformation
+    transformation: UploadPreTransformErrorEventDataTransformation
 
 
-class Request(BaseModel):
+class UploadPreTransformErrorEventRequest(BaseModel):
     transformation: str
     """The requested pre-transformation string."""
 
     x_request_id: str
     """Unique identifier for the originating request."""
 
 
-class UploadPreTransformErrorEvent(BaseModel):
-    id: str
-    """Unique identifier for the event."""
-
+class UploadPreTransformErrorEvent(BaseWebhookEvent):
     created_at: datetime
     """Timestamp of when the event occurred in ISO8601 format."""
 
-    data: Data
+    data: UploadPreTransformErrorEventData
 
-    request: Request
+    request: UploadPreTransformErrorEventRequest
 
-    type: Literal["upload.pre-transform.error"]
+    type: Literal["upload.pre-transform.error"]  # type: ignore

src/imagekit/types/upload_pre_transform_success_event.py

@@ -8,11 +8,19 @@
 
 from .._models import BaseModel
 from .metadata import Metadata
+from .base_webhook_event import BaseWebhookEvent
 
-__all__ = ["UploadPreTransformSuccessEvent", "Data", "DataAITag", "DataExtensionStatus", "DataVersionInfo", "Request"]
+__all__ = [
+    "UploadPreTransformSuccessEvent",
+    "UploadPreTransformSuccessEventData",
+    "UploadPreTransformSuccessEventDataAITag",
+    "UploadPreTransformSuccessEventDataExtensionStatus",
+    "UploadPreTransformSuccessEventDataVersionInfo",
+    "UploadPreTransformSuccessEventRequest",
+]
 
 
-class DataAITag(BaseModel):
+class UploadPreTransformSuccessEventDataAITag(BaseModel):
     confidence: Optional[float] = None
     """Confidence score of the tag."""
 
@@ -27,7 +35,7 @@ class DataAITag(BaseModel):
     """
 
 
-class DataExtensionStatus(BaseModel):
+class UploadPreTransformSuccessEventDataExtensionStatus(BaseModel):
     ai_auto_description: Optional[Literal["success", "pending", "failed"]] = FieldInfo(
         alias="ai-auto-description", default=None
     )
@@ -43,16 +51,16 @@ class DataExtensionStatus(BaseModel):
     remove_bg: Optional[Literal["success", "pending", "failed"]] = FieldInfo(alias="remove-bg", default=None)
 
 
-class DataVersionInfo(BaseModel):
+class UploadPreTransformSuccessEventDataVersionInfo(BaseModel):
     id: Optional[str] = None
     """Unique identifier of the file version."""
 
     name: Optional[str] = None
     """Name of the file version."""
 
 
-class Data(BaseModel):
-    ai_tags: Optional[List[DataAITag]] = FieldInfo(alias="AITags", default=None)
+class UploadPreTransformSuccessEventData(BaseModel):
+    ai_tags: Optional[List[UploadPreTransformSuccessEventDataAITag]] = FieldInfo(alias="AITags", default=None)
     """An array of tags assigned to the uploaded file by auto tagging."""
 
     audio_codec: Optional[str] = FieldInfo(alias="audioCodec", default=None)
@@ -95,7 +103,9 @@ class Data(BaseModel):
     response.
     """
 
-    extension_status: Optional[DataExtensionStatus] = FieldInfo(alias="extensionStatus", default=None)
+    extension_status: Optional[UploadPreTransformSuccessEventDataExtensionStatus] = FieldInfo(
+        alias="extensionStatus", default=None
+    )
     """
     Extension names with their processing status at the time of completion of the
     request. It could have one of the following status values:
@@ -167,7 +177,7 @@ class Data(BaseModel):
     url: Optional[str] = None
     """A publicly accessible URL of the file."""
 
-    version_info: Optional[DataVersionInfo] = FieldInfo(alias="versionInfo", default=None)
+    version_info: Optional[UploadPreTransformSuccessEventDataVersionInfo] = FieldInfo(alias="versionInfo", default=None)
     """An object containing the file or file version's `id` (versionId) and `name`."""
 
     video_codec: Optional[str] = FieldInfo(alias="videoCodec", default=None)
@@ -177,24 +187,21 @@ class Data(BaseModel):
     """Width of the image in pixels (Only for Images)"""
 
 
-class Request(BaseModel):
+class UploadPreTransformSuccessEventRequest(BaseModel):
     transformation: str
     """The requested pre-transformation string."""
 
     x_request_id: str
     """Unique identifier for the originating request."""
 
 
-class UploadPreTransformSuccessEvent(BaseModel):
-    id: str
-    """Unique identifier for the event."""
-
+class UploadPreTransformSuccessEvent(BaseWebhookEvent):
     created_at: datetime
     """Timestamp of when the event occurred in ISO8601 format."""
 
-    data: Data
+    data: UploadPreTransformSuccessEventData
     """Object containing details of a successful upload."""
 
-    request: Request
+    request: UploadPreTransformSuccessEventRequest
 
-    type: Literal["upload.pre-transform.success"]
+    type: Literal["upload.pre-transform.success"]  # type: ignore