umbraco-management-api-client/dist/apis/DictionaryApi.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 { CreateDictionaryItemRequestModel, DictionaryItemResponseModel, GetItemDictionary200ResponseInner, GetTreeDictionaryAncestors200ResponseInner, ImportDictionaryRequestModel, MoveDictionaryRequestModel, PagedDictionaryOverviewResponseModel, PagedNamedEntityTreeItemResponseModel, UpdateDictionaryItemRequestModel } from '../models/index';
export interface DeleteDictionaryByIdRequest {
    id: string;
}
export interface GetDictionaryRequest {
    filter?: string;
    skip?: number;
    take?: number;
}
export interface GetDictionaryByIdRequest {
    id: string;
}
export interface GetDictionaryByIdExportRequest {
    id: string;
    includeChildren?: boolean;
}
export interface GetItemDictionaryRequest {
    id?: Set<string>;
}
export interface GetTreeDictionaryAncestorsRequest {
    descendantId?: string;
}
export interface GetTreeDictionaryChildrenRequest {
    parentId?: string;
    skip?: number;
    take?: number;
}
export interface GetTreeDictionaryRootRequest {
    skip?: number;
    take?: number;
}
export interface PostDictionaryRequest {
    createDictionaryItemRequestModel?: CreateDictionaryItemRequestModel;
}
export interface PostDictionaryImportRequest {
    importDictionaryRequestModel?: ImportDictionaryRequestModel;
}
export interface PutDictionaryByIdRequest {
    id: string;
    updateDictionaryItemRequestModel?: UpdateDictionaryItemRequestModel;
}
export interface PutDictionaryByIdMoveRequest {
    id: string;
    moveDictionaryRequestModel?: MoveDictionaryRequestModel;
}
/**
 *
 */
export declare class DictionaryApi extends runtime.BaseAPI {
    /**
     */
    deleteDictionaryByIdRaw(requestParameters: DeleteDictionaryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteDictionaryById(requestParameters: DeleteDictionaryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    getDictionaryRaw(requestParameters: GetDictionaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDictionaryOverviewResponseModel>>;
    /**
     */
    getDictionary(requestParameters?: GetDictionaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDictionaryOverviewResponseModel>;
    /**
     */
    getDictionaryByIdRaw(requestParameters: GetDictionaryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DictionaryItemResponseModel>>;
    /**
     */
    getDictionaryById(requestParameters: GetDictionaryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DictionaryItemResponseModel>;
    /**
     */
    getDictionaryByIdExportRaw(requestParameters: GetDictionaryByIdExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
    /**
     */
    getDictionaryByIdExport(requestParameters: GetDictionaryByIdExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
    /**
     */
    getItemDictionaryRaw(requestParameters: GetItemDictionaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemDictionary200ResponseInner>>>;
    /**
     */
    getItemDictionary(requestParameters?: GetItemDictionaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemDictionary200ResponseInner>>;
    /**
     */
    getTreeDictionaryAncestorsRaw(requestParameters: GetTreeDictionaryAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeDictionaryAncestors200ResponseInner>>>;
    /**
     */
    getTreeDictionaryAncestors(requestParameters?: GetTreeDictionaryAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeDictionaryAncestors200ResponseInner>>;
    /**
     */
    getTreeDictionaryChildrenRaw(requestParameters: GetTreeDictionaryChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedNamedEntityTreeItemResponseModel>>;
    /**
     */
    getTreeDictionaryChildren(requestParameters?: GetTreeDictionaryChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedNamedEntityTreeItemResponseModel>;
    /**
     */
    getTreeDictionaryRootRaw(requestParameters: GetTreeDictionaryRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedNamedEntityTreeItemResponseModel>>;
    /**
     */
    getTreeDictionaryRoot(requestParameters?: GetTreeDictionaryRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedNamedEntityTreeItemResponseModel>;
    /**
     */
    postDictionaryRaw(requestParameters: PostDictionaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDictionary(requestParameters?: PostDictionaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postDictionaryImportRaw(requestParameters: PostDictionaryImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postDictionaryImport(requestParameters?: PostDictionaryImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDictionaryByIdRaw(requestParameters: PutDictionaryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDictionaryById(requestParameters: PutDictionaryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putDictionaryByIdMoveRaw(requestParameters: PutDictionaryByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putDictionaryByIdMove(requestParameters: PutDictionaryByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}