Build SDK

Stainless-Generated-From: 955d7a9

Author: stlc-bot

api.md

@@ -292,6 +292,9 @@ from imagekitio.types import (
     FileUpdateEvent,
     FileVersionCreateEvent,
     FileVersionDeleteEvent,
+    FolderCreateEvent,
+    FolderDeleteEvent,
+    FolderUpdateEvent,
     UploadPostTransformErrorEvent,
     UploadPostTransformSuccessEvent,
     UploadPreTransformErrorEvent,

src/imagekitio/types/__init__.py

@@ -45,6 +45,9 @@
 from .folder_move_params import FolderMoveParams as FolderMoveParams
 from .asset_list_response import AssetListResponse as AssetListResponse
 from .dummy_create_params import DummyCreateParams as DummyCreateParams
+from .folder_create_event import FolderCreateEvent as FolderCreateEvent
+from .folder_delete_event import FolderDeleteEvent as FolderDeleteEvent
+from .folder_update_event import FolderUpdateEvent as FolderUpdateEvent
 from .file_rename_response import FileRenameResponse as FileRenameResponse
 from .file_update_response import FileUpdateResponse as FileUpdateResponse
 from .file_upload_response import FileUploadResponse as FileUploadResponse

src/imagekitio/types/folder.py

@@ -8,7 +8,20 @@
 
 from .._models import BaseModel
 
-__all__ = ["Folder"]
+__all__ = ["Folder", "CreatedBy"]
+
+
+class CreatedBy(BaseModel):
+    """Details of the user who created the folder.
+
+    Present only when this information is available. The `name` is the name of the user at the time of folder creation.
+    """
+
+    email: Optional[str] = None
+    """Email of the user who created the folder."""
+
+    name: Optional[str] = None
+    """Name of the user who created the folder."""
 
 
 class Folder(BaseModel):
@@ -18,6 +31,13 @@ class Folder(BaseModel):
     The date and time is in ISO8601 format.
     """
 
+    created_by: Optional[CreatedBy] = FieldInfo(alias="createdBy", default=None)
+    """Details of the user who created the folder.
+
+    Present only when this information is available. The `name` is the name of the
+    user at the time of folder creation.
+    """
+
     custom_metadata: Optional[Dict[str, object]] = FieldInfo(alias="customMetadata", default=None)
     """An object with custom metadata for the folder.
 

src/imagekitio/types/folder_create_event.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .folder import Folder
+from .base_webhook_event import BaseWebhookEvent
+
+__all__ = ["FolderCreateEvent"]
+
+
+class FolderCreateEvent(BaseWebhookEvent):
+    """
+    Triggered when a folder is created, whether explicitly, by copying or moving a folder, or implicitly when an upload creates missing parent folders. Copying or moving a folder tree sends one event per folder in the tree.
+    """
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: Folder
+
+    type: Literal["folder.created"]  # type: ignore
+    """Type of the webhook event."""

src/imagekitio/types/folder_delete_event.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .base_webhook_event import BaseWebhookEvent
+
+__all__ = ["FolderDeleteEvent", "FolderDeleteEventData"]
+
+
+class FolderDeleteEventData(BaseModel):
+    folder_id: str = FieldInfo(alias="folderId")
+    """The unique `folderId` of the deleted folder."""
+
+
+class FolderDeleteEvent(BaseWebhookEvent):
+    """Triggered when a folder is deleted.
+
+    Deleting a folder tree sends one event per folder in the tree; the files inside it send `file.deleted` events. Moving a folder sends this event for the old `folderId` and `folder.created` for the new one.
+    """
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: FolderDeleteEventData
+
+    type: Literal["folder.deleted"]  # type: ignore
+    """Type of the webhook event."""

src/imagekitio/types/folder_update_event.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .folder import Folder
+from .base_webhook_event import BaseWebhookEvent
+
+__all__ = ["FolderUpdateEvent"]
+
+
+class FolderUpdateEvent(BaseWebhookEvent):
+    """
+    Triggered when a folder is updated, for example when its custom metadata changes or it is renamed. Renaming a folder sends one event per folder in the tree, each with its new `folderPath`.
+    """
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: Folder
+
+    type: Literal["folder.updated"]  # type: ignore
+    """Type of the webhook event."""

src/imagekitio/types/unsafe_unwrap_webhook_event.py

@@ -7,6 +7,9 @@
 from .file_create_event import FileCreateEvent
 from .file_delete_event import FileDeleteEvent
 from .file_update_event import FileUpdateEvent
+from .folder_create_event import FolderCreateEvent
+from .folder_delete_event import FolderDeleteEvent
+from .folder_update_event import FolderUpdateEvent
 from .file_version_create_event import FileVersionCreateEvent
 from .file_version_delete_event import FileVersionDeleteEvent
 from .upload_pre_transform_error_event import UploadPreTransformErrorEvent
@@ -33,6 +36,9 @@
         FileDeleteEvent,
         FileVersionCreateEvent,
         FileVersionDeleteEvent,
+        FolderCreateEvent,
+        FolderUpdateEvent,
+        FolderDeleteEvent,
     ],
     PropertyInfo(discriminator="type"),
 ]

src/imagekitio/types/unwrap_webhook_event.py

@@ -7,6 +7,9 @@
 from .file_create_event import FileCreateEvent
 from .file_delete_event import FileDeleteEvent
 from .file_update_event import FileUpdateEvent
+from .folder_create_event import FolderCreateEvent
+from .folder_delete_event import FolderDeleteEvent
+from .folder_update_event import FolderUpdateEvent
 from .file_version_create_event import FileVersionCreateEvent
 from .file_version_delete_event import FileVersionDeleteEvent
 from .upload_pre_transform_error_event import UploadPreTransformErrorEvent
@@ -33,6 +36,9 @@
         FileDeleteEvent,
         FileVersionCreateEvent,
         FileVersionDeleteEvent,
+        FolderCreateEvent,
+        FolderUpdateEvent,
+        FolderDeleteEvent,
     ],
     PropertyInfo(discriminator="type"),
 ]