/** * Klaviyo API * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. * * Contact: developers@klaviyo.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosResponse } from "axios"; import { GetImageResponse } from '../model/getImageResponse'; import { GetImageResponseCollection } from '../model/getImageResponseCollection'; import { ImageCreateQuery } from '../model/imageCreateQuery'; import { ImagePartialUpdateQuery } from '../model/imagePartialUpdateQuery'; import { PatchImageResponse } from '../model/patchImageResponse'; import { PostImageResponse } from '../model/postImageResponse'; import { RequestFile, Session } from './apis'; export declare class ImagesApi { session: Session; protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; constructor(session: Session); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; /** * Get the image with the given image ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `images:read` * @summary Get Image * @param id The ID of the image * @param fieldsImage For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets */ getImage(id: string, options?: { fieldsImage?: Array<'format' | 'hidden' | 'image_url' | 'name' | 'size' | 'updated_at'>; }): Promise<{ response: AxiosResponse; body: GetImageResponse; }>; /** * Get all images in an account.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `images:read` * @summary Get Images * @param fieldsImage For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getImages(options?: { fieldsImage?: Array<'format' | 'hidden' | 'image_url' | 'name' | 'size' | 'updated_at'>; filter?: string; pageCursor?: string; pageSize?: number; sort?: 'format' | '-format' | 'id' | '-id' | 'name' | '-name' | 'size' | '-size' | 'updated_at' | '-updated_at'; }): Promise<{ response: AxiosResponse; body: GetImageResponseCollection; }>; /** * Update the image with the given image ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `images:write` * @summary Update Image * @param id The ID of the image* @param imagePartialUpdateQuery */ updateImage(id: string, imagePartialUpdateQuery: ImagePartialUpdateQuery): Promise<{ response: AxiosResponse; body: PatchImageResponse; }>; /** * Upload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.

*Rate limits*:
Burst: `3/s`
Steady: `100/m`
Daily: `100/d` **Scopes:** `images:write` * @summary Upload Image From File * @param file The image file to upload. Supported image formats: jpeg,png,gif. Maximum image size: 5MB. * @param name A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.* @param hidden If true, this image is not shown in the asset library. */ uploadImageFromFile(file: RequestFile, name?: string, hidden?: boolean): Promise<{ response: AxiosResponse; body: PostImageResponse; }>; /** * Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.

*Rate limits*:
Burst: `3/s`
Steady: `100/m`
Daily: `100/d` **Scopes:** `images:write` * @summary Upload Image From URL * @param imageCreateQuery */ uploadImageFromUrl(imageCreateQuery: ImageCreateQuery): Promise<{ response: AxiosResponse; body: PostImageResponse; }>; } export interface ImagesApi { /** * Alias of {@link ImagesApi.uploadImageFromFile} * * @deprecated Use {@link ImagesApi.uploadImageFromFile} instead */ createImageUpload: typeof ImagesApi.prototype.uploadImageFromFile; } export interface ImagesApi { /** * Alias of {@link ImagesApi.uploadImageFromUrl} * * @deprecated Use {@link ImagesApi.uploadImageFromUrl} instead */ createImage: typeof ImagesApi.prototype.uploadImageFromUrl; }