Build SDK

Stainless-Generated-From: 3eaa450

Author: stlc-bot

api.md

@@ -137,15 +137,15 @@ Methods:
 Types:
 
 ```python
-from imagekitio.types import NamedTransformationListResponse
+from imagekitio.types import NamedTransformationListResponse, NamedTransformationDeleteResponse
 ```
 
 Methods:
 
 - <code title="post /v1/named-transformations">client.named_transformations.<a href="./src/imagekitio/resources/named_transformations.py">create</a>(\*\*<a href="src/imagekitio/types/named_transformation_create_params.py">params</a>) -> <a href="./src/imagekitio/types/shared/named_transformation.py">NamedTransformation</a></code>
 - <code title="patch /v1/named-transformations/{id}">client.named_transformations.<a href="./src/imagekitio/resources/named_transformations.py">update</a>(id, \*\*<a href="src/imagekitio/types/named_transformation_update_params.py">params</a>) -> <a href="./src/imagekitio/types/shared/named_transformation.py">NamedTransformation</a></code>
 - <code title="get /v1/named-transformations">client.named_transformations.<a href="./src/imagekitio/resources/named_transformations.py">list</a>() -> <a href="./src/imagekitio/types/named_transformation_list_response.py">NamedTransformationListResponse</a></code>
-- <code title="delete /v1/named-transformations/{id}">client.named_transformations.<a href="./src/imagekitio/resources/named_transformations.py">delete</a>(id) -> <a href="./src/imagekitio/types/shared/named_transformation.py">NamedTransformation</a></code>
+- <code title="delete /v1/named-transformations/{id}">client.named_transformations.<a href="./src/imagekitio/resources/named_transformations.py">delete</a>(id) -> <a href="./src/imagekitio/types/named_transformation_delete_response.py">NamedTransformationDeleteResponse</a></code>
 - <code title="get /v1/named-transformations/{id}">client.named_transformations.<a href="./src/imagekitio/resources/named_transformations.py">get</a>(id) -> <a href="./src/imagekitio/types/shared/named_transformation.py">NamedTransformation</a></code>
 
 # Assets

src/imagekitio/resources/custom_metadata_fields.py

@@ -53,6 +53,7 @@ def create(
         label: str,
         name: str,
         schema: custom_metadata_field_create_params.Schema,
+        description: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -76,6 +77,10 @@ def create(
           name: API name of the custom metadata field. This should be unique across all
               (including deleted) custom metadata fields.
 
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              This is shown as a hint to the users while setting the field's value on an asset
+              in the media library UI.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -91,6 +96,7 @@ def create(
                     "label": label,
                     "name": name,
                     "schema": schema,
+                    "description": description,
                 },
                 custom_metadata_field_create_params.CustomMetadataFieldCreateParams,
             ),
@@ -104,6 +110,7 @@ def update(
         self,
         id: str,
         *,
+        description: str | Omit = omit,
         label: str | Omit = omit,
         schema: custom_metadata_field_update_params.Schema | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -114,9 +121,15 @@ def update(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CustomMetadataField:
         """
-        This API updates the label or schema of an existing custom metadata field.
+        This API updates the label, description, or schema of an existing custom
+        metadata field.
 
         Args:
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              Send an empty string to clear an existing description. This is shown as a hint
+              to the users while setting the field's value on an asset in the media library
+              UI.
+
           label: Human readable name of the custom metadata field. This should be unique across
               all non deleted custom metadata fields. This name is displayed as form field
               label to the users while setting field value on an asset in the media library
@@ -141,6 +154,7 @@ def update(
             path_template("/v1/customMetadataFields/{id}", id=id),
             body=maybe_transform(
                 {
+                    "description": description,
                     "label": label,
                     "schema": schema,
                 },
@@ -271,6 +285,7 @@ async def create(
         label: str,
         name: str,
         schema: custom_metadata_field_create_params.Schema,
+        description: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -294,6 +309,10 @@ async def create(
           name: API name of the custom metadata field. This should be unique across all
               (including deleted) custom metadata fields.
 
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              This is shown as a hint to the users while setting the field's value on an asset
+              in the media library UI.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -309,6 +328,7 @@ async def create(
                     "label": label,
                     "name": name,
                     "schema": schema,
+                    "description": description,
                 },
                 custom_metadata_field_create_params.CustomMetadataFieldCreateParams,
             ),
@@ -322,6 +342,7 @@ async def update(
         self,
         id: str,
         *,
+        description: str | Omit = omit,
         label: str | Omit = omit,
         schema: custom_metadata_field_update_params.Schema | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -332,9 +353,15 @@ async def update(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CustomMetadataField:
         """
-        This API updates the label or schema of an existing custom metadata field.
+        This API updates the label, description, or schema of an existing custom
+        metadata field.
 
         Args:
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              Send an empty string to clear an existing description. This is shown as a hint
+              to the users while setting the field's value on an asset in the media library
+              UI.
+
           label: Human readable name of the custom metadata field. This should be unique across
               all non deleted custom metadata fields. This name is displayed as form field
               label to the users while setting field value on an asset in the media library
@@ -359,6 +386,7 @@ async def update(
             path_template("/v1/customMetadataFields/{id}", id=id),
             body=await async_maybe_transform(
                 {
+                    "description": description,
                     "label": label,
                     "schema": schema,
                 },

src/imagekitio/resources/named_transformations.py

@@ -18,6 +18,7 @@
 from .._base_client import make_request_options
 from ..types.shared.named_transformation import NamedTransformation
 from ..types.named_transformation_list_response import NamedTransformationListResponse
+from ..types.named_transformation_delete_response import NamedTransformationDeleteResponse
 
 __all__ = ["NamedTransformationsResource", "AsyncNamedTransformationsResource"]
 
@@ -71,15 +72,14 @@ def create(
               account. Name matching is case-sensitive.
 
           transformation: The transformation string this name refers to, for example
-              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
-              automatically if missing, and validated if present. The string must be a valid
-              ImageKit transformation and cannot itself reference another named transformation
-              (no nesting). Learn more about the
+              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional; if present, it
+              is validated. The string must be a valid ImageKit transformation and cannot
+              itself reference another named transformation (no nesting). Learn more about the
               [transformation syntax](https://imagekit.io/docs/transformations).
 
-          enabled: Whether the named transformation is enabled. Set to `false` to disable it
-              without deleting it; requests using a disabled named transformation fail at
-              delivery time.
+          enabled: Whether the named transformation is currently enabled. When this is set to
+              `false`, requests using such disabled named transformations fail at delivery
+              time.
 
           extra_headers: Send extra headers
 
@@ -130,6 +130,8 @@ def update(
         references in your own application code or in previously generated URLs.
 
         Args:
+          id: Unique identifier for a named transformation.
+
           enabled: Whether the named transformation is enabled. Omit to leave the current value
               unchanged.
 
@@ -138,10 +140,9 @@ def update(
               account. Name matching is case-sensitive.
 
           transformation: The transformation string this name refers to, for example
-              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
-              automatically if missing, and validated if present. The string must be a valid
-              ImageKit transformation and cannot itself reference another named transformation
-              (no nesting). Learn more about the
+              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional; if present, it
+              is validated. The string must be a valid ImageKit transformation and cannot
+              itself reference another named transformation (no nesting). Learn more about the
               [transformation syntax](https://imagekit.io/docs/transformations).
 
           extra_headers: Send extra headers
@@ -199,17 +200,18 @@ def delete(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> NamedTransformation:
+    ) -> NamedTransformationDeleteResponse:
         """
-        Permanently deletes the named transformation identified by `id` and returns the
-        deleted object.
+        Permanently deletes the named transformation identified by `id`.
 
         Deletion fails with a `409` error if the named transformation is still
         referenced (via the `n-<name>` token) by an upload pre-transformation or
         post-transformation setting. This check is best-effort and can't detect
         references in your own application code or in previously generated URLs.
 
         Args:
+          id: Unique identifier for a named transformation.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -225,7 +227,7 @@ def delete(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NamedTransformation,
+            cast_to=NamedTransformationDeleteResponse,
         )
 
     def get(
@@ -243,6 +245,8 @@ def get(
         Retrieves the named transformation identified by `id`.
 
         Args:
+          id: Unique identifier for a named transformation.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -311,15 +315,14 @@ async def create(
               account. Name matching is case-sensitive.
 
           transformation: The transformation string this name refers to, for example
-              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
-              automatically if missing, and validated if present. The string must be a valid
-              ImageKit transformation and cannot itself reference another named transformation
-              (no nesting). Learn more about the
+              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional; if present, it
+              is validated. The string must be a valid ImageKit transformation and cannot
+              itself reference another named transformation (no nesting). Learn more about the
               [transformation syntax](https://imagekit.io/docs/transformations).
 
-          enabled: Whether the named transformation is enabled. Set to `false` to disable it
-              without deleting it; requests using a disabled named transformation fail at
-              delivery time.
+          enabled: Whether the named transformation is currently enabled. When this is set to
+              `false`, requests using such disabled named transformations fail at delivery
+              time.
 
           extra_headers: Send extra headers
 
@@ -370,6 +373,8 @@ async def update(
         references in your own application code or in previously generated URLs.
 
         Args:
+          id: Unique identifier for a named transformation.
+
           enabled: Whether the named transformation is enabled. Omit to leave the current value
               unchanged.
 
@@ -378,10 +383,9 @@ async def update(
               account. Name matching is case-sensitive.
 
           transformation: The transformation string this name refers to, for example
-              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
-              automatically if missing, and validated if present. The string must be a valid
-              ImageKit transformation and cannot itself reference another named transformation
-              (no nesting). Learn more about the
+              `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional; if present, it
+              is validated. The string must be a valid ImageKit transformation and cannot
+              itself reference another named transformation (no nesting). Learn more about the
               [transformation syntax](https://imagekit.io/docs/transformations).
 
           extra_headers: Send extra headers
@@ -439,17 +443,18 @@ async def delete(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> NamedTransformation:
+    ) -> NamedTransformationDeleteResponse:
         """
-        Permanently deletes the named transformation identified by `id` and returns the
-        deleted object.
+        Permanently deletes the named transformation identified by `id`.
 
         Deletion fails with a `409` error if the named transformation is still
         referenced (via the `n-<name>` token) by an upload pre-transformation or
         post-transformation setting. This check is best-effort and can't detect
         references in your own application code or in previously generated URLs.
 
         Args:
+          id: Unique identifier for a named transformation.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -465,7 +470,7 @@ async def delete(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NamedTransformation,
+            cast_to=NamedTransformationDeleteResponse,
         )
 
     async def get(
@@ -483,6 +488,8 @@ async def get(
         Retrieves the named transformation identified by `id`.
 
         Args:
+          id: Unique identifier for a named transformation.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request

src/imagekitio/types/__init__.py

@@ -81,6 +81,7 @@
 from .custom_metadata_field_update_params import CustomMetadataFieldUpdateParams as CustomMetadataFieldUpdateParams
 from .upload_post_transform_success_event import UploadPostTransformSuccessEvent as UploadPostTransformSuccessEvent
 from .video_transformation_accepted_event import VideoTransformationAcceptedEvent as VideoTransformationAcceptedEvent
+from .named_transformation_delete_response import NamedTransformationDeleteResponse as NamedTransformationDeleteResponse
 from .custom_metadata_field_delete_response import (
     CustomMetadataFieldDeleteResponse as CustomMetadataFieldDeleteResponse,
 )

src/imagekitio/types/custom_metadata_field.py

@@ -75,3 +75,10 @@ class CustomMetadataField(BaseModel):
 
     schema_: Schema = FieldInfo(alias="schema")
     """An object that describes the rules for the custom metadata field value."""
+
+    description: Optional[str] = None
+    """Optional description of the custom metadata field.
+
+    Only present when a description has been set. Shown as a hint to the users while
+    setting the field's value on an asset in the media library UI.
+    """

src/imagekitio/types/custom_metadata_field_create_params.py

@@ -28,6 +28,13 @@ class CustomMetadataFieldCreateParams(TypedDict, total=False):
 
     schema: Required[Schema]
 
+    description: str
+    """Optional description for the custom metadata field.
+
+    Can be up to 500 characters. This is shown as a hint to the users while setting
+    the field's value on an asset in the media library UI.
+    """
+
 
 class Schema(TypedDict, total=False):
     type: Required[Literal["Text", "Textarea", "Number", "Date", "Boolean", "SingleSelect", "MultiSelect"]]

src/imagekitio/types/custom_metadata_field_update_params.py

@@ -12,6 +12,14 @@
 
 
 class CustomMetadataFieldUpdateParams(TypedDict, total=False):
+    description: str
+    """Optional description for the custom metadata field.
+
+    Can be up to 500 characters. Send an empty string to clear an existing
+    description. This is shown as a hint to the users while setting the field's
+    value on an asset in the media library UI.
+    """
+
     label: str
     """Human readable name of the custom metadata field.
 

src/imagekitio/types/named_transformation_create_params.py

@@ -18,16 +18,15 @@ class NamedTransformationCreateParams(TypedDict, total=False):
     transformation: Required[str]
     """
     The transformation string this name refers to, for example
-    `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
-    automatically if missing, and validated if present. The string must be a valid
-    ImageKit transformation and cannot itself reference another named transformation
-    (no nesting). Learn more about the
+    `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional; if present, it
+    is validated. The string must be a valid ImageKit transformation and cannot
+    itself reference another named transformation (no nesting). Learn more about the
     [transformation syntax](https://imagekit.io/docs/transformations).
     """
 
     enabled: bool
-    """Whether the named transformation is enabled.
+    """Whether the named transformation is currently enabled.
 
-    Set to `false` to disable it without deleting it; requests using a disabled
-    named transformation fail at delivery time.
+    When this is set to `false`, requests using such disabled named transformations
+    fail at delivery time.
     """

src/imagekitio/types/named_transformation_delete_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["NamedTransformationDeleteResponse"]
+
+
+class NamedTransformationDeleteResponse(BaseModel):
+    pass