umbraco-management-api-client/dist/apis/DocumentTypeApi.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 { CopyDocumentTypeRequestModel, CreateDocumentTypeRequestModel, CreateFolderRequestModel, DocumentTypeCompositionRequestModel, DocumentTypeConfigurationResponseModel, DocumentTypeResponseModel, FolderResponseModel, GetDocumentTypeByIdCompositionReferences200ResponseInner, GetItemDocumentType200ResponseInner, GetTreeDocumentTypeAncestors200ResponseInner, ImportDocumentTypeRequestModel, MoveDocumentTypeRequestModel, PagedAllowedDocumentTypeModel, PagedDocumentTypeBlueprintItemResponseModel, PagedDocumentTypeTreeItemResponseModel, PagedModelDocumentTypeItemResponseModel, PostDocumentTypeAvailableCompositions200ResponseInner, UpdateDocumentTypeRequestModel, UpdateFolderResponseModel } from '../models/index';
export interface DeleteDocumentTypeByIdRequest {
    id: string;
}
export interface DeleteDocumentTypeFolderByIdRequest {
    id: string;
}
export interface GetDocumentTypeAllowedAtRootRequest {
    skip?: number;
    take?: number;
}
export interface GetDocumentTypeByIdRequest {
    id: string;
}
export interface GetDocumentTypeByIdAllowedChildrenRequest {
    id: string;
    parentContentKey?: string;
    skip?: number;
    take?: number;
}
export interface GetDocumentTypeByIdBlueprintRequest {
    id: string;
    skip?: number;
    take?: number;
}
export interface GetDocumentTypeByIdCompositionReferencesRequest {
    id: string;
}
export interface GetDocumentTypeByIdExportRequest {
    id: string;
}
export interface GetDocumentTypeFolderByIdRequest {
    id: string;
}
export interface GetItemDocumentTypeRequest {
    id?: Set<string>;
}
export interface GetItemDocumentTypeSearchRequest {
    query?: string;
    isElement?: boolean;
    skip?: number;
    take?: number;
}
export interface GetTreeDocumentTypeAncestorsRequest {
    descendantId?: string;
}
export interface GetTreeDocumentTypeChildrenRequest {
    parentId?: string;
    skip?: number;
    take?: number;
    foldersOnly?: boolean;
}
export interface GetTreeDocumentTypeRootRequest {
    skip?: number;
    take?: number;
    foldersOnly?: boolean;
}
export interface PostDocumentTypeRequest {
    createDocumentTypeRequestModel?: CreateDocumentTypeRequestModel;
}
export interface PostDocumentTypeAvailableCompositionsRequest {
    documentTypeCompositionRequestModel?: DocumentTypeCompositionRequestModel;
}
export interface PostDocumentTypeByIdCopyRequest {
    id: string;
    copyDocumentTypeRequestModel?: CopyDocumentTypeRequestModel;
}
export interface PostDocumentTypeFolderRequest {
    createFolderRequestModel?: CreateFolderRequestModel;
}
export interface PostDocumentTypeImportRequest {
    importDocumentTypeRequestModel?: ImportDocumentTypeRequestModel;
}
export interface PutDocumentTypeByIdRequest {
    id: string;
    updateDocumentTypeRequestModel?: UpdateDocumentTypeRequestModel;
}
export interface PutDocumentTypeByIdImportRequest {
    id: string;
    importDocumentTypeRequestModel?: ImportDocumentTypeRequestModel;
}
export interface PutDocumentTypeByIdMoveRequest {
    id: string;
    moveDocumentTypeRequestModel?: MoveDocumentTypeRequestModel;
}
export interface PutDocumentTypeFolderByIdRequest {
    id: string;
    updateFolderResponseModel?: UpdateFolderResponseModel;
}
/**
 *
 */
export declare class DocumentTypeApi extends runtime.BaseAPI {
    /**
     */
    deleteDocumentTypeByIdRaw(requestParameters: DeleteDocumentTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteDocumentTypeById(requestParameters: DeleteDocumentTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    deleteDocumentTypeFolderByIdRaw(requestParameters: DeleteDocumentTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteDocumentTypeFolderById(requestParameters: DeleteDocumentTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    getDocumentTypeAllowedAtRootRaw(requestParameters: GetDocumentTypeAllowedAtRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedAllowedDocumentTypeModel>>;
    /**
     */
    getDocumentTypeAllowedAtRoot(requestParameters?: GetDocumentTypeAllowedAtRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedAllowedDocumentTypeModel>;
    /**
     */
    getDocumentTypeByIdRaw(requestParameters: GetDocumentTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentTypeResponseModel>>;
    /**
     */
    getDocumentTypeById(requestParameters: GetDocumentTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentTypeResponseModel>;
    /**
     */
    getDocumentTypeByIdAllowedChildrenRaw(requestParameters: GetDocumentTypeByIdAllowedChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedAllowedDocumentTypeModel>>;
    /**
     */
    getDocumentTypeByIdAllowedChildren(requestParameters: GetDocumentTypeByIdAllowedChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedAllowedDocumentTypeModel>;
    /**
     */
    getDocumentTypeByIdBlueprintRaw(requestParameters: GetDocumentTypeByIdBlueprintRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentTypeBlueprintItemResponseModel>>;
    /**
     */
    getDocumentTypeByIdBlueprint(requestParameters: GetDocumentTypeByIdBlueprintRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentTypeBlueprintItemResponseModel>;
    /**
     */
    getDocumentTypeByIdCompositionReferencesRaw(requestParameters: GetDocumentTypeByIdCompositionReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetDocumentTypeByIdCompositionReferences200ResponseInner>>>;
    /**
     */
    getDocumentTypeByIdCompositionReferences(requestParameters: GetDocumentTypeByIdCompositionReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetDocumentTypeByIdCompositionReferences200ResponseInner>>;
    /**
     */
    getDocumentTypeByIdExportRaw(requestParameters: GetDocumentTypeByIdExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
    /**
     */
    getDocumentTypeByIdExport(requestParameters: GetDocumentTypeByIdExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
    /**
     */
    getDocumentTypeConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentTypeConfigurationResponseModel>>;
    /**
     */
    getDocumentTypeConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentTypeConfigurationResponseModel>;
    /**
     */
    getDocumentTypeFolderByIdRaw(requestParameters: GetDocumentTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponseModel>>;
    /**
     */
    getDocumentTypeFolderById(requestParameters: GetDocumentTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponseModel>;
    /**
     */
    getItemDocumentTypeRaw(requestParameters: GetItemDocumentTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemDocumentType200ResponseInner>>>;
    /**
     */
    getItemDocumentType(requestParameters?: GetItemDocumentTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemDocumentType200ResponseInner>>;
    /**
     */
    getItemDocumentTypeSearchRaw(requestParameters: GetItemDocumentTypeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelDocumentTypeItemResponseModel>>;
    /**
     */
    getItemDocumentTypeSearch(requestParameters?: GetItemDocumentTypeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelDocumentTypeItemResponseModel>;
    /**
     */
    getTreeDocumentTypeAncestorsRaw(requestParameters: GetTreeDocumentTypeAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeDocumentTypeAncestors200ResponseInner>>>;
    /**
     */
    getTreeDocumentTypeAncestors(requestParameters?: GetTreeDocumentTypeAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeDocumentTypeAncestors200ResponseInner>>;
    /**
     */
    getTreeDocumentTypeChildrenRaw(requestParameters: GetTreeDocumentTypeChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentTypeTreeItemResponseModel>>;
    /**
     */
    getTreeDocumentTypeChildren(requestParameters?: GetTreeDocumentTypeChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentTypeTreeItemResponseModel>;
    /**
     */
    getTreeDocumentTypeRootRaw(requestParameters: GetTreeDocumentTypeRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentTypeTreeItemResponseModel>>;
    /**
     */
    getTreeDocumentTypeRoot(requestParameters?: GetTreeDocumentTypeRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentTypeTreeItemResponseModel>;
    /**
     */
    postDocumentTypeRaw(requestParameters: PostDocumentTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDocumentType(requestParameters?: PostDocumentTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDocumentTypeAvailableCompositionsRaw(requestParameters: PostDocumentTypeAvailableCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PostDocumentTypeAvailableCompositions200ResponseInner>>>;
    /**
     */
    postDocumentTypeAvailableCompositions(requestParameters?: PostDocumentTypeAvailableCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PostDocumentTypeAvailableCompositions200ResponseInner>>;
    /**
     */
    postDocumentTypeByIdCopyRaw(requestParameters: PostDocumentTypeByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDocumentTypeByIdCopy(requestParameters: PostDocumentTypeByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDocumentTypeFolderRaw(requestParameters: PostDocumentTypeFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDocumentTypeFolder(requestParameters?: PostDocumentTypeFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDocumentTypeImportRaw(requestParameters: PostDocumentTypeImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDocumentTypeImport(requestParameters?: PostDocumentTypeImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDocumentTypeByIdRaw(requestParameters: PutDocumentTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDocumentTypeById(requestParameters: PutDocumentTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDocumentTypeByIdImportRaw(requestParameters: PutDocumentTypeByIdImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDocumentTypeByIdImport(requestParameters: PutDocumentTypeByIdImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDocumentTypeByIdMoveRaw(requestParameters: PutDocumentTypeByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDocumentTypeByIdMove(requestParameters: PutDocumentTypeByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDocumentTypeFolderByIdRaw(requestParameters: PutDocumentTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDocumentTypeFolderById(requestParameters: PutDocumentTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}