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-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml
 openapi_spec_hash: 1d382866fce3284f26d341f112988d9d
-config_hash: 54c05a157f2cc730fac9e1df5dc3ca29
+config_hash: 29a2351fe2be89392b15719be8bc964f

README.md

@@ -26,7 +26,7 @@ The full API of this library can be found in [api.md](api.md).
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
+  privateKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
   password: process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'], // This is the default and can be omitted
 });
 
@@ -47,7 +47,7 @@ This library includes TypeScript definitions for all request params and response
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
+  privateKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
   password: process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'], // This is the default and can be omitted
 });
 

src/client.ts

@@ -92,11 +92,10 @@ export interface ClientOptions {
    * You can view and manage API keys in the [dashboard](https://imagekit.io/dashboard/developer/api-keys).
    *
    */
-  privateAPIKey?: string | undefined;
+  privateKey?: string | undefined;
 
   /**
-   * ImageKit Basic Auth only uses the username field and ignores the password.
-   * This field is unused.
+   * ImageKit Basic Auth only uses the `private_key` as username and ignores the password.
    *
    */
   password?: string | null | undefined;
@@ -183,7 +182,7 @@ export interface ClientOptions {
  * API Client for interfacing with the Image Kit API.
  */
 export class ImageKit {
-  privateAPIKey: string;
+  privateKey: string;
   password: string | null;
   webhookSecret: string | null;
 
@@ -202,7 +201,7 @@ export class ImageKit {
   /**
    * API Client for interfacing with the Image Kit API.
    *
-   * @param {string | undefined} [opts.privateAPIKey=process.env['IMAGEKIT_PRIVATE_API_KEY'] ?? undefined]
+   * @param {string | undefined} [opts.privateKey=process.env['IMAGEKIT_PRIVATE_API_KEY'] ?? undefined]
    * @param {string | null | undefined} [opts.password=process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'] ?? do_not_set]
    * @param {string | null | undefined} [opts.webhookSecret=process.env['IMAGEKIT_WEBHOOK_SECRET'] ?? null]
    * @param {string} [opts.baseURL=process.env['IMAGE_KIT_BASE_URL'] ?? https://api.imagekit.io] - Override the default base URL for the API.
@@ -215,19 +214,19 @@ export class ImageKit {
    */
   constructor({
     baseURL = readEnv('IMAGE_KIT_BASE_URL'),
-    privateAPIKey = readEnv('IMAGEKIT_PRIVATE_API_KEY'),
+    privateKey = readEnv('IMAGEKIT_PRIVATE_API_KEY'),
     password = readEnv('OPTIONAL_IMAGEKIT_IGNORES_THIS') ?? 'do_not_set',
     webhookSecret = readEnv('IMAGEKIT_WEBHOOK_SECRET') ?? null,
     ...opts
   }: ClientOptions = {}) {
-    if (privateAPIKey === undefined) {
+    if (privateKey === undefined) {
       throw new Errors.ImageKitError(
-        "The IMAGEKIT_PRIVATE_API_KEY environment variable is missing or empty; either provide it, or instantiate the ImageKit client with an privateAPIKey option, like new ImageKit({ privateAPIKey: 'My Private API Key' }).",
+        "The IMAGEKIT_PRIVATE_API_KEY environment variable is missing or empty; either provide it, or instantiate the ImageKit client with an privateKey option, like new ImageKit({ privateKey: 'My Private Key' }).",
       );
     }
 
     const options: ClientOptions = {
-      privateAPIKey,
+      privateKey,
       password,
       webhookSecret,
       ...opts,
@@ -251,7 +250,7 @@ export class ImageKit {
 
     this._options = options;
 
-    this.privateAPIKey = privateAPIKey;
+    this.privateKey = privateKey;
     this.password = password;
     this.webhookSecret = webhookSecret;
   }
@@ -269,7 +268,7 @@ export class ImageKit {
       logLevel: this.logLevel,
       fetch: this.fetch,
       fetchOptions: this.fetchOptions,
-      privateAPIKey: this.privateAPIKey,
+      privateKey: this.privateKey,
       password: this.password,
       webhookSecret: this.webhookSecret,
       ...options,
@@ -289,28 +288,28 @@ export class ImageKit {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.privateAPIKey && this.password && values.get('authorization')) {
+    if (this.privateKey && this.password && values.get('authorization')) {
       return;
     }
     if (nulls.has('authorization')) {
       return;
     }
 
     throw new Error(
-      'Could not resolve authentication method. Expected the privateAPIKey or password to be set. Or for the "Authorization" headers to be explicitly omitted',
+      'Could not resolve authentication method. Expected the privateKey or password to be set. Or for the "Authorization" headers to be explicitly omitted',
     );
   }
 
   protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    if (!this.privateAPIKey) {
+    if (!this.privateKey) {
       return undefined;
     }
 
     if (!this.password) {
       return undefined;
     }
 
-    const credentials = `${this.privateAPIKey}:${this.password}`;
+    const credentials = `${this.privateKey}:${this.password}`;
     const Authorization = `Basic ${toBase64(credentials)}`;
     return buildHeaders([{ Authorization }]);
   }

tests/api-resources/accounts/origins.test.ts

@@ -3,7 +3,7 @@
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: 'My Private API Key',
+  privateKey: 'My Private Key',
   password: 'My Password',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });

tests/api-resources/accounts/url-endpoints.test.ts

@@ -3,7 +3,7 @@
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: 'My Private API Key',
+  privateKey: 'My Private Key',
   password: 'My Password',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });

tests/api-resources/accounts/usage.test.ts

@@ -3,7 +3,7 @@
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: 'My Private API Key',
+  privateKey: 'My Private Key',
   password: 'My Password',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });

tests/api-resources/assets.test.ts

@@ -3,7 +3,7 @@
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: 'My Private API Key',
+  privateKey: 'My Private Key',
   password: 'My Password',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });

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

@@ -3,7 +3,7 @@
 import ImageKit, { toFile } from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: 'My Private API Key',
+  privateKey: 'My Private Key',
   password: 'My Password',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });

tests/api-resources/cache/invalidation.test.ts

@@ -3,7 +3,7 @@
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: 'My Private API Key',
+  privateKey: 'My Private Key',
   password: 'My Password',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });

tests/api-resources/custom-metadata-fields.test.ts

@@ -3,7 +3,7 @@
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateAPIKey: 'My Private API Key',
+  privateKey: 'My Private Key',
   password: 'My Password',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });