feat(api): dam related webhook events

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 48
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-63aff1629530786015da3c86131afa8a9b60545d488884b77641f1d4b89c6e9d.yml
-openapi_spec_hash: 586d357bd7e5217d240a99e0d83c6d1f
-config_hash: 47cb702ee2cb52c58d803ae39ade9b44
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-1422f7513f230162270b197061e5768c2e0c803b94b8cd03a5e72544ac75a27f.yml
+openapi_spec_hash: 41175e752e6f6ce900b36aecba687fa7
+config_hash: 17e408231b0b01676298010c7405f483

README.md

@@ -50,7 +50,6 @@ pip install imagekitio
 The full API of this library can be found in [api.md](api.md).
 
 ```python
-import os
 from imagekitio import ImageKit
 
 client = ImageKit(
@@ -122,7 +121,6 @@ print(response.file_id)
 Simply import `AsyncImageKit` instead of `ImageKit` and use `await` with each API call:
 
 ```python
-import os
 import asyncio
 from imagekitio import AsyncImageKit
 
@@ -163,7 +161,6 @@ pip install imagekitio[aiohttp]
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
-import os
 import asyncio
 from imagekitio import DefaultAioHttpClient
 from imagekitio import AsyncImageKit
@@ -506,7 +503,9 @@ from pathlib import Path
 from imagekitio import ImageKit
 import io
 
-client = ImageKit()
+client = ImageKit(
+    private_key="My Private Key",
+)
 
 # Method 1: Upload from bytes
 # Read file into memory first, then upload
@@ -580,7 +579,9 @@ All errors inherit from `imagekitio.APIError`.
 import imagekitio
 from imagekitio import ImageKit
 
-client = ImageKit()
+client = ImageKit(
+    private_key="My Private Key",
+)
 
 try:
     # Read file into memory and upload
@@ -628,6 +629,7 @@ from imagekitio import ImageKit
 
 # Configure the default for all requests:
 client = ImageKit(
+    private_key="My Private Key",
     # default is 2
     max_retries=0,
 )
@@ -652,12 +654,14 @@ from imagekitio import ImageKit
 
 # Configure the default for all requests:
 client = ImageKit(
+    private_key="My Private Key",
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
 client = ImageKit(
+    private_key="My Private Key",
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
@@ -796,6 +800,7 @@ import httpx
 from imagekitio import ImageKit, DefaultHttpxClient
 
 client = ImageKit(
+    private_key="My Private Key",
     # Or use the `IMAGE_KIT_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
@@ -818,7 +823,9 @@ By default the library closes underlying HTTP connections whenever the client is
 ```py
 from imagekitio import ImageKit
 
-with ImageKit() as client:
+with ImageKit(
+    private_key="My Private Key",
+) as client:
   # make requests here
   ...
 

api.md

@@ -265,6 +265,11 @@ Types:
 ```python
 from imagekitio.types import (
     BaseWebhookEvent,
+    DamFileCreateEvent,
+    DamFileDeleteEvent,
+    DamFileUpdateEvent,
+    DamFileVersionCreateEvent,
+    DamFileVersionDeleteEvent,
     UploadPostTransformErrorEvent,
     UploadPostTransformSuccessEvent,
     UploadPreTransformErrorEvent,

src/imagekitio/_client.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import os
-import base64
 from typing import TYPE_CHECKING, Any, Mapping
 from typing_extensions import Self, override
 
@@ -13,7 +12,6 @@
 from ._qs import Querystring
 from ._types import (
     Omit,
-    Headers,
     Timeout,
     NotGiven,
     Transport,
@@ -218,15 +216,6 @@ def with_streaming_response(self) -> ImageKitWithStreamedResponse:
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
-    @property
-    @override
-    def auth_headers(self) -> dict[str, str]:
-        if self.password is None:
-            return {}
-        credentials = f"{self.private_key}:{self.password}".encode("ascii")
-        header = f"Basic {base64.b64encode(credentials).decode('ascii')}"
-        return {"Authorization": header}
-
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]:
@@ -236,15 +225,6 @@ def default_headers(self) -> dict[str, str | Omit]:
             **self._custom_headers,
         }
 
-    @override
-    def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
-        if headers.get("Authorization") or isinstance(custom_headers.get("Authorization"), Omit):
-            return
-
-        raise TypeError(
-            '"Could not resolve authentication method. Expected the private_key or password to be set. Or for the `Authorization` headers to be explicitly omitted"'
-        )
-
     def copy(
         self,
         *,
@@ -486,15 +466,6 @@ def with_streaming_response(self) -> AsyncImageKitWithStreamedResponse:
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
-    @property
-    @override
-    def auth_headers(self) -> dict[str, str]:
-        if self.password is None:
-            return {}
-        credentials = f"{self.private_key}:{self.password}".encode("ascii")
-        header = f"Basic {base64.b64encode(credentials).decode('ascii')}"
-        return {"Authorization": header}
-
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]:
@@ -504,15 +475,6 @@ def default_headers(self) -> dict[str, str | Omit]:
             **self._custom_headers,
         }
 
-    @override
-    def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
-        if headers.get("Authorization") or isinstance(custom_headers.get("Authorization"), Omit):
-            return
-
-        raise TypeError(
-            '"Could not resolve authentication method. Expected the private_key or password to be set. Or for the `Authorization` headers to be explicitly omitted"'
-        )
-
     def copy(
         self,
         *,

src/imagekitio/types/__init__.py

@@ -53,11 +53,16 @@
 from .folder_rename_params import FolderRenameParams as FolderRenameParams
 from .unwrap_webhook_event import UnwrapWebhookEvent as UnwrapWebhookEvent
 from .custom_metadata_field import CustomMetadataField as CustomMetadataField
+from .dam_file_create_event import DamFileCreateEvent as DamFileCreateEvent
+from .dam_file_delete_event import DamFileDeleteEvent as DamFileDeleteEvent
+from .dam_file_update_event import DamFileUpdateEvent as DamFileUpdateEvent
 from .folder_create_response import FolderCreateResponse as FolderCreateResponse
 from .folder_delete_response import FolderDeleteResponse as FolderDeleteResponse
 from .folder_rename_response import FolderRenameResponse as FolderRenameResponse
 from .update_file_request_param import UpdateFileRequestParam as UpdateFileRequestParam
 from .unsafe_unwrap_webhook_event import UnsafeUnwrapWebhookEvent as UnsafeUnwrapWebhookEvent
+from .dam_file_version_create_event import DamFileVersionCreateEvent as DamFileVersionCreateEvent
+from .dam_file_version_delete_event import DamFileVersionDeleteEvent as DamFileVersionDeleteEvent
 from .saved_extension_create_params import SavedExtensionCreateParams as SavedExtensionCreateParams
 from .saved_extension_list_response import SavedExtensionListResponse as SavedExtensionListResponse
 from .saved_extension_update_params import SavedExtensionUpdateParams as SavedExtensionUpdateParams

src/imagekitio/types/dam_file_create_event.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .file import File
+from .base_webhook_event import BaseWebhookEvent
+
+__all__ = ["DamFileCreateEvent"]
+
+
+class DamFileCreateEvent(BaseWebhookEvent):
+    """Triggered when a file is created."""
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: File
+    """Object containing details of a file or file version."""
+
+    type: Literal["file.created"]  # type: ignore
+    """Type of the webhook event."""

src/imagekitio/types/dam_file_delete_event.py

@@ -0,0 +1,28 @@
+# 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__ = ["DamFileDeleteEvent", "DamFileDeleteEventData"]
+
+
+class DamFileDeleteEventData(BaseModel):
+    file_id: str = FieldInfo(alias="fileId")
+    """The unique `fileId` of the deleted file."""
+
+
+class DamFileDeleteEvent(BaseWebhookEvent):
+    """Triggered when a file is deleted."""
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: DamFileDeleteEventData
+
+    type: Literal["file.deleted"]  # type: ignore
+    """Type of the webhook event."""

src/imagekitio/types/dam_file_update_event.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .file import File
+from .base_webhook_event import BaseWebhookEvent
+
+__all__ = ["DamFileUpdateEvent"]
+
+
+class DamFileUpdateEvent(BaseWebhookEvent):
+    """Triggered when a file is updated."""
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: File
+    """Object containing details of a file or file version."""
+
+    type: Literal["file.updated"]  # type: ignore
+    """Type of the webhook event."""

src/imagekitio/types/dam_file_version_create_event.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .base_webhook_event import BaseWebhookEvent
+
+__all__ = ["DamFileVersionCreateEvent"]
+
+
+class DamFileVersionCreateEvent(BaseWebhookEvent):
+    """Triggered when a file version is created."""
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: object
+
+    type: Literal["file-version.created"]  # type: ignore
+    """Type of the webhook event."""

src/imagekitio/types/dam_file_version_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__ = ["DamFileVersionDeleteEvent", "DamFileVersionDeleteEventData"]
+
+
+class DamFileVersionDeleteEventData(BaseModel):
+    file_id: str = FieldInfo(alias="fileId")
+    """The unique `fileId` of the deleted file."""
+
+    version_id: str = FieldInfo(alias="versionId")
+    """The unique `versionId` of the deleted file version."""
+
+
+class DamFileVersionDeleteEvent(BaseWebhookEvent):
+    """Triggered when a file version is deleted."""
+
+    created_at: datetime
+    """Timestamp of when the event occurred in ISO8601 format."""
+
+    data: DamFileVersionDeleteEventData
+
+    type: Literal["file-version.deleted"]  # type: ignore
+    """Type of the webhook event."""