umbraco-management-api-client/dist/apis/TemplateApi.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 { CreateTemplateRequestModel, GetItemTemplate200ResponseInner, GetTreeDictionaryAncestors200ResponseInner, PagedModelTemplateItemResponseModel, PagedNamedEntityTreeItemResponseModel, TemplateConfigurationResponseModel, TemplateQueryExecuteModel, TemplateQueryResultResponseModel, TemplateQuerySettingsResponseModel, TemplateResponseModel, UpdateTemplateRequestModel } from '../models/index';
export interface DeleteTemplateByIdRequest {
    id: string;
}
export interface GetItemTemplateRequest {
    id?: Set<string>;
}
export interface GetItemTemplateSearchRequest {
    query?: string;
    skip?: number;
    take?: number;
}
export interface GetTemplateByIdRequest {
    id: string;
}
export interface GetTreeTemplateAncestorsRequest {
    descendantId?: string;
}
export interface GetTreeTemplateChildrenRequest {
    parentId?: string;
    skip?: number;
    take?: number;
}
export interface GetTreeTemplateRootRequest {
    skip?: number;
    take?: number;
}
export interface PostTemplateRequest {
    createTemplateRequestModel?: CreateTemplateRequestModel;
}
export interface PostTemplateQueryExecuteRequest {
    templateQueryExecuteModel?: TemplateQueryExecuteModel;
}
export interface PutTemplateByIdRequest {
    id: string;
    updateTemplateRequestModel?: UpdateTemplateRequestModel;
}
/**
 *
 */
export declare class TemplateApi extends runtime.BaseAPI {
    /**
     */
    deleteTemplateByIdRaw(requestParameters: DeleteTemplateByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteTemplateById(requestParameters: DeleteTemplateByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    getItemTemplateRaw(requestParameters: GetItemTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemTemplate200ResponseInner>>>;
    /**
     */
    getItemTemplate(requestParameters?: GetItemTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemTemplate200ResponseInner>>;
    /**
     */
    getItemTemplateSearchRaw(requestParameters: GetItemTemplateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelTemplateItemResponseModel>>;
    /**
     */
    getItemTemplateSearch(requestParameters?: GetItemTemplateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelTemplateItemResponseModel>;
    /**
     */
    getTemplateByIdRaw(requestParameters: GetTemplateByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemplateResponseModel>>;
    /**
     */
    getTemplateById(requestParameters: GetTemplateByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemplateResponseModel>;
    /**
     */
    getTemplateConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemplateConfigurationResponseModel>>;
    /**
     */
    getTemplateConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemplateConfigurationResponseModel>;
    /**
     */
    getTemplateQuerySettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemplateQuerySettingsResponseModel>>;
    /**
     */
    getTemplateQuerySettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemplateQuerySettingsResponseModel>;
    /**
     */
    getTreeTemplateAncestorsRaw(requestParameters: GetTreeTemplateAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeDictionaryAncestors200ResponseInner>>>;
    /**
     */
    getTreeTemplateAncestors(requestParameters?: GetTreeTemplateAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeDictionaryAncestors200ResponseInner>>;
    /**
     */
    getTreeTemplateChildrenRaw(requestParameters: GetTreeTemplateChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedNamedEntityTreeItemResponseModel>>;
    /**
     */
    getTreeTemplateChildren(requestParameters?: GetTreeTemplateChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedNamedEntityTreeItemResponseModel>;
    /**
     */
    getTreeTemplateRootRaw(requestParameters: GetTreeTemplateRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedNamedEntityTreeItemResponseModel>>;
    /**
     */
    getTreeTemplateRoot(requestParameters?: GetTreeTemplateRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedNamedEntityTreeItemResponseModel>;
    /**
     */
    postTemplateRaw(requestParameters: PostTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postTemplate(requestParameters?: PostTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postTemplateQueryExecuteRaw(requestParameters: PostTemplateQueryExecuteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemplateQueryResultResponseModel>>;
    /**
     */
    postTemplateQueryExecute(requestParameters?: PostTemplateQueryExecuteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemplateQueryResultResponseModel>;
    /**
     */
    putTemplateByIdRaw(requestParameters: PutTemplateByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putTemplateById(requestParameters: PutTemplateByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}