umbraco-management-api-client
Version:
TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)
132 lines (131 loc) • 6.39 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 { CreateScriptFolderRequestModel, CreateScriptRequestModel, GetItemScript200ResponseInner, GetTreePartialViewAncestors200ResponseInner, PagedFileSystemTreeItemPresentationModel, RenameScriptRequestModel, ScriptFolderResponseModel, ScriptResponseModel, UpdateScriptRequestModel } from '../models/index';
export interface DeleteScriptByPathRequest {
path: string;
}
export interface DeleteScriptFolderByPathRequest {
path: string;
}
export interface GetItemScriptRequest {
path?: Set<string>;
}
export interface GetScriptByPathRequest {
path: string;
}
export interface GetScriptFolderByPathRequest {
path: string;
}
export interface GetTreeScriptAncestorsRequest {
descendantPath?: string;
}
export interface GetTreeScriptChildrenRequest {
parentPath?: string;
skip?: number;
take?: number;
}
export interface GetTreeScriptRootRequest {
skip?: number;
take?: number;
}
export interface PostScriptRequest {
createScriptRequestModel?: CreateScriptRequestModel;
}
export interface PostScriptFolderRequest {
createScriptFolderRequestModel?: CreateScriptFolderRequestModel;
}
export interface PutScriptByPathRequest {
path: string;
updateScriptRequestModel?: UpdateScriptRequestModel;
}
export interface PutScriptByPathRenameRequest {
path: string;
renameScriptRequestModel?: RenameScriptRequestModel;
}
/**
*
*/
export declare class ScriptApi extends runtime.BaseAPI {
/**
*/
deleteScriptByPathRaw(requestParameters: DeleteScriptByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteScriptByPath(requestParameters: DeleteScriptByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deleteScriptFolderByPathRaw(requestParameters: DeleteScriptFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteScriptFolderByPath(requestParameters: DeleteScriptFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
getItemScriptRaw(requestParameters: GetItemScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemScript200ResponseInner>>>;
/**
*/
getItemScript(requestParameters?: GetItemScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemScript200ResponseInner>>;
/**
*/
getScriptByPathRaw(requestParameters: GetScriptByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptResponseModel>>;
/**
*/
getScriptByPath(requestParameters: GetScriptByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptResponseModel>;
/**
*/
getScriptFolderByPathRaw(requestParameters: GetScriptFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptFolderResponseModel>>;
/**
*/
getScriptFolderByPath(requestParameters: GetScriptFolderByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptFolderResponseModel>;
/**
*/
getTreeScriptAncestorsRaw(requestParameters: GetTreeScriptAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreePartialViewAncestors200ResponseInner>>>;
/**
*/
getTreeScriptAncestors(requestParameters?: GetTreeScriptAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreePartialViewAncestors200ResponseInner>>;
/**
*/
getTreeScriptChildrenRaw(requestParameters: GetTreeScriptChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedFileSystemTreeItemPresentationModel>>;
/**
*/
getTreeScriptChildren(requestParameters?: GetTreeScriptChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedFileSystemTreeItemPresentationModel>;
/**
*/
getTreeScriptRootRaw(requestParameters: GetTreeScriptRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedFileSystemTreeItemPresentationModel>>;
/**
*/
getTreeScriptRoot(requestParameters?: GetTreeScriptRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedFileSystemTreeItemPresentationModel>;
/**
*/
postScriptRaw(requestParameters: PostScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postScript(requestParameters?: PostScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postScriptFolderRaw(requestParameters: PostScriptFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postScriptFolder(requestParameters?: PostScriptFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putScriptByPathRaw(requestParameters: PutScriptByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putScriptByPath(requestParameters: PutScriptByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putScriptByPathRenameRaw(requestParameters: PutScriptByPathRenameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putScriptByPathRename(requestParameters: PutScriptByPathRenameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}