umbraco-management-api-client/dist/apis/DataTypeApi.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 { CopyDataTypeRequestModel, CreateDataTypeRequestModel, CreateFolderRequestModel, DataTypeResponseModel, DatatypeConfigurationResponseModel, FolderResponseModel, GetDataTypeByIdReferences200ResponseInner, GetItemDataType200ResponseInner, GetTreeDataTypeAncestors200ResponseInner, MoveDataTypeRequestModel, PagedDataTypeItemResponseModel, PagedDataTypeTreeItemResponseModel, PagedIReferenceResponseModel, PagedModelDataTypeItemResponseModel, UpdateDataTypeRequestModel, UpdateFolderResponseModel } from '../models/index';
export interface DeleteDataTypeByIdRequest {
    id: string;
}
export interface DeleteDataTypeFolderByIdRequest {
    id: string;
}
export interface GetDataTypeByIdRequest {
    id: string;
}
export interface GetDataTypeByIdIsUsedRequest {
    id: string;
}
export interface GetDataTypeByIdReferencedByRequest {
    id: string;
    skip?: number;
    take?: number;
}
export interface GetDataTypeByIdReferencesRequest {
    id: string;
}
export interface GetDataTypeFolderByIdRequest {
    id: string;
}
export interface GetFilterDataTypeRequest {
    skip?: number;
    take?: number;
    name?: string;
    editorUiAlias?: string;
    editorAlias?: string;
}
export interface GetItemDataTypeRequest {
    id?: Set<string>;
}
export interface GetItemDataTypeSearchRequest {
    query?: string;
    skip?: number;
    take?: number;
}
export interface GetTreeDataTypeAncestorsRequest {
    descendantId?: string;
}
export interface GetTreeDataTypeChildrenRequest {
    parentId?: string;
    skip?: number;
    take?: number;
    foldersOnly?: boolean;
}
export interface GetTreeDataTypeRootRequest {
    skip?: number;
    take?: number;
    foldersOnly?: boolean;
}
export interface PostDataTypeRequest {
    createDataTypeRequestModel?: CreateDataTypeRequestModel;
}
export interface PostDataTypeByIdCopyRequest {
    id: string;
    copyDataTypeRequestModel?: CopyDataTypeRequestModel;
}
export interface PostDataTypeFolderRequest {
    createFolderRequestModel?: CreateFolderRequestModel;
}
export interface PutDataTypeByIdRequest {
    id: string;
    updateDataTypeRequestModel?: UpdateDataTypeRequestModel;
}
export interface PutDataTypeByIdMoveRequest {
    id: string;
    moveDataTypeRequestModel?: MoveDataTypeRequestModel;
}
export interface PutDataTypeFolderByIdRequest {
    id: string;
    updateFolderResponseModel?: UpdateFolderResponseModel;
}
/**
 *
 */
export declare class DataTypeApi extends runtime.BaseAPI {
    /**
     */
    deleteDataTypeByIdRaw(requestParameters: DeleteDataTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteDataTypeById(requestParameters: DeleteDataTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    deleteDataTypeFolderByIdRaw(requestParameters: DeleteDataTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteDataTypeFolderById(requestParameters: DeleteDataTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    getDataTypeByIdRaw(requestParameters: GetDataTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataTypeResponseModel>>;
    /**
     */
    getDataTypeById(requestParameters: GetDataTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataTypeResponseModel>;
    /**
     */
    getDataTypeByIdIsUsedRaw(requestParameters: GetDataTypeByIdIsUsedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     */
    getDataTypeByIdIsUsed(requestParameters: GetDataTypeByIdIsUsedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     */
    getDataTypeByIdReferencedByRaw(requestParameters: GetDataTypeByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedIReferenceResponseModel>>;
    /**
     */
    getDataTypeByIdReferencedBy(requestParameters: GetDataTypeByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedIReferenceResponseModel>;
    /**
     * @deprecated
     */
    getDataTypeByIdReferencesRaw(requestParameters: GetDataTypeByIdReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetDataTypeByIdReferences200ResponseInner>>>;
    /**
     * @deprecated
     */
    getDataTypeByIdReferences(requestParameters: GetDataTypeByIdReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetDataTypeByIdReferences200ResponseInner>>;
    /**
     */
    getDataTypeConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatatypeConfigurationResponseModel>>;
    /**
     */
    getDataTypeConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatatypeConfigurationResponseModel>;
    /**
     */
    getDataTypeFolderByIdRaw(requestParameters: GetDataTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponseModel>>;
    /**
     */
    getDataTypeFolderById(requestParameters: GetDataTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponseModel>;
    /**
     */
    getFilterDataTypeRaw(requestParameters: GetFilterDataTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDataTypeItemResponseModel>>;
    /**
     */
    getFilterDataType(requestParameters?: GetFilterDataTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDataTypeItemResponseModel>;
    /**
     */
    getItemDataTypeRaw(requestParameters: GetItemDataTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemDataType200ResponseInner>>>;
    /**
     */
    getItemDataType(requestParameters?: GetItemDataTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemDataType200ResponseInner>>;
    /**
     */
    getItemDataTypeSearchRaw(requestParameters: GetItemDataTypeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelDataTypeItemResponseModel>>;
    /**
     */
    getItemDataTypeSearch(requestParameters?: GetItemDataTypeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelDataTypeItemResponseModel>;
    /**
     */
    getTreeDataTypeAncestorsRaw(requestParameters: GetTreeDataTypeAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeDataTypeAncestors200ResponseInner>>>;
    /**
     */
    getTreeDataTypeAncestors(requestParameters?: GetTreeDataTypeAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeDataTypeAncestors200ResponseInner>>;
    /**
     */
    getTreeDataTypeChildrenRaw(requestParameters: GetTreeDataTypeChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDataTypeTreeItemResponseModel>>;
    /**
     */
    getTreeDataTypeChildren(requestParameters?: GetTreeDataTypeChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDataTypeTreeItemResponseModel>;
    /**
     */
    getTreeDataTypeRootRaw(requestParameters: GetTreeDataTypeRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDataTypeTreeItemResponseModel>>;
    /**
     */
    getTreeDataTypeRoot(requestParameters?: GetTreeDataTypeRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDataTypeTreeItemResponseModel>;
    /**
     */
    postDataTypeRaw(requestParameters: PostDataTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDataType(requestParameters?: PostDataTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDataTypeByIdCopyRaw(requestParameters: PostDataTypeByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDataTypeByIdCopy(requestParameters: PostDataTypeByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDataTypeFolderRaw(requestParameters: PostDataTypeFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDataTypeFolder(requestParameters?: PostDataTypeFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDataTypeByIdRaw(requestParameters: PutDataTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDataTypeById(requestParameters: PutDataTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDataTypeByIdMoveRaw(requestParameters: PutDataTypeByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDataTypeByIdMove(requestParameters: PutDataTypeByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDataTypeFolderByIdRaw(requestParameters: PutDataTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDataTypeFolderById(requestParameters: PutDataTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}