umbraco-management-api-client/dist/apis/DocumentBlueprintApi.d.ts

TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)

/**
 * Umbraco Management API
 * This shows all APIs available in this version of Umbraco - including all the legacy apis that are available for backward compatibility
 *
 * The version of the OpenAPI document: Latest
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { CreateDocumentBlueprintFromDocumentRequestModel, CreateDocumentBlueprintRequestModel, CreateFolderRequestModel, DocumentBlueprintResponseModel, FolderResponseModel, GetItemDocumentBlueprint200ResponseInner, GetTreeDocumentBlueprintAncestors200ResponseInner, MoveDocumentBlueprintRequestModel, PagedDocumentBlueprintTreeItemResponseModel, UpdateDocumentBlueprintRequestModel, UpdateFolderResponseModel } from '../models/index';
export interface DeleteDocumentBlueprintByIdRequest {
    id: string;
}
export interface DeleteDocumentBlueprintFolderByIdRequest {
    id: string;
}
export interface GetDocumentBlueprintByIdRequest {
    id: string;
}
export interface GetDocumentBlueprintByIdScaffoldRequest {
    id: string;
}
export interface GetDocumentBlueprintFolderByIdRequest {
    id: string;
}
export interface GetItemDocumentBlueprintRequest {
    id?: Set<string>;
}
export interface GetTreeDocumentBlueprintAncestorsRequest {
    descendantId?: string;
}
export interface GetTreeDocumentBlueprintChildrenRequest {
    parentId?: string;
    skip?: number;
    take?: number;
    foldersOnly?: boolean;
}
export interface GetTreeDocumentBlueprintRootRequest {
    skip?: number;
    take?: number;
    foldersOnly?: boolean;
}
export interface PostDocumentBlueprintRequest {
    createDocumentBlueprintRequestModel?: CreateDocumentBlueprintRequestModel;
}
export interface PostDocumentBlueprintFolderRequest {
    createFolderRequestModel?: CreateFolderRequestModel;
}
export interface PostDocumentBlueprintFromDocumentRequest {
    createDocumentBlueprintFromDocumentRequestModel?: CreateDocumentBlueprintFromDocumentRequestModel;
}
export interface PutDocumentBlueprintByIdRequest {
    id: string;
    updateDocumentBlueprintRequestModel?: UpdateDocumentBlueprintRequestModel;
}
export interface PutDocumentBlueprintByIdMoveRequest {
    id: string;
    moveDocumentBlueprintRequestModel?: MoveDocumentBlueprintRequestModel;
}
export interface PutDocumentBlueprintFolderByIdRequest {
    id: string;
    updateFolderResponseModel?: UpdateFolderResponseModel;
}
/**
 *
 */
export declare class DocumentBlueprintApi extends runtime.BaseAPI {
    /**
     */
    deleteDocumentBlueprintByIdRaw(requestParameters: DeleteDocumentBlueprintByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteDocumentBlueprintById(requestParameters: DeleteDocumentBlueprintByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    deleteDocumentBlueprintFolderByIdRaw(requestParameters: DeleteDocumentBlueprintFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteDocumentBlueprintFolderById(requestParameters: DeleteDocumentBlueprintFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    getDocumentBlueprintByIdRaw(requestParameters: GetDocumentBlueprintByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentBlueprintResponseModel>>;
    /**
     */
    getDocumentBlueprintById(requestParameters: GetDocumentBlueprintByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentBlueprintResponseModel>;
    /**
     */
    getDocumentBlueprintByIdScaffoldRaw(requestParameters: GetDocumentBlueprintByIdScaffoldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentBlueprintResponseModel>>;
    /**
     */
    getDocumentBlueprintByIdScaffold(requestParameters: GetDocumentBlueprintByIdScaffoldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentBlueprintResponseModel>;
    /**
     */
    getDocumentBlueprintFolderByIdRaw(requestParameters: GetDocumentBlueprintFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponseModel>>;
    /**
     */
    getDocumentBlueprintFolderById(requestParameters: GetDocumentBlueprintFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponseModel>;
    /**
     */
    getItemDocumentBlueprintRaw(requestParameters: GetItemDocumentBlueprintRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemDocumentBlueprint200ResponseInner>>>;
    /**
     */
    getItemDocumentBlueprint(requestParameters?: GetItemDocumentBlueprintRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemDocumentBlueprint200ResponseInner>>;
    /**
     */
    getTreeDocumentBlueprintAncestorsRaw(requestParameters: GetTreeDocumentBlueprintAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeDocumentBlueprintAncestors200ResponseInner>>>;
    /**
     */
    getTreeDocumentBlueprintAncestors(requestParameters?: GetTreeDocumentBlueprintAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeDocumentBlueprintAncestors200ResponseInner>>;
    /**
     */
    getTreeDocumentBlueprintChildrenRaw(requestParameters: GetTreeDocumentBlueprintChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentBlueprintTreeItemResponseModel>>;
    /**
     */
    getTreeDocumentBlueprintChildren(requestParameters?: GetTreeDocumentBlueprintChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentBlueprintTreeItemResponseModel>;
    /**
     */
    getTreeDocumentBlueprintRootRaw(requestParameters: GetTreeDocumentBlueprintRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentBlueprintTreeItemResponseModel>>;
    /**
     */
    getTreeDocumentBlueprintRoot(requestParameters?: GetTreeDocumentBlueprintRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentBlueprintTreeItemResponseModel>;
    /**
     */
    postDocumentBlueprintRaw(requestParameters: PostDocumentBlueprintRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDocumentBlueprint(requestParameters?: PostDocumentBlueprintRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDocumentBlueprintFolderRaw(requestParameters: PostDocumentBlueprintFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDocumentBlueprintFolder(requestParameters?: PostDocumentBlueprintFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDocumentBlueprintFromDocumentRaw(requestParameters: PostDocumentBlueprintFromDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDocumentBlueprintFromDocument(requestParameters?: PostDocumentBlueprintFromDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDocumentBlueprintByIdRaw(requestParameters: PutDocumentBlueprintByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDocumentBlueprintById(requestParameters: PutDocumentBlueprintByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDocumentBlueprintByIdMoveRaw(requestParameters: PutDocumentBlueprintByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDocumentBlueprintByIdMove(requestParameters: PutDocumentBlueprintByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDocumentBlueprintFolderByIdRaw(requestParameters: PutDocumentBlueprintFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDocumentBlueprintFolderById(requestParameters: PutDocumentBlueprintFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}