@imagekit/nodejs 7.0.1

package/src/resources/accounts/url-endpoints.ts

@@ -0,0 +1,298 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class URLEndpoints extends APIResource {
+  /**
+   * **Note:** This API is currently in beta.
+   * Creates a new URL‑endpoint and returns the resulting object.
+   *
+   * @example
+   * ```ts
+   * const urlEndpointResponse =
+   *   await client.accounts.urlEndpoints.create({
+   *     description: 'My custom URL endpoint',
+   *   });
+   * ```
+   */
+  create(body: URLEndpointCreateParams, options?: RequestOptions): APIPromise<URLEndpointResponse> {
+    return this._client.post('/v1/accounts/url-endpoints', { body, ...options });
+  }
+
+  /**
+   * **Note:** This API is currently in beta.
+   * Updates the URL‑endpoint identified by `id` and returns the updated object.
+   *
+   * @example
+   * ```ts
+   * const urlEndpointResponse =
+   *   await client.accounts.urlEndpoints.update('id', {
+   *     description: 'My custom URL endpoint',
+   *   });
+   * ```
+   */
+  update(
+    id: string,
+    body: URLEndpointUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<URLEndpointResponse> {
+    return this._client.put(path`/v1/accounts/url-endpoints/${id}`, { body, ...options });
+  }
+
+  /**
+   * **Note:** This API is currently in beta.
+   * Returns an array of all URL‑endpoints configured including the default
+   * URL-endpoint generated by ImageKit during account creation.
+   *
+   * @example
+   * ```ts
+   * const urlEndpointResponses =
+   *   await client.accounts.urlEndpoints.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<URLEndpointListResponse> {
+    return this._client.get('/v1/accounts/url-endpoints', options);
+  }
+
+  /**
+   * **Note:** This API is currently in beta.
+   * Deletes the URL‑endpoint identified by `id`. You cannot delete the default
+   * URL‑endpoint created by ImageKit during account creation.
+   *
+   * @example
+   * ```ts
+   * await client.accounts.urlEndpoints.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/accounts/url-endpoints/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * **Note:** This API is currently in beta.
+   * Retrieves the URL‑endpoint identified by `id`.
+   *
+   * @example
+   * ```ts
+   * const urlEndpointResponse =
+   *   await client.accounts.urlEndpoints.get('id');
+   * ```
+   */
+  get(id: string, options?: RequestOptions): APIPromise<URLEndpointResponse> {
+    return this._client.get(path`/v1/accounts/url-endpoints/${id}`, options);
+  }
+}
+
+/**
+ * Schema for URL endpoint resource.
+ */
+export interface URLEndpointRequest {
+  /**
+   * Description of the URL endpoint.
+   */
+  description: string;
+
+  /**
+   * Ordered list of origin IDs to try when the file isn’t in the Media Library;
+   * ImageKit checks them in the sequence provided. Origin must be created before it
+   * can be used in a URL endpoint.
+   */
+  origins?: Array<string>;
+
+  /**
+   * Path segment appended to your base URL to form the endpoint (letters, digits,
+   * and hyphens only — or empty for the default endpoint).
+   */
+  urlPrefix?: string;
+
+  /**
+   * Configuration for third-party URL rewriting.
+   */
+  urlRewriter?: URLEndpointRequest.Cloudinary | URLEndpointRequest.Imgix | URLEndpointRequest.Akamai;
+}
+
+export namespace URLEndpointRequest {
+  export interface Cloudinary {
+    type: 'CLOUDINARY';
+
+    /**
+     * Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+     */
+    preserveAssetDeliveryTypes?: boolean;
+  }
+
+  export interface Imgix {
+    type: 'IMGIX';
+  }
+
+  export interface Akamai {
+    type: 'AKAMAI';
+  }
+}
+
+/**
+ * URL‑endpoint object as returned by the API.
+ */
+export interface URLEndpointResponse {
+  /**
+   * Unique identifier for the URL-endpoint. This is generated by ImageKit when you
+   * create a new URL-endpoint. For the default URL-endpoint, this is always
+   * `default`.
+   */
+  id: string;
+
+  /**
+   * Description of the URL endpoint.
+   */
+  description: string;
+
+  /**
+   * Ordered list of origin IDs to try when the file isn’t in the Media Library;
+   * ImageKit checks them in the sequence provided. Origin must be created before it
+   * can be used in a URL endpoint.
+   */
+  origins: Array<string>;
+
+  /**
+   * Path segment appended to your base URL to form the endpoint (letters, digits,
+   * and hyphens only — or empty for the default endpoint).
+   */
+  urlPrefix: string;
+
+  /**
+   * Configuration for third-party URL rewriting.
+   */
+  urlRewriter?: URLEndpointResponse.Cloudinary | URLEndpointResponse.Imgix | URLEndpointResponse.Akamai;
+}
+
+export namespace URLEndpointResponse {
+  export interface Cloudinary {
+    /**
+     * Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+     */
+    preserveAssetDeliveryTypes: boolean;
+
+    type: 'CLOUDINARY';
+  }
+
+  export interface Imgix {
+    type: 'IMGIX';
+  }
+
+  export interface Akamai {
+    type: 'AKAMAI';
+  }
+}
+
+export type URLEndpointListResponse = Array<URLEndpointResponse>;
+
+export interface URLEndpointCreateParams {
+  /**
+   * Description of the URL endpoint.
+   */
+  description: string;
+
+  /**
+   * Ordered list of origin IDs to try when the file isn’t in the Media Library;
+   * ImageKit checks them in the sequence provided. Origin must be created before it
+   * can be used in a URL endpoint.
+   */
+  origins?: Array<string>;
+
+  /**
+   * Path segment appended to your base URL to form the endpoint (letters, digits,
+   * and hyphens only — or empty for the default endpoint).
+   */
+  urlPrefix?: string;
+
+  /**
+   * Configuration for third-party URL rewriting.
+   */
+  urlRewriter?:
+    | URLEndpointCreateParams.Cloudinary
+    | URLEndpointCreateParams.Imgix
+    | URLEndpointCreateParams.Akamai;
+}
+
+export namespace URLEndpointCreateParams {
+  export interface Cloudinary {
+    type: 'CLOUDINARY';
+
+    /**
+     * Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+     */
+    preserveAssetDeliveryTypes?: boolean;
+  }
+
+  export interface Imgix {
+    type: 'IMGIX';
+  }
+
+  export interface Akamai {
+    type: 'AKAMAI';
+  }
+}
+
+export interface URLEndpointUpdateParams {
+  /**
+   * Description of the URL endpoint.
+   */
+  description: string;
+
+  /**
+   * Ordered list of origin IDs to try when the file isn’t in the Media Library;
+   * ImageKit checks them in the sequence provided. Origin must be created before it
+   * can be used in a URL endpoint.
+   */
+  origins?: Array<string>;
+
+  /**
+   * Path segment appended to your base URL to form the endpoint (letters, digits,
+   * and hyphens only — or empty for the default endpoint).
+   */
+  urlPrefix?: string;
+
+  /**
+   * Configuration for third-party URL rewriting.
+   */
+  urlRewriter?:
+    | URLEndpointUpdateParams.Cloudinary
+    | URLEndpointUpdateParams.Imgix
+    | URLEndpointUpdateParams.Akamai;
+}
+
+export namespace URLEndpointUpdateParams {
+  export interface Cloudinary {
+    type: 'CLOUDINARY';
+
+    /**
+     * Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+     */
+    preserveAssetDeliveryTypes?: boolean;
+  }
+
+  export interface Imgix {
+    type: 'IMGIX';
+  }
+
+  export interface Akamai {
+    type: 'AKAMAI';
+  }
+}
+
+export declare namespace URLEndpoints {
+  export {
+    type URLEndpointRequest as URLEndpointRequest,
+    type URLEndpointResponse as URLEndpointResponse,
+    type URLEndpointListResponse as URLEndpointListResponse,
+    type URLEndpointCreateParams as URLEndpointCreateParams,
+    type URLEndpointUpdateParams as URLEndpointUpdateParams,
+  };
+}

package/src/resources/accounts/usage.ts

@@ -0,0 +1,70 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Usage extends APIResource {
+  /**
+   * Get the account usage information between two dates. Note that the API response
+   * includes data from the start date while excluding data from the end date. In
+   * other words, the data covers the period starting from the specified start date
+   * up to, but not including, the end date.
+   *
+   * @example
+   * ```ts
+   * const usage = await client.accounts.usage.get({
+   *   endDate: '2019-12-27',
+   *   startDate: '2019-12-27',
+   * });
+   * ```
+   */
+  get(query: UsageGetParams, options?: RequestOptions): APIPromise<UsageGetResponse> {
+    return this._client.get('/v1/accounts/usage', { query, ...options });
+  }
+}
+
+export interface UsageGetResponse {
+  /**
+   * Amount of bandwidth used in bytes.
+   */
+  bandwidthBytes?: number;
+
+  /**
+   * Number of extension units used.
+   */
+  extensionUnitsCount?: number;
+
+  /**
+   * Storage used by media library in bytes.
+   */
+  mediaLibraryStorageBytes?: number;
+
+  /**
+   * Storage used by the original cache in bytes.
+   */
+  originalCacheStorageBytes?: number;
+
+  /**
+   * Number of video processing units used.
+   */
+  videoProcessingUnitsCount?: number;
+}
+
+export interface UsageGetParams {
+  /**
+   * Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`.
+   * The difference between `startDate` and `endDate` should be less than 90 days.
+   */
+  endDate: string;
+
+  /**
+   * Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`.
+   * The difference between `startDate` and `endDate` should be less than 90 days.
+   */
+  startDate: string;
+}
+
+export declare namespace Usage {
+  export { type UsageGetResponse as UsageGetResponse, type UsageGetParams as UsageGetParams };
+}

package/src/resources/accounts.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './accounts/index';

package/src/resources/assets.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as FilesAPI from './files/files';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Assets extends APIResource {
+  /**
+   * This API can list all the uploaded files and folders in your ImageKit.io media
+   * library. In addition, you can fine-tune your query by specifying various filters
+   * by generating a query string in a Lucene-like syntax and provide this generated
+   * string as the value of the `searchQuery`.
+   */
+  list(
+    query: AssetListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AssetListResponse> {
+    return this._client.get('/v1/files', { query, ...options });
+  }
+}
+
+export type AssetListResponse = Array<FilesAPI.File | FilesAPI.Folder>;
+
+export interface AssetListParams {
+  /**
+   * Filter results by file type.
+   *
+   * - `all` — include all file types
+   * - `image` — include only image files
+   * - `non-image` — include only non-image files (e.g., JS, CSS, video)
+   */
+  fileType?: 'all' | 'image' | 'non-image';
+
+  /**
+   * The maximum number of results to return in response.
+   */
+  limit?: number;
+
+  /**
+   * Folder path if you want to limit the search within a specific folder. For
+   * example, `/sales-banner/` will only search in folder sales-banner.
+   *
+   * Note : If your use case involves searching within a folder as well as its
+   * subfolders, you can use `path` parameter in `searchQuery` with appropriate
+   * operator. Checkout
+   * [Supported parameters](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#supported-parameters)
+   * for more information.
+   */
+  path?: string;
+
+  /**
+   * Query string in a Lucene-like query language e.g. `createdAt > "7d"`.
+   *
+   * Note : When the searchQuery parameter is present, the following query parameters
+   * will have no effect on the result:
+   *
+   * 1. `tags`
+   * 2. `type`
+   * 3. `name`
+   *
+   * [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries)
+   * from examples.
+   */
+  searchQuery?: string;
+
+  /**
+   * The number of results to skip before returning results.
+   */
+  skip?: number;
+
+  /**
+   * Sort the results by one of the supported fields in ascending or descending
+   * order.
+   */
+  sort?:
+    | 'ASC_NAME'
+    | 'DESC_NAME'
+    | 'ASC_CREATED'
+    | 'DESC_CREATED'
+    | 'ASC_UPDATED'
+    | 'DESC_UPDATED'
+    | 'ASC_HEIGHT'
+    | 'DESC_HEIGHT'
+    | 'ASC_WIDTH'
+    | 'DESC_WIDTH'
+    | 'ASC_SIZE'
+    | 'DESC_SIZE'
+    | 'ASC_RELEVANCE'
+    | 'DESC_RELEVANCE';
+
+  /**
+   * Filter results by asset type.
+   *
+   * - `file` — returns only files
+   * - `file-version` — returns specific file versions
+   * - `folder` — returns only folders
+   * - `all` — returns both files and folders (excludes `file-version`)
+   */
+  type?: 'file' | 'file-version' | 'folder' | 'all';
+}
+
+export declare namespace Assets {
+  export { type AssetListResponse as AssetListResponse, type AssetListParams as AssetListParams };
+}

package/src/resources/beta/beta.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as V2API from './v2/v2';
+import { V2 } from './v2/v2';
+
+export class Beta extends APIResource {
+  v2: V2API.V2 = new V2API.V2(this._client);
+}
+
+Beta.V2 = V2;
+
+export declare namespace Beta {
+  export { V2 as V2 };
+}

package/src/resources/beta/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Beta } from './beta';
+export { V2 } from './v2/index';