umbraco-management-api-client
Version:
TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)
151 lines (150 loc) • 7.9 kB
TypeScript
/**
* 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 { CreatePartialViewFolderRequestModel, CreatePartialViewRequestModel, GetItemPartialView200ResponseInner, GetTreePartialViewAncestors200ResponseInner, PagedFileSystemTreeItemPresentationModel, PagedPartialViewSnippetItemResponseModel, PartialViewFolderResponseModel, PartialViewResponseModel, PartialViewSnippetResponseModel, RenamePartialViewRequestModel, UpdatePartialViewRequestModel } from '../models/index';
export interface DeletePartialViewByPathRequest {
path: string;
}
export interface DeletePartialViewFolderByPathRequest {
path: string;
}
export interface GetItemPartialViewRequest {
path?: Set<string>;
}
export interface GetPartialViewByPathRequest {
path: string;
}
export interface GetPartialViewFolderByPathRequest {
path: string;
}
export interface GetPartialViewSnippetRequest {
skip?: number;
take?: number;
}
export interface GetPartialViewSnippetByIdRequest {
id: string;
}
export interface GetTreePartialViewAncestorsRequest {
descendantPath?: string;
}
export interface GetTreePartialViewChildrenRequest {
parentPath?: string;
skip?: number;
take?: number;
}
export interface GetTreePartialViewRootRequest {
skip?: number;
take?: number;
}
export interface PostPartialViewRequest {
createPartialViewRequestModel?: CreatePartialViewRequestModel;
}
export interface PostPartialViewFolderRequest {
createPartialViewFolderRequestModel?: CreatePartialViewFolderRequestModel;
}
export interface PutPartialViewByPathRequest {
path: string;
updatePartialViewRequestModel?: UpdatePartialViewRequestModel;
}
export interface PutPartialViewByPathRenameRequest {
path: string;
renamePartialViewRequestModel?: RenamePartialViewRequestModel;
}
/**
*
*/
export declare class PartialViewApi extends runtime.BaseAPI {
/**
*/
deletePartialViewByPathRaw(requestParameters: DeletePartialViewByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deletePartialViewByPath(requestParameters: DeletePartialViewByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deletePartialViewFolderByPathRaw(requestParameters: DeletePartialViewFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deletePartialViewFolderByPath(requestParameters: DeletePartialViewFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
getItemPartialViewRaw(requestParameters: GetItemPartialViewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemPartialView200ResponseInner>>>;
/**
*/
getItemPartialView(requestParameters?: GetItemPartialViewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemPartialView200ResponseInner>>;
/**
*/
getPartialViewByPathRaw(requestParameters: GetPartialViewByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartialViewResponseModel>>;
/**
*/
getPartialViewByPath(requestParameters: GetPartialViewByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartialViewResponseModel>;
/**
*/
getPartialViewFolderByPathRaw(requestParameters: GetPartialViewFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartialViewFolderResponseModel>>;
/**
*/
getPartialViewFolderByPath(requestParameters: GetPartialViewFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartialViewFolderResponseModel>;
/**
*/
getPartialViewSnippetRaw(requestParameters: GetPartialViewSnippetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedPartialViewSnippetItemResponseModel>>;
/**
*/
getPartialViewSnippet(requestParameters?: GetPartialViewSnippetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedPartialViewSnippetItemResponseModel>;
/**
*/
getPartialViewSnippetByIdRaw(requestParameters: GetPartialViewSnippetByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartialViewSnippetResponseModel>>;
/**
*/
getPartialViewSnippetById(requestParameters: GetPartialViewSnippetByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartialViewSnippetResponseModel>;
/**
*/
getTreePartialViewAncestorsRaw(requestParameters: GetTreePartialViewAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreePartialViewAncestors200ResponseInner>>>;
/**
*/
getTreePartialViewAncestors(requestParameters?: GetTreePartialViewAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreePartialViewAncestors200ResponseInner>>;
/**
*/
getTreePartialViewChildrenRaw(requestParameters: GetTreePartialViewChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedFileSystemTreeItemPresentationModel>>;
/**
*/
getTreePartialViewChildren(requestParameters?: GetTreePartialViewChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedFileSystemTreeItemPresentationModel>;
/**
*/
getTreePartialViewRootRaw(requestParameters: GetTreePartialViewRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedFileSystemTreeItemPresentationModel>>;
/**
*/
getTreePartialViewRoot(requestParameters?: GetTreePartialViewRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedFileSystemTreeItemPresentationModel>;
/**
*/
postPartialViewRaw(requestParameters: PostPartialViewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postPartialView(requestParameters?: PostPartialViewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postPartialViewFolderRaw(requestParameters: PostPartialViewFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postPartialViewFolder(requestParameters?: PostPartialViewFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putPartialViewByPathRaw(requestParameters: PutPartialViewByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putPartialViewByPath(requestParameters: PutPartialViewByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putPartialViewByPathRenameRaw(requestParameters: PutPartialViewByPathRenameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putPartialViewByPathRename(requestParameters: PutPartialViewByPathRenameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}