@aurigma/axios-asset-processor-api-client/dist/cjs/asset-processor-api-client.d.ts

Axios API Client for Asset Processor API service of Customer's Canvas web-to-print system.

import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
export declare class ApiClientConfiguration {
    apiUrl: string;
    apiKey: string;
    private authorizationToken;
    getAuthorizationToken(): Promise<string>;
    setAuthorizationToken(token: string): void;
}
export declare class ApiClientBase {
    private configuration;
    constructor(configuration: ApiClientConfiguration);
    protected transformOptions(options: AxiosRequestConfig): Promise<AxiosRequestConfig>;
    protected getBaseUrl(defultUrl: string): string;
    protected transformResult(url: string, res: AxiosResponse, cb: (res: AxiosResponse) => Promise<any>): Promise<any>;
}
export interface IBuildInfoApiClient {
    /**
     * Get assembly build info.
     * @return Success
     */
    headInfo(): Promise<void>;
    /**
     * Get assembly build info.
     * @return Success
     */
    getInfo(): Promise<BuildInfoModel>;
}
export declare class BuildInfoApiClient extends ApiClientBase implements IBuildInfoApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Get assembly build info.
     * @return Success
     */
    headInfo(cancelToken?: CancelToken | undefined): Promise<void>;
    protected processHeadInfo(response: AxiosResponse): Promise<void>;
    /**
     * Get assembly build info.
     * @return Success
     */
    getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
    protected processGetInfo(response: AxiosResponse): Promise<BuildInfoModel>;
}
export interface IColorProfileProcessorApiClient {
    /**
     * Updates color profile file and metadata in storage.
     * @param id Color profile entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined): Promise<ColorProfileDto>;
    /**
     * Imports color profile and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @return Created
     */
    importColorProfile(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined): Promise<ColorProfileDto>;
}
export declare class ColorProfileProcessorApiClient extends ApiClientBase implements IColorProfileProcessorApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Updates color profile file and metadata in storage.
     * @param id Color profile entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<ColorProfileDto>;
    protected processUpdate(response: AxiosResponse): Promise<ColorProfileDto>;
    /**
     * Imports color profile and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @return Created
     */
    importColorProfile(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined, cancelToken?: CancelToken | undefined): Promise<ColorProfileDto>;
    protected processImportColorProfile(response: AxiosResponse): Promise<ColorProfileDto>;
}
export interface IDataSchemaProcessorApiClient {
    /**
     * Gets all links associated with this data schema.
     * @param id Data schema entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    getLinks(id: string, tenantId?: number | undefined): Promise<DataSchemaLinksInfo>;
    /**
     * Updates data schema file and metadata in storage.
     * @param id Data schema entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined): Promise<DataSchemaDto>;
    /**
     * Imports data schema and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @return Created
     */
    importDataSchema(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined): Promise<DataSchemaDto>;
}
export declare class DataSchemaProcessorApiClient extends ApiClientBase implements IDataSchemaProcessorApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Gets all links associated with this data schema.
     * @param id Data schema entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    getLinks(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DataSchemaLinksInfo>;
    protected processGetLinks(response: AxiosResponse): Promise<DataSchemaLinksInfo>;
    /**
     * Updates data schema file and metadata in storage.
     * @param id Data schema entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<DataSchemaDto>;
    protected processUpdate(response: AxiosResponse): Promise<DataSchemaDto>;
    /**
     * Imports data schema and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @return Created
     */
    importDataSchema(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined, cancelToken?: CancelToken | undefined): Promise<DataSchemaDto>;
    protected processImportDataSchema(response: AxiosResponse): Promise<DataSchemaDto>;
}
export interface IDataSetProcessorApiClient {
    /**
     * Checks if data set taken from storage has any problems.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    check(id: string, tenantId?: number | undefined): Promise<DataSetProblemDto>;
    /**
     * Exports data set.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    exportDataSet(id: string, tenantId?: number | undefined): Promise<FileResponse>;
    /**
     * Embeds linked data schema to the data set.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedDataSchema(id: string, tenantId?: number | undefined): Promise<DataSetDto>;
    /**
     * Extracts data schema from data set and saves it to the specified folder.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract data schema operation parameters.
     * @return Success
     */
    extractDataSchema(id: string, tenantId?: number | undefined, body?: DataSetExtractDataSchemaModel | undefined): Promise<void>;
    /**
     * Links data schema to the data set.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link schema operation parameters.
     * @return Success
     */
    linkDataSchema(id: string, tenantId?: number | undefined, body?: DataSetLinkDataSchemaModel | undefined): Promise<DataSetDto>;
    /**
     * Updates data set file and metadata in storage.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined): Promise<DataSetDto>;
    /**
     * Imports data set and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @return Created
     */
    importDataSet(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined): Promise<DataSetDto>;
}
export declare class DataSetProcessorApiClient extends ApiClientBase implements IDataSetProcessorApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Checks if data set taken from storage has any problems.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    check(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DataSetProblemDto>;
    protected processCheck(response: AxiosResponse): Promise<DataSetProblemDto>;
    /**
     * Exports data set.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    exportDataSet(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
    protected processExportDataSet(response: AxiosResponse): Promise<FileResponse>;
    /**
     * Embeds linked data schema to the data set.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedDataSchema(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DataSetDto>;
    protected processEmbedDataSchema(response: AxiosResponse): Promise<DataSetDto>;
    /**
     * Extracts data schema from data set and saves it to the specified folder.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract data schema operation parameters.
     * @return Success
     */
    extractDataSchema(id: string, tenantId?: number | undefined, body?: DataSetExtractDataSchemaModel | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
    protected processExtractDataSchema(response: AxiosResponse): Promise<void>;
    /**
     * Links data schema to the data set.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link schema operation parameters.
     * @return Success
     */
    linkDataSchema(id: string, tenantId?: number | undefined, body?: DataSetLinkDataSchemaModel | undefined, cancelToken?: CancelToken | undefined): Promise<DataSetDto>;
    protected processLinkDataSchema(response: AxiosResponse): Promise<DataSetDto>;
    /**
     * Updates data set file and metadata in storage.
     * @param id Data set entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<DataSetDto>;
    protected processUpdate(response: AxiosResponse): Promise<DataSetDto>;
    /**
     * Imports data set and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @return Created
     */
    importDataSet(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined, cancelToken?: CancelToken | undefined): Promise<DataSetDto>;
    protected processImportDataSet(response: AxiosResponse): Promise<DataSetDto>;
}
export interface IDesignProcessorApiClient {
    /**
     * Calculates the design count per sheet of the specified size.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Model to calculate the design count per sheet of the specified size.
     * @return Success
     */
    calculateCountPerSheet(id: string, tenantId?: number | undefined, body?: DesignCountPerSheetCalculationModel | undefined): Promise<DesignCountPerSheetCalculationResultDto>;
    /**
     * Checks if design taken from storage has any problems.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    check(id: string, tenantId?: number | undefined): Promise<DesignProblemDto>;
    /**
     * Returns information about inserted images from DepositPhotos.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    getDepositPhotos(id: string, tenantId?: number | undefined): Promise<ImageDepositPhoto[]>;
    /**
     * Embeds all linked data to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedAllLinkedData(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Exports design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    exportDesign(id: string, tenantId?: number | undefined): Promise<FileResponse>;
    /**
     * Embeds linked images to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedImages(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Embeds linked palettes to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedPalettes(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Extracts palettes from design file and saves it to the specified folder.
    Due to possibility of having linked and embedded palettes for same design, all linked palettes will be embedded before extraction.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract palettes operation parameters.
     * @return Success
     */
    extractPalettes(id: string, tenantId?: number | undefined, body?: DesignExtractPalettesModel | undefined): Promise<void>;
    /**
     * Links palettes to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link palettes operation parameters.
     * @return Success
     */
    linkPalettes(id: string, tenantId?: number | undefined, body?: DesignLinkPalettesModel | undefined): Promise<DesignDto>;
    /**
     * Removes palettes from the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    removePalettes(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Creates preview image for design taken from storage.
     * @param id Source design entity identifier.
     * @param namespace Preview namespace.
     * @param name Preview name.
     * @param width Preview image width.
     * @param height Preview image height.
     * @param surfaceIndex (optional) Design surface index.
    Indicates which design surface should be used as a source for preview.
     * @param stub (optional) Design Preview stub contnent switcher.
    Indicates whether to show stub content in preview.
     * @param format (optional) Design preview image format.
     * @param force (optional) If set to 'true', new preview prepared, even if preview already existed.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    preparePreview(id: string, namespace: string, name: string, width: number, height: number, surfaceIndex?: number | null | undefined, stub?: boolean | null | undefined, format?: DesignPreviewFormat | null | undefined, force?: boolean | undefined, tenantId?: number | undefined): Promise<FileResponse>;
    /**
     * Creates preview image for design taken from storage.
     * @param id Source design entity identifier.
     * @param namespace Preview namespace.
     * @param name Preview name.
     * @param width Preview image width.
     * @param height Preview image height.
     * @param surfaceIndex (optional) Design surface index.
    Indicates which design surface should be used as a source for preview.
     * @param stub (optional) Design Preview stub contnent switcher.
    Indicates whether to show stub content in preview.
     * @param format (optional) Design preview image format.
     * @param force (optional) If set to 'true', new preview prepared, even if preview already existed.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    preparePreviewUrl(id: string, namespace: string, name: string, width: number, height: number, surfaceIndex?: number | null | undefined, stub?: boolean | null | undefined, format?: DesignPreviewFormat | null | undefined, force?: boolean | undefined, tenantId?: number | undefined): Promise<string>;
    /**
     * Re-imports design from source file and updates design file and metadata in storage.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param sourceFile (optional)
     * @param markerShortcutsFile (optional)
     * @return Success
     */
    reimportDesign(id: string, tenantId?: number | undefined, sourceFile?: FileParameter | undefined, markerShortcutsFile?: FileParameter | null | undefined): Promise<DesignDto>;
    /**
     * Embeds linked data schema to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedDataSchema(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Extracts data schema from design file and saves it to the specified folder.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract data schema operation parameters.
     * @return Success
     */
    extractDataSchema(id: string, tenantId?: number | undefined, body?: DesignExtractDataSchemaModel | undefined): Promise<void>;
    /**
     * Links data schema to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link schema operation parameters.
     * @return Success
     */
    linkDataSchema(id: string, tenantId?: number | undefined, body?: DesignLinkDataSchemaModel | undefined): Promise<DesignDto>;
    /**
     * Removes data schema from the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    removeDataSchema(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Embeds linked toggle set to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedToggleSet(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Extracts toggle set from design file and saves it to the specified folder.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract toggle set operation parameters.
     * @return Success
     */
    extractToggleSet(id: string, tenantId?: number | undefined, body?: DesignExtractToggleSetModel | undefined): Promise<void>;
    /**
     * Links toggle set to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link toggle set operation parameters.
     * @return Success
     */
    linkToggleSet(id: string, tenantId?: number | undefined, body?: DesignLinkToggleSetModel | undefined): Promise<DesignDto>;
    /**
     * Removes toggle set from the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    removeToggleSet(id: string, tenantId?: number | undefined): Promise<DesignDto>;
    /**
     * Updates design file and metadata in storage.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param designParams_name (optional)
     * @param designParams_path (optional)
     * @param designParams_customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, designParams_name?: string | null | undefined, designParams_path?: string | null | undefined, designParams_customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined): Promise<DesignDto>;
    /**
     * Creates design using basic settings and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Operation parameters.
     * @return Created
     */
    createBlankDesign(tenantId?: number | undefined, body?: CreateBlankDesignModel | undefined): Promise<DesignDto>;
    /**
     * Creates design compatible to specified mockup and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Operation parameters.
     * @return Created
     */
    createDesignFromMockup(tenantId?: number | undefined, body?: CreateDesignFromMockupModel | undefined): Promise<DesignDto>;
    /**
     * Imports design from source file and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param designParams_name (optional)
     * @param designParams_path (optional)
     * @param designParams_customFields (optional)
     * @param previewSettings_makePreview (optional)
     * @param previewSettings_namespace (optional)
     * @param previewSettings_name (optional)
     * @param previewSettings_width (optional)
     * @param previewSettings_height (optional)
     * @param previewSettings_stub (optional)
     * @param previewSettings_format (optional)
     * @param sourceFile (optional)
     * @param markerShortcutsFile (optional)
     * @return Created
     */
    importDesign(tenantId?: number | undefined, designParams_name?: string | null | undefined, designParams_path?: string | null | undefined, designParams_customFields?: {
        [key: string]: any;
    } | null | undefined, previewSettings_makePreview?: boolean | null | undefined, previewSettings_namespace?: string | null | undefined, previewSettings_name?: string | null | undefined, previewSettings_width?: number | null | undefined, previewSettings_height?: number | null | undefined, previewSettings_stub?: boolean | null | undefined, previewSettings_format?: DesignPreviewFormat | null | undefined, sourceFile?: FileParameter | undefined, markerShortcutsFile?: FileParameter | null | undefined): Promise<DesignDto>;
    /**
     * Validates the design import settings.
     * @param tenantId (optional) Tenant ID.
     * @param markerShortcutsFile (optional)
     * @return Success
     */
    validateDesignImportSettings(tenantId?: number | undefined, markerShortcutsFile?: FileParameter | null | undefined): Promise<ValidationResultDto>;
}
export declare class DesignProcessorApiClient extends ApiClientBase implements IDesignProcessorApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Calculates the design count per sheet of the specified size.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Model to calculate the design count per sheet of the specified size.
     * @return Success
     */
    calculateCountPerSheet(id: string, tenantId?: number | undefined, body?: DesignCountPerSheetCalculationModel | undefined, cancelToken?: CancelToken | undefined): Promise<DesignCountPerSheetCalculationResultDto>;
    protected processCalculateCountPerSheet(response: AxiosResponse): Promise<DesignCountPerSheetCalculationResultDto>;
    /**
     * Checks if design taken from storage has any problems.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    check(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignProblemDto>;
    protected processCheck(response: AxiosResponse): Promise<DesignProblemDto>;
    /**
     * Returns information about inserted images from DepositPhotos.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    getDepositPhotos(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<ImageDepositPhoto[]>;
    protected processGetDepositPhotos(response: AxiosResponse): Promise<ImageDepositPhoto[]>;
    /**
     * Embeds all linked data to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedAllLinkedData(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processEmbedAllLinkedData(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Exports design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    exportDesign(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
    protected processExportDesign(response: AxiosResponse): Promise<FileResponse>;
    /**
     * Embeds linked images to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedImages(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processEmbedImages(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Embeds linked palettes to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedPalettes(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processEmbedPalettes(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Extracts palettes from design file and saves it to the specified folder.
    Due to possibility of having linked and embedded palettes for same design, all linked palettes will be embedded before extraction.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract palettes operation parameters.
     * @return Success
     */
    extractPalettes(id: string, tenantId?: number | undefined, body?: DesignExtractPalettesModel | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
    protected processExtractPalettes(response: AxiosResponse): Promise<void>;
    /**
     * Links palettes to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link palettes operation parameters.
     * @return Success
     */
    linkPalettes(id: string, tenantId?: number | undefined, body?: DesignLinkPalettesModel | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processLinkPalettes(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Removes palettes from the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    removePalettes(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processRemovePalettes(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Creates preview image for design taken from storage.
     * @param id Source design entity identifier.
     * @param namespace Preview namespace.
     * @param name Preview name.
     * @param width Preview image width.
     * @param height Preview image height.
     * @param surfaceIndex (optional) Design surface index.
    Indicates which design surface should be used as a source for preview.
     * @param stub (optional) Design Preview stub contnent switcher.
    Indicates whether to show stub content in preview.
     * @param format (optional) Design preview image format.
     * @param force (optional) If set to 'true', new preview prepared, even if preview already existed.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    preparePreview(id: string, namespace: string, name: string, width: number, height: number, surfaceIndex?: number | null | undefined, stub?: boolean | null | undefined, format?: DesignPreviewFormat | null | undefined, force?: boolean | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
    protected processPreparePreview(response: AxiosResponse): Promise<FileResponse>;
    /**
     * Creates preview image for design taken from storage.
     * @param id Source design entity identifier.
     * @param namespace Preview namespace.
     * @param name Preview name.
     * @param width Preview image width.
     * @param height Preview image height.
     * @param surfaceIndex (optional) Design surface index.
    Indicates which design surface should be used as a source for preview.
     * @param stub (optional) Design Preview stub contnent switcher.
    Indicates whether to show stub content in preview.
     * @param format (optional) Design preview image format.
     * @param force (optional) If set to 'true', new preview prepared, even if preview already existed.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    preparePreviewUrl(id: string, namespace: string, name: string, width: number, height: number, surfaceIndex?: number | null | undefined, stub?: boolean | null | undefined, format?: DesignPreviewFormat | null | undefined, force?: boolean | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
    protected processPreparePreviewUrl(response: AxiosResponse): Promise<string>;
    /**
     * Re-imports design from source file and updates design file and metadata in storage.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param sourceFile (optional)
     * @param markerShortcutsFile (optional)
     * @return Success
     */
    reimportDesign(id: string, tenantId?: number | undefined, sourceFile?: FileParameter | undefined, markerShortcutsFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processReimportDesign(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Embeds linked data schema to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedDataSchema(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processEmbedDataSchema(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Extracts data schema from design file and saves it to the specified folder.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract data schema operation parameters.
     * @return Success
     */
    extractDataSchema(id: string, tenantId?: number | undefined, body?: DesignExtractDataSchemaModel | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
    protected processExtractDataSchema(response: AxiosResponse): Promise<void>;
    /**
     * Links data schema to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link schema operation parameters.
     * @return Success
     */
    linkDataSchema(id: string, tenantId?: number | undefined, body?: DesignLinkDataSchemaModel | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processLinkDataSchema(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Removes data schema from the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    removeDataSchema(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processRemoveDataSchema(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Embeds linked toggle set to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    embedToggleSet(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processEmbedToggleSet(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Extracts toggle set from design file and saves it to the specified folder.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Extract toggle set operation parameters.
     * @return Success
     */
    extractToggleSet(id: string, tenantId?: number | undefined, body?: DesignExtractToggleSetModel | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
    protected processExtractToggleSet(response: AxiosResponse): Promise<void>;
    /**
     * Links toggle set to the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Link toggle set operation parameters.
     * @return Success
     */
    linkToggleSet(id: string, tenantId?: number | undefined, body?: DesignLinkToggleSetModel | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processLinkToggleSet(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Removes toggle set from the design file.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    removeToggleSet(id: string, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processRemoveToggleSet(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Updates design file and metadata in storage.
     * @param id Design entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param designParams_name (optional)
     * @param designParams_path (optional)
     * @param designParams_customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, designParams_name?: string | null | undefined, designParams_path?: string | null | undefined, designParams_customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processUpdate(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Creates design using basic settings and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Operation parameters.
     * @return Created
     */
    createBlankDesign(tenantId?: number | undefined, body?: CreateBlankDesignModel | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processCreateBlankDesign(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Creates design compatible to specified mockup and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Operation parameters.
     * @return Created
     */
    createDesignFromMockup(tenantId?: number | undefined, body?: CreateDesignFromMockupModel | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processCreateDesignFromMockup(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Imports design from source file and saves it to storage.
     * @param tenantId (optional) Tenant ID.
     * @param designParams_name (optional)
     * @param designParams_path (optional)
     * @param designParams_customFields (optional)
     * @param previewSettings_makePreview (optional)
     * @param previewSettings_namespace (optional)
     * @param previewSettings_name (optional)
     * @param previewSettings_width (optional)
     * @param previewSettings_height (optional)
     * @param previewSettings_stub (optional)
     * @param previewSettings_format (optional)
     * @param sourceFile (optional)
     * @param markerShortcutsFile (optional)
     * @return Created
     */
    importDesign(tenantId?: number | undefined, designParams_name?: string | null | undefined, designParams_path?: string | null | undefined, designParams_customFields?: {
        [key: string]: any;
    } | null | undefined, previewSettings_makePreview?: boolean | null | undefined, previewSettings_namespace?: string | null | undefined, previewSettings_name?: string | null | undefined, previewSettings_width?: number | null | undefined, previewSettings_height?: number | null | undefined, previewSettings_stub?: boolean | null | undefined, previewSettings_format?: DesignPreviewFormat | null | undefined, sourceFile?: FileParameter | undefined, markerShortcutsFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<DesignDto>;
    protected processImportDesign(response: AxiosResponse): Promise<DesignDto>;
    /**
     * Validates the design import settings.
     * @param tenantId (optional) Tenant ID.
     * @param markerShortcutsFile (optional)
     * @return Success
     */
    validateDesignImportSettings(tenantId?: number | undefined, markerShortcutsFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<ValidationResultDto>;
    protected processValidateDesignImportSettings(response: AxiosResponse): Promise<ValidationResultDto>;
}
export interface IDocumentProcessorApiClient {
    /**
     * Updates the document file and metadata in the storage.
     * @param id Document entity ID.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @param type (optional)
     * @param format (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined, type?: ImportDocumentType | null | undefined, format?: ImportDocumentFormatType | null | undefined): Promise<DocumentDto>;
    /**
     * Creates a new blank toggle set and saves it to the storage.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Operation paramsHolder:.
     * @return Created
     */
    createBlankToggleSet(tenantId?: number | undefined, body?: CreateBlankToggleSetModel | undefined): Promise<DocumentDto>;
    /**
     * Imports a document from the source file and saves it to the storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @param type (optional)
     * @param format (optional)
     * @return Created
     */
    importDocument(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined, type?: ImportDocumentType | null | undefined, format?: ImportDocumentFormatType | null | undefined): Promise<DocumentDto>;
}
export declare class DocumentProcessorApiClient extends ApiClientBase implements IDocumentProcessorApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Updates the document file and metadata in the storage.
     * @param id Document entity ID.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @param type (optional)
     * @param format (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, file?: FileParameter | null | undefined, type?: ImportDocumentType | null | undefined, format?: ImportDocumentFormatType | null | undefined, cancelToken?: CancelToken | undefined): Promise<DocumentDto>;
    protected processUpdate(response: AxiosResponse): Promise<DocumentDto>;
    /**
     * Creates a new blank toggle set and saves it to the storage.
     * @param tenantId (optional) Tenant ID.
     * @param body (optional) Operation paramsHolder:.
     * @return Created
     */
    createBlankToggleSet(tenantId?: number | undefined, body?: CreateBlankToggleSetModel | undefined, cancelToken?: CancelToken | undefined): Promise<DocumentDto>;
    protected processCreateBlankToggleSet(response: AxiosResponse): Promise<DocumentDto>;
    /**
     * Imports a document from the source file and saves it to the storage.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param sourceFile (optional)
     * @param type (optional)
     * @param format (optional)
     * @return Created
     */
    importDocument(tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined, sourceFile?: FileParameter | undefined, type?: ImportDocumentType | null | undefined, format?: ImportDocumentFormatType | null | undefined, cancelToken?: CancelToken | undefined): Promise<DocumentDto>;
    protected processImportDocument(response: AxiosResponse): Promise<DocumentDto>;
}
export interface IFontProcessorApiClient {
    /**
     * Creates preview image for font taken from storage.
     * @param id Source font entity identifier.
     * @param namespace Preview namespace.
     * @param name Preview name.
     * @param width Preview image width.
     * @param height Preview image height.
     * @param text (optional) Text, that will be visualized with selected font in preview image, e.g. 'Abg'
     * @param format (optional) Preview image format
     * @param maxWidth (optional) Max width of preview image
    If parameter is set then normal widht and height and font size are ignored
     * @param fontSize (optional) Max width of preview image
    If parameter is set then normal widht and height and font size are ignored
     * @param horizontalAlignment (optional) Horizontal alignment of text visualization in preview image
     * @param verticalAlignment (optional) Vertical alignment of text visualization in preview image
     * @param background (optional) Background color for preview image
     * @param textColor (optional) Text color for preview image
     * @param force (optional) If set to 'true', new preview prepared, even if preview already existed.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    preparePreview(id: string, namespace: string, name: string, width: number, height: number, text?: string | null | undefined, format?: FontPreviewFormat | null | undefined, maxWidth?: number | null | undefined, fontSize?: number | null | undefined, horizontalAlignment?: FontPreviewHorizontalAlignment | null | undefined, verticalAlignment?: FontPreviewVerticalAlignment | null | undefined, background?: string | null | undefined, textColor?: string | null | undefined, force?: boolean | undefined, tenantId?: number | undefined): Promise<FileResponse>;
    /**
     * Creates preview image for font taken from storage.
     * @param id Source font entity identifier.
     * @param namespace Preview namespace.
     * @param name Preview name.
     * @param width Preview image width.
     * @param height Preview image height.
     * @param text (optional) Text, that will be visualized with selected font in preview image, e.g. 'Abg'
     * @param format (optional) Preview image format
     * @param maxWidth (optional) Max width of preview image
    If parameter is set then normal widht and height and font size are ignored
     * @param fontSize (optional) Max width of preview image
    If parameter is set then normal widht and height and font size are ignored
     * @param horizontalAlignment (optional) Horizontal alignment of text visualization in preview image
     * @param verticalAlignment (optional) Vertical alignment of text visualization in preview image
     * @param background (optional) Background color for preview image
     * @param textColor (optional) Text color for preview image
     * @param force (optional) If set to 'true', new preview prepared, even if preview already existed.
     * @param tenantId (optional) Tenant ID.
     * @return Success
     */
    preparePreviewUrl(id: string, namespace: string, name: string, width: number, height: number, text?: string | null | undefined, format?: FontPreviewFormat | null | undefined, maxWidth?: number | null | undefined, fontSize?: number | null | undefined, horizontalAlignment?: FontPreviewHorizontalAlignment | null | undefined, verticalAlignment?: FontPreviewVerticalAlignment | null | undefined, background?: string | null | undefined, textColor?: string | null | undefined, force?: boolean | undefined, tenantId?: number | undefined): Promise<string>;
    /**
     * Updates font file and metadata in storage.
     * @param id Font entity unique identifier.
     * @param tenantId (optional) Tenant ID.
     * @param name (optional)
     * @param path (optional)
     * @param customFields (optional)
     * @param file (optional)
     * @return Success
     */
    update(id: string, tenantId?: number | undefined, name?: string | null | undefined, path?: string | null | undefined, customFields?: {
        [key: string]: any;
    } | null | undefined,