feat(api): manual updates

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: b415c06a3b29485af4601beb94ae1aeb
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-dd864816d7f4316ae89f57394da2fd1926166d4704db5a0bb5d23461d2d75e49.yml
+openapi_spec_hash: 7f7c416563a15bbaea98804ecdc1a8f9
+config_hash: 54c05a157f2cc730fac9e1df5dc3ca29

api.md

@@ -42,7 +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">UpdateFileRequest</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,7 +57,7 @@ import {
   Files,
   Folder,
   Metadata,
-  UpdateFileDetailsRequest,
+  UpdateFileRequest,
 } from './resources/files/files';
 import {
   FolderCopyParams,
@@ -856,7 +856,7 @@ export declare namespace ImageKit {
     type File as File,
     type Folder as Folder,
     type Metadata as Metadata,
-    type UpdateFileDetailsRequest as UpdateFileDetailsRequest,
+    type UpdateFileRequest as UpdateFileRequest,
     type FileUpdateResponse as FileUpdateResponse,
     type FileCopyResponse as FileCopyResponse,
     type FileMoveResponse as FileMoveResponse,

src/resources/files/files.ts

@@ -44,35 +44,11 @@ export class Files extends APIResource {
    *
    * @example
    * ```ts
-   * const file = await client.files.update('fileId', {
-   *   customCoordinates: '10,10,100,100',
-   *   customMetadata: { brand: 'Nike', color: 'red' },
-   *   extensions: [
-   *     { name: 'remove-bg', options: { add_shadow: true } },
-   *     {
-   *       name: 'google-auto-tagging',
-   *       minConfidence: 80,
-   *       maxTags: 10,
-   *     },
-   *     {
-   *       name: 'aws-auto-tagging',
-   *       minConfidence: 80,
-   *       maxTags: 10,
-   *     },
-   *     { name: 'ai-auto-description' },
-   *   ],
-   *   removeAITags: ['car', 'vehicle', 'motorsports'],
-   *   tags: ['tag1', 'tag2'],
-   *   webhookUrl:
-   *     'https://webhook.site/0d6b6c7a-8e5a-4b3a-8b7c-0d6b6c7a8e5a',
-   * });
+   * const file = await client.files.update('fileId');
    * ```
    */
-  update(
-    fileID: string,
-    body: FileUpdateParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<FileUpdateResponse> {
+  update(fileID: string, params: FileUpdateParams, options?: RequestOptions): APIPromise<FileUpdateResponse> {
+    const body = 'body' in params ? params.body : params;
     return this._client.patch(path`/v1/files/${fileID}/details`, { body, ...options });
   }
 
@@ -629,11 +605,12 @@ export namespace Metadata {
   }
 }
 
-export type UpdateFileDetailsRequest =
-  | UpdateFileDetailsRequest.UpdateFileDetails
-  | UpdateFileDetailsRequest.ChangePublicationStatus;
+/**
+ * Schema for update file update request.
+ */
+export type UpdateFileRequest = UpdateFileRequest.UpdateFileDetails | unknown;
 
-export namespace UpdateFileDetailsRequest {
+export namespace UpdateFileRequest {
   export interface UpdateFileDetails {
     /**
      * Define an important area in the image in the format `x,y,width,height` e.g.
@@ -685,31 +662,6 @@ export namespace UpdateFileDetailsRequest {
      */
     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;
-    }
-  }
 }
 
 /**
@@ -1008,28 +960,7 @@ export declare namespace FileUpdateParams {
   }
 
   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;
-    }
+    body: unknown;
   }
 }
 
@@ -1411,7 +1342,7 @@ export declare namespace Files {
     type File as File,
     type Folder as Folder,
     type Metadata as Metadata,
-    type UpdateFileDetailsRequest as UpdateFileDetailsRequest,
+    type UpdateFileRequest as UpdateFileRequest,
     type FileUpdateResponse as FileUpdateResponse,
     type FileCopyResponse as FileCopyResponse,
     type FileMoveResponse as FileMoveResponse,

src/resources/files/index.ts

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

src/resources/index.ts

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

tests/api-resources/files/files.test.ts

@@ -11,7 +11,7 @@ const client = new ImageKit({
 describe('resource files', () => {
   // Prism tests are disabled
   test.skip('update', async () => {
-    const responsePromise = client.files.update('fileId');
+    const responsePromise = client.files.update('fileId', {});
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -21,38 +21,6 @@ describe('resource files', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  // Prism tests are disabled
-  test.skip('update: request options and params are passed correctly', async () => {
-    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
-    await expect(
-      client.files.update(
-        'fileId',
-        {
-          customCoordinates: 'customCoordinates',
-          customMetadata: { foo: 'bar' },
-          description: 'description',
-          extensions: [
-            {
-              name: 'remove-bg',
-              options: {
-                add_shadow: true,
-                bg_color: 'bg_color',
-                bg_image_url: 'bg_image_url',
-                semitransparency: true,
-              },
-            },
-            { maxTags: 5, minConfidence: 95, name: 'google-auto-tagging' },
-            { name: 'ai-auto-description' },
-          ],
-          removeAITags: ['string'],
-          tags: ['tag1', 'tag2'],
-          webhookUrl: 'https://example.com',
-        },
-        { path: '/_stainless_unknown_path' },
-      ),
-    ).rejects.toThrow(ImageKit.NotFoundError);
-  });
-
   // Prism tests are disabled
   test.skip('delete', async () => {
     const responsePromise = client.files.delete('fileId');