feat(api): extract UpdateFileDetailsRequest to model

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-bc7c0d27962b30c19c778656988e154b54696819389289f34420a5e5fdfbd3b8.yml
 openapi_spec_hash: 1bfde02a63416c036e9545927f727459
-config_hash: a652d68098d82eaf611a49507fb4b831
+config_hash: b415c06a3b29485af4601beb94ae1aeb

api.md

@@ -50,6 +50,7 @@ from imagekit.types import (
     File,
     Folder,
     Metadata,
+    UpdateFileDetailsRequest,
     FileUpdateResponse,
     FileCopyResponse,
     FileMoveResponse,

src/imagekit/types/__init__.py

@@ -56,6 +56,7 @@
 from .video_transformation_error_event import VideoTransformationErrorEvent as VideoTransformationErrorEvent
 from .video_transformation_ready_event import VideoTransformationReadyEvent as VideoTransformationReadyEvent
 from .custom_metadata_field_list_params import CustomMetadataFieldListParams as CustomMetadataFieldListParams
+from .update_file_details_request_param import UpdateFileDetailsRequestParam as UpdateFileDetailsRequestParam
 from .upload_post_transform_error_event import UploadPostTransformErrorEvent as UploadPostTransformErrorEvent
 from .upload_pre_transform_success_event import UploadPreTransformSuccessEvent as UploadPreTransformSuccessEvent
 from .custom_metadata_field_create_params import CustomMetadataFieldCreateParams as CustomMetadataFieldCreateParams

src/imagekit/types/update_file_details_request_param.py

@@ -0,0 +1,88 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .shared_params.extensions import Extensions
+
+__all__ = [
+    "UpdateFileDetailsRequestParam",
+    "UpdateFileDetails",
+    "ChangePublicationStatus",
+    "ChangePublicationStatusPublish",
+]
+
+
+class UpdateFileDetails(TypedDict, total=False):
+    custom_coordinates: Annotated[Optional[str], PropertyInfo(alias="customCoordinates")]
+    """Define an important area in the image in the format `x,y,width,height` e.g.
+
+    `10,10,100,100`. Send `null` to unset this value.
+    """
+
+    custom_metadata: Annotated[Dict[str, object], PropertyInfo(alias="customMetadata")]
+    """A key-value data to be associated with the asset.
+
+    To unset a key, send `null` value for that key. Before setting any custom
+    metadata on an asset you have to create the field using custom metadata fields
+    API.
+    """
+
+    description: str
+    """Optional text to describe the contents of the file."""
+
+    extensions: Extensions
+    """Array of extensions to be applied to the asset.
+
+    Each extension can be configured with specific parameters based on the extension
+    type.
+    """
+
+    remove_ai_tags: Annotated[Union[SequenceNotStr[str], Literal["all"]], PropertyInfo(alias="removeAITags")]
+    """An array of AITags associated with the file that you want to remove, e.g.
+
+    `["car", "vehicle", "motorsports"]`.
+
+    If you want to remove all AITags associated with the file, send a string -
+    "all".
+
+    Note: The remove operation for `AITags` executes before any of the `extensions`
+    are processed.
+    """
+
+    tags: Optional[SequenceNotStr[str]]
+    """An array of tags associated with the file, such as `["tag1", "tag2"]`.
+
+    Send `null` to unset all tags associated with the file.
+    """
+
+    webhook_url: Annotated[str, PropertyInfo(alias="webhookUrl")]
+    """
+    The final status of extensions after they have completed execution will be
+    delivered to this endpoint as a POST request.
+    [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure)
+    about the webhook payload structure.
+    """
+
+
+class ChangePublicationStatusPublish(TypedDict, total=False):
+    is_published: Required[Annotated[bool, PropertyInfo(alias="isPublished")]]
+    """Set to `true` to publish the file. Set to `false` to unpublish the file."""
+
+    include_file_versions: Annotated[bool, PropertyInfo(alias="includeFileVersions")]
+    """Set to `true` to publish/unpublish all versions of the file.
+
+    Set to `false` to publish/unpublish only the current version of the file.
+    """
+
+
+class ChangePublicationStatus(TypedDict, total=False):
+    publish: ChangePublicationStatusPublish
+    """Configure the publication status of a file and its versions."""
+
+
+UpdateFileDetailsRequestParam: TypeAlias = Union[UpdateFileDetails, ChangePublicationStatus]