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

@@ -42,6 +42,7 @@ Types:
 - <code><a href="./src/resources/files/files.ts">File</a></code>
 - <code><a href="./src/resources/files/files.ts">Folder</a></code>
 - <code><a href="./src/resources/files/files.ts">Metadata</a></code>
+- <code><a href="./src/resources/files/files.ts">UpdateFileDetailsRequest</a></code>
 - <code><a href="./src/resources/files/files.ts">FileUpdateResponse</a></code>
 - <code><a href="./src/resources/files/files.ts">FileCopyResponse</a></code>
 - <code><a href="./src/resources/files/files.ts">FileMoveResponse</a></code>

src/client.ts

@@ -57,6 +57,7 @@ import {
   Files,
   Folder,
   Metadata,
+  UpdateFileDetailsRequest,
 } from './resources/files/files';
 import {
   FolderCopyParams,
@@ -855,6 +856,7 @@ export declare namespace ImageKit {
     type File as File,
     type Folder as Folder,
     type Metadata as Metadata,
+    type UpdateFileDetailsRequest as UpdateFileDetailsRequest,
     type FileUpdateResponse as FileUpdateResponse,
     type FileCopyResponse as FileCopyResponse,
     type FileMoveResponse as FileMoveResponse,

src/resources/files/files.ts

@@ -629,6 +629,89 @@ export namespace Metadata {
   }
 }
 
+export type UpdateFileDetailsRequest =
+  | UpdateFileDetailsRequest.UpdateFileDetails
+  | UpdateFileDetailsRequest.ChangePublicationStatus;
+
+export namespace UpdateFileDetailsRequest {
+  export interface UpdateFileDetails {
+    /**
+     * 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.
+     */
+    customCoordinates?: string | null;
+
+    /**
+     * 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.
+     */
+    customMetadata?: { [key: string]: unknown };
+
+    /**
+     * Optional text to describe the contents of the file.
+     */
+    description?: string;
+
+    /**
+     * Array of extensions to be applied to the asset. Each extension can be configured
+     * with specific parameters based on the extension type.
+     */
+    extensions?: Shared.Extensions;
+
+    /**
+     * 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.
+     */
+    removeAITags?: Array<string> | 'all';
+
+    /**
+     * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send
+     * `null` to unset all tags associated with the file.
+     */
+    tags?: Array<string> | null;
+
+    /**
+     * 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.
+     */
+    webhookUrl?: string;
+  }
+
+  export interface ChangePublicationStatus {
+    /**
+     * Configure the publication status of a file and its versions.
+     */
+    publish?: ChangePublicationStatus.Publish;
+  }
+
+  export namespace ChangePublicationStatus {
+    /**
+     * Configure the publication status of a file and its versions.
+     */
+    export interface Publish {
+      /**
+       * Set to `true` to publish the file. Set to `false` to unpublish the file.
+       */
+      isPublished: boolean;
+
+      /**
+       * Set to `true` to publish/unpublish all versions of the file. Set to `false` to
+       * publish/unpublish only the current version of the file.
+       */
+      includeFileVersions?: boolean;
+    }
+  }
+}
+
 /**
  * Object containing details of a file or file version.
  */
@@ -1328,6 +1411,7 @@ export declare namespace Files {
     type File as File,
     type Folder as Folder,
     type Metadata as Metadata,
+    type UpdateFileDetailsRequest as UpdateFileDetailsRequest,
     type FileUpdateResponse as FileUpdateResponse,
     type FileCopyResponse as FileCopyResponse,
     type FileMoveResponse as FileMoveResponse,

src/resources/files/index.ts

@@ -16,6 +16,7 @@ export {
   type File,
   type Folder,
   type Metadata,
+  type UpdateFileDetailsRequest,
   type FileUpdateResponse,
   type FileCopyResponse,
   type FileMoveResponse,

src/resources/index.ts

@@ -19,6 +19,7 @@ export {
   type File,
   type Folder,
   type Metadata,
+  type UpdateFileDetailsRequest,
   type FileUpdateResponse,
   type FileCopyResponse,
   type FileMoveResponse,