@agility/management-sdk/dist/apiMethods/instanceMethods.d.ts

Agility CMS Tyescript SDK for Management API.

import { Options } from "../models/options";
import { ClientInstance } from "./clientInstance";
import { Locales } from "../models/locales";
import { FetchApiStatus, FetchApiSyncMode } from "../models/fetchApiStatus";
export declare class InstanceMethods {
    _options: Options;
    _clientInstance: ClientInstance;
    constructor(options: Options);
    getLocales(guid: string): Promise<Locales[]>;
    /**
     * Gets the Fetch API sync status for an instance.
     * Use this to check if changes made via the Management API have propagated to the Fetch API CDNs.
     * This is particularly useful after large batch operations or batch workflows to verify
     * that content changes are available on the CDN before proceeding with dependent operations.
     *
     * @param guid - The website GUID
     * @param mode - Sync mode: 'fetch' (live/published content) or 'preview' (preview content). Defaults to 'fetch'.
     * @param waitForCompletion - If true, polls until sync is complete. Defaults to false.
     * @returns The sync status including whether a sync is in progress and version information
     */
    getFetchApiStatus(guid: string, mode?: FetchApiSyncMode, waitForCompletion?: boolean): Promise<FetchApiStatus>;
}