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

Agility CMS Tyescript SDK for Management API.

import { Options } from "../models/options";
import { ClientInstance } from "./clientInstance";
import { Container } from "../models/container";
import { Notification } from "../models/notification";
import { PagedResult } from "../models/pagedResult";
import { ContentViewType } from "../enums/contentViewType";
export declare class ContainerMethods {
    _options: Options;
    _clientInstance: ClientInstance;
    constructor(options: Options);
    getContainerByID(id: number, guid: string): Promise<Container>;
    getContainersByModel(modelId: number, guid: string): Promise<Container[]>;
    /**
     * Retrieves a container by its reference name.
     * Returns the container if found, or null if the container does not exist (404 error).
     * @param referenceName - The reference name of the container.
     * @param guid - The GUID for authentication.
     * @returns The container or null if not found.
     */
    getContainerByReferenceName(referenceName: string, guid: string): Promise<Container | null>;
    getContainerSecurity(id: number, guid: string): Promise<Container>;
    getContainerList(guid: string): Promise<Container[]>;
    getContainerListPaged(guid: string, pageSize?: number, recordOffset?: number, contentType?: ContentViewType, includeModules?: boolean, updatedSince?: Date): Promise<PagedResult<Container>>;
    getNotificationList(id: number, guid: string): Promise<Notification[]>;
    saveContainer(container: Container, guid: string, forceReferenceName?: boolean): Promise<Container>;
    deleteContainer(id: number, guid: string): Promise<string>;
}