@adobe/lightroom-apis/dist/src/Lightroom.d.ts

Adobe Firefly Services library for consuming Lightroom Service APIs.

/*************************************************************************
 * ADOBE CONFIDENTIAL
 * ___________________
 *
 * Copyright 2025 Adobe
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains
 * the property of Adobe and its suppliers, if any. The intellectual
 * and technical concepts contained herein are proprietary to Adobe
 * and its suppliers and are protected by all applicable intellectual
 * property laws, including trade secret and copyright laws.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe.

 **************************************************************************/
import type { ClientConfig, ClientCredentials, ApiOptions, ApiResponse } from "@adobe/firefly-services-sdk-core";
import { BaseServiceClient } from "@adobe/firefly-services-sdk-core/internal";
import type { ApplyAutoToneRequest } from "./models/ApplyAutoToneRequest";
import type { ApplyEditsRequest } from "./models/ApplyEditsRequest";
import type { ApplyPresetFromXmpContentRequest } from "./models/ApplyPresetFromXmpContentRequest";
import type { ApplyPresetRequest } from "./models/ApplyPresetRequest";
import type { AutoStraightenImageRequest } from "./models/AutoStraightenImageRequest";
import type { LrJobApiResponse } from "./models/LrJobApiResponse";
/**
 * LightroomClient
 * Lightroom API client to use the Lightroom API services
 */
export declare class LightroomClient extends BaseServiceClient {
    private _lightroomAsyncClient;
    /**
     * Constructor for LightroomClient
     * @param config configuration for creating client. Using ClientCredentials enables automatic token refresh, which cannot be disabled. Instead To manage authentication manually, use ClientConfig.
     */
    constructor(config: ClientConfig | ClientCredentials);
    /**
     * Auto Straighten API
     * Auto Straighten an image. Applies the Auto Upright transformation on an image
     * @param requestBody Request body for auto straighten api
     * @param options Additional options to send any additional data or cancel the request
     * @returns LrJobApiResponse Job status
     * @throws {ApiError}
     */
    autoStraightenImage(requestBody: AutoStraightenImageRequest, options?: ApiOptions): Promise<ApiResponse<LrJobApiResponse>>;
    /**
     * Auto Tone API
     * Automatically correct exposure, contrast, sharpness, saturation on an image
     * @param requestBody Request body for applyAutoTone api
     * @param options Additional options to send any additional data or cancel the request
     * @returns LrJobApiResponse Job status
     * @throws {ApiError}
     */
    applyAutoTone(requestBody: ApplyAutoToneRequest, options?: ApiOptions): Promise<ApiResponse<LrJobApiResponse>>;
    /**
     * Apply Lightroom Edits API
     * Apply one or more Lightroom edits ( exposure, contrast, sharpness, saturation ) to an image.
     * @param requestBody Request body for edit api
     * @param options Additional options to send any additional data or cancel the request
     * @returns LrJobApiResponse Job status
     * @throws {ApiError}
     */
    applyEdits(requestBody: ApplyEditsRequest, options?: ApiOptions): Promise<ApiResponse<LrJobApiResponse>>;
    /**
     * Apply Lightroom Presets API
     * Apply one or more XMP Lightroom presets to the given image, by using the given preset XMP file(s).
     * @param requestBody Request body for presets api
     * @param options Additional options to send any additional data or cancel the request
     * @returns LrJobApiResponse Job status
     * @throws {ApiError}
     */
    applyPreset(requestBody: ApplyPresetRequest, options?: ApiOptions): Promise<ApiResponse<LrJobApiResponse>>;
    /**
     * Add XMP to Image API
     * Apply XMP based Lightroom preset to an image. XMP content is passed inline to the api.
     * @param requestBody Request body for xmp api
     * @param options Additional options to send any additional data or cancel the request
     * @returns LrJobApiResponse Job status
     * @throws {ApiError}
     */
    applyPresetFromXmpContent(requestBody: ApplyPresetFromXmpContentRequest, options?: ApiOptions): Promise<ApiResponse<LrJobApiResponse>>;
}