umbraco-management-api-client
Version:
TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)
260 lines (259 loc) • 13.5 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 { CopyMediaTypeRequestModel, CreateFolderRequestModel, CreateMediaTypeRequestModel, FolderResponseModel, GetItemMediaType200ResponseInner, GetMediaTypeByIdCompositionReferences200ResponseInner, GetTreeMediaTypeAncestors200ResponseInner, ImportMediaTypeRequestModel, MediaTypeCompositionRequestModel, MediaTypeConfigurationResponseModel, MediaTypeResponseModel, MoveMediaTypeRequestModel, PagedAllowedMediaTypeModel, PagedMediaTypeTreeItemResponseModel, PagedModelMediaTypeItemResponseModel, PostMediaTypeAvailableCompositions200ResponseInner, UpdateFolderResponseModel, UpdateMediaTypeRequestModel } from '../models/index';
export interface DeleteMediaTypeByIdRequest {
id: string;
}
export interface DeleteMediaTypeFolderByIdRequest {
id: string;
}
export interface GetItemMediaTypeRequest {
id?: Set<string>;
}
export interface GetItemMediaTypeAllowedRequest {
fileExtension?: string;
skip?: number;
take?: number;
}
export interface GetItemMediaTypeFoldersRequest {
skip?: number;
take?: number;
}
export interface GetItemMediaTypeSearchRequest {
query?: string;
skip?: number;
take?: number;
}
export interface GetMediaTypeAllowedAtRootRequest {
skip?: number;
take?: number;
}
export interface GetMediaTypeByIdRequest {
id: string;
}
export interface GetMediaTypeByIdAllowedChildrenRequest {
id: string;
parentContentKey?: string;
skip?: number;
take?: number;
}
export interface GetMediaTypeByIdCompositionReferencesRequest {
id: string;
}
export interface GetMediaTypeByIdExportRequest {
id: string;
}
export interface GetMediaTypeFolderByIdRequest {
id: string;
}
export interface GetTreeMediaTypeAncestorsRequest {
descendantId?: string;
}
export interface GetTreeMediaTypeChildrenRequest {
parentId?: string;
skip?: number;
take?: number;
foldersOnly?: boolean;
}
export interface GetTreeMediaTypeRootRequest {
skip?: number;
take?: number;
foldersOnly?: boolean;
}
export interface PostMediaTypeRequest {
createMediaTypeRequestModel?: CreateMediaTypeRequestModel;
}
export interface PostMediaTypeAvailableCompositionsRequest {
mediaTypeCompositionRequestModel?: MediaTypeCompositionRequestModel;
}
export interface PostMediaTypeByIdCopyRequest {
id: string;
copyMediaTypeRequestModel?: CopyMediaTypeRequestModel;
}
export interface PostMediaTypeFolderRequest {
createFolderRequestModel?: CreateFolderRequestModel;
}
export interface PostMediaTypeImportRequest {
importMediaTypeRequestModel?: ImportMediaTypeRequestModel;
}
export interface PutMediaTypeByIdRequest {
id: string;
updateMediaTypeRequestModel?: UpdateMediaTypeRequestModel;
}
export interface PutMediaTypeByIdImportRequest {
id: string;
importMediaTypeRequestModel?: ImportMediaTypeRequestModel;
}
export interface PutMediaTypeByIdMoveRequest {
id: string;
moveMediaTypeRequestModel?: MoveMediaTypeRequestModel;
}
export interface PutMediaTypeFolderByIdRequest {
id: string;
updateFolderResponseModel?: UpdateFolderResponseModel;
}
/**
*
*/
export declare class MediaTypeApi extends runtime.BaseAPI {
/**
*/
deleteMediaTypeByIdRaw(requestParameters: DeleteMediaTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteMediaTypeById(requestParameters: DeleteMediaTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deleteMediaTypeFolderByIdRaw(requestParameters: DeleteMediaTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteMediaTypeFolderById(requestParameters: DeleteMediaTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
getItemMediaTypeRaw(requestParameters: GetItemMediaTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemMediaType200ResponseInner>>>;
/**
*/
getItemMediaType(requestParameters?: GetItemMediaTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemMediaType200ResponseInner>>;
/**
*/
getItemMediaTypeAllowedRaw(requestParameters: GetItemMediaTypeAllowedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelMediaTypeItemResponseModel>>;
/**
*/
getItemMediaTypeAllowed(requestParameters?: GetItemMediaTypeAllowedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelMediaTypeItemResponseModel>;
/**
*/
getItemMediaTypeFoldersRaw(requestParameters: GetItemMediaTypeFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelMediaTypeItemResponseModel>>;
/**
*/
getItemMediaTypeFolders(requestParameters?: GetItemMediaTypeFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelMediaTypeItemResponseModel>;
/**
*/
getItemMediaTypeSearchRaw(requestParameters: GetItemMediaTypeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelMediaTypeItemResponseModel>>;
/**
*/
getItemMediaTypeSearch(requestParameters?: GetItemMediaTypeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelMediaTypeItemResponseModel>;
/**
*/
getMediaTypeAllowedAtRootRaw(requestParameters: GetMediaTypeAllowedAtRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedAllowedMediaTypeModel>>;
/**
*/
getMediaTypeAllowedAtRoot(requestParameters?: GetMediaTypeAllowedAtRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedAllowedMediaTypeModel>;
/**
*/
getMediaTypeByIdRaw(requestParameters: GetMediaTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MediaTypeResponseModel>>;
/**
*/
getMediaTypeById(requestParameters: GetMediaTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MediaTypeResponseModel>;
/**
*/
getMediaTypeByIdAllowedChildrenRaw(requestParameters: GetMediaTypeByIdAllowedChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedAllowedMediaTypeModel>>;
/**
*/
getMediaTypeByIdAllowedChildren(requestParameters: GetMediaTypeByIdAllowedChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedAllowedMediaTypeModel>;
/**
*/
getMediaTypeByIdCompositionReferencesRaw(requestParameters: GetMediaTypeByIdCompositionReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetMediaTypeByIdCompositionReferences200ResponseInner>>>;
/**
*/
getMediaTypeByIdCompositionReferences(requestParameters: GetMediaTypeByIdCompositionReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetMediaTypeByIdCompositionReferences200ResponseInner>>;
/**
*/
getMediaTypeByIdExportRaw(requestParameters: GetMediaTypeByIdExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
/**
*/
getMediaTypeByIdExport(requestParameters: GetMediaTypeByIdExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
/**
*/
getMediaTypeConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MediaTypeConfigurationResponseModel>>;
/**
*/
getMediaTypeConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MediaTypeConfigurationResponseModel>;
/**
*/
getMediaTypeFolderByIdRaw(requestParameters: GetMediaTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponseModel>>;
/**
*/
getMediaTypeFolderById(requestParameters: GetMediaTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponseModel>;
/**
*/
getTreeMediaTypeAncestorsRaw(requestParameters: GetTreeMediaTypeAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeMediaTypeAncestors200ResponseInner>>>;
/**
*/
getTreeMediaTypeAncestors(requestParameters?: GetTreeMediaTypeAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeMediaTypeAncestors200ResponseInner>>;
/**
*/
getTreeMediaTypeChildrenRaw(requestParameters: GetTreeMediaTypeChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMediaTypeTreeItemResponseModel>>;
/**
*/
getTreeMediaTypeChildren(requestParameters?: GetTreeMediaTypeChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMediaTypeTreeItemResponseModel>;
/**
*/
getTreeMediaTypeRootRaw(requestParameters: GetTreeMediaTypeRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMediaTypeTreeItemResponseModel>>;
/**
*/
getTreeMediaTypeRoot(requestParameters?: GetTreeMediaTypeRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMediaTypeTreeItemResponseModel>;
/**
*/
postMediaTypeRaw(requestParameters: PostMediaTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postMediaType(requestParameters?: PostMediaTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postMediaTypeAvailableCompositionsRaw(requestParameters: PostMediaTypeAvailableCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PostMediaTypeAvailableCompositions200ResponseInner>>>;
/**
*/
postMediaTypeAvailableCompositions(requestParameters?: PostMediaTypeAvailableCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PostMediaTypeAvailableCompositions200ResponseInner>>;
/**
*/
postMediaTypeByIdCopyRaw(requestParameters: PostMediaTypeByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postMediaTypeByIdCopy(requestParameters: PostMediaTypeByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postMediaTypeFolderRaw(requestParameters: PostMediaTypeFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postMediaTypeFolder(requestParameters?: PostMediaTypeFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postMediaTypeImportRaw(requestParameters: PostMediaTypeImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postMediaTypeImport(requestParameters?: PostMediaTypeImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putMediaTypeByIdRaw(requestParameters: PutMediaTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putMediaTypeById(requestParameters: PutMediaTypeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putMediaTypeByIdImportRaw(requestParameters: PutMediaTypeByIdImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putMediaTypeByIdImport(requestParameters: PutMediaTypeByIdImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putMediaTypeByIdMoveRaw(requestParameters: PutMediaTypeByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putMediaTypeByIdMove(requestParameters: PutMediaTypeByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putMediaTypeFolderByIdRaw(requestParameters: PutMediaTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putMediaTypeFolderById(requestParameters: PutMediaTypeFolderByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}