umbraco-management-api-client/dist/apis/MediaApi.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 { CreateMediaRequestModel, DirectionModel, GetImagingResizeUrls200ResponseInner, GetItemMedia200ResponseInner, GetTreeMediaAncestors200ResponseInner, MediaConfigurationResponseModel, MediaResponseModel, MoveMediaRequestModel, PagedAuditLogResponseModel, PagedIReferenceResponseModel, PagedMediaCollectionResponseModel, PagedMediaRecycleBinItemResponseModel, PagedMediaTreeItemResponseModel, PagedModelMediaItemResponseModel, PagedReferenceByIdModel, ReferenceByIdModel, SortingRequestModel, UpdateMediaRequestModel } from '../models/index';
export interface DeleteMediaByIdRequest {
    id: string;
}
export interface DeleteRecycleBinMediaByIdRequest {
    id: string;
}
export interface GetCollectionMediaRequest {
    id?: string;
    dataTypeId?: string;
    orderBy?: string;
    orderDirection?: DirectionModel;
    filter?: string;
    skip?: number;
    take?: number;
}
export interface GetItemMediaRequest {
    id?: Set<string>;
}
export interface GetItemMediaSearchRequest {
    query?: string;
    trashed?: boolean;
    culture?: string;
    skip?: number;
    take?: number;
    parentId?: string;
    allowedMediaTypes?: Array<string>;
}
export interface GetMediaAreReferencedRequest {
    id?: Set<string>;
    skip?: number;
    take?: number;
}
export interface GetMediaByIdRequest {
    id: string;
}
export interface GetMediaByIdAuditLogRequest {
    id: string;
    orderDirection?: DirectionModel;
    sinceDate?: Date;
    skip?: number;
    take?: number;
}
export interface GetMediaByIdReferencedByRequest {
    id: string;
    skip?: number;
    take?: number;
}
export interface GetMediaByIdReferencedDescendantsRequest {
    id: string;
    skip?: number;
    take?: number;
}
export interface GetMediaUrlsRequest {
    id?: Set<string>;
}
export interface GetRecycleBinMediaByIdOriginalParentRequest {
    id: string;
}
export interface GetRecycleBinMediaChildrenRequest {
    parentId?: string;
    skip?: number;
    take?: number;
}
export interface GetRecycleBinMediaReferencedByRequest {
    skip?: number;
    take?: number;
}
export interface GetRecycleBinMediaRootRequest {
    skip?: number;
    take?: number;
}
export interface GetTreeMediaAncestorsRequest {
    descendantId?: string;
}
export interface GetTreeMediaChildrenRequest {
    parentId?: string;
    skip?: number;
    take?: number;
    dataTypeId?: string;
}
export interface GetTreeMediaRootRequest {
    skip?: number;
    take?: number;
    dataTypeId?: string;
}
export interface PostMediaRequest {
    createMediaRequestModel?: CreateMediaRequestModel;
}
export interface PostMediaValidateRequest {
    createMediaRequestModel?: CreateMediaRequestModel;
}
export interface PutMediaByIdRequest {
    id: string;
    updateMediaRequestModel?: UpdateMediaRequestModel;
}
export interface PutMediaByIdMoveRequest {
    id: string;
    moveMediaRequestModel?: MoveMediaRequestModel;
}
export interface PutMediaByIdMoveToRecycleBinRequest {
    id: string;
}
export interface PutMediaByIdValidateRequest {
    id: string;
    updateMediaRequestModel?: UpdateMediaRequestModel;
}
export interface PutMediaSortRequest {
    sortingRequestModel?: SortingRequestModel;
}
export interface PutRecycleBinMediaByIdRestoreRequest {
    id: string;
    moveMediaRequestModel?: MoveMediaRequestModel;
}
/**
 *
 */
export declare class MediaApi extends runtime.BaseAPI {
    /**
     */
    deleteMediaByIdRaw(requestParameters: DeleteMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteMediaById(requestParameters: DeleteMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    deleteRecycleBinMediaRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteRecycleBinMedia(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    deleteRecycleBinMediaByIdRaw(requestParameters: DeleteRecycleBinMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteRecycleBinMediaById(requestParameters: DeleteRecycleBinMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    getCollectionMediaRaw(requestParameters: GetCollectionMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMediaCollectionResponseModel>>;
    /**
     */
    getCollectionMedia(requestParameters?: GetCollectionMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMediaCollectionResponseModel>;
    /**
     */
    getItemMediaRaw(requestParameters: GetItemMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemMedia200ResponseInner>>>;
    /**
     */
    getItemMedia(requestParameters?: GetItemMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemMedia200ResponseInner>>;
    /**
     */
    getItemMediaSearchRaw(requestParameters: GetItemMediaSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelMediaItemResponseModel>>;
    /**
     */
    getItemMediaSearch(requestParameters?: GetItemMediaSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelMediaItemResponseModel>;
    /**
     */
    getMediaAreReferencedRaw(requestParameters: GetMediaAreReferencedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedReferenceByIdModel>>;
    /**
     */
    getMediaAreReferenced(requestParameters?: GetMediaAreReferencedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedReferenceByIdModel>;
    /**
     */
    getMediaByIdRaw(requestParameters: GetMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MediaResponseModel>>;
    /**
     */
    getMediaById(requestParameters: GetMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MediaResponseModel>;
    /**
     */
    getMediaByIdAuditLogRaw(requestParameters: GetMediaByIdAuditLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedAuditLogResponseModel>>;
    /**
     */
    getMediaByIdAuditLog(requestParameters: GetMediaByIdAuditLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedAuditLogResponseModel>;
    /**
     */
    getMediaByIdReferencedByRaw(requestParameters: GetMediaByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedIReferenceResponseModel>>;
    /**
     */
    getMediaByIdReferencedBy(requestParameters: GetMediaByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedIReferenceResponseModel>;
    /**
     */
    getMediaByIdReferencedDescendantsRaw(requestParameters: GetMediaByIdReferencedDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedReferenceByIdModel>>;
    /**
     */
    getMediaByIdReferencedDescendants(requestParameters: GetMediaByIdReferencedDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedReferenceByIdModel>;
    /**
     * @deprecated
     */
    getMediaConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MediaConfigurationResponseModel>>;
    /**
     * @deprecated
     */
    getMediaConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MediaConfigurationResponseModel>;
    /**
     */
    getMediaUrlsRaw(requestParameters: GetMediaUrlsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetImagingResizeUrls200ResponseInner>>>;
    /**
     */
    getMediaUrls(requestParameters?: GetMediaUrlsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetImagingResizeUrls200ResponseInner>>;
    /**
     */
    getRecycleBinMediaByIdOriginalParentRaw(requestParameters: GetRecycleBinMediaByIdOriginalParentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferenceByIdModel>>;
    /**
     */
    getRecycleBinMediaByIdOriginalParent(requestParameters: GetRecycleBinMediaByIdOriginalParentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferenceByIdModel>;
    /**
     */
    getRecycleBinMediaChildrenRaw(requestParameters: GetRecycleBinMediaChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMediaRecycleBinItemResponseModel>>;
    /**
     */
    getRecycleBinMediaChildren(requestParameters?: GetRecycleBinMediaChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMediaRecycleBinItemResponseModel>;
    /**
     */
    getRecycleBinMediaReferencedByRaw(requestParameters: GetRecycleBinMediaReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedIReferenceResponseModel>>;
    /**
     */
    getRecycleBinMediaReferencedBy(requestParameters?: GetRecycleBinMediaReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedIReferenceResponseModel>;
    /**
     */
    getRecycleBinMediaRootRaw(requestParameters: GetRecycleBinMediaRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMediaRecycleBinItemResponseModel>>;
    /**
     */
    getRecycleBinMediaRoot(requestParameters?: GetRecycleBinMediaRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMediaRecycleBinItemResponseModel>;
    /**
     */
    getTreeMediaAncestorsRaw(requestParameters: GetTreeMediaAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeMediaAncestors200ResponseInner>>>;
    /**
     */
    getTreeMediaAncestors(requestParameters?: GetTreeMediaAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeMediaAncestors200ResponseInner>>;
    /**
     */
    getTreeMediaChildrenRaw(requestParameters: GetTreeMediaChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMediaTreeItemResponseModel>>;
    /**
     */
    getTreeMediaChildren(requestParameters?: GetTreeMediaChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMediaTreeItemResponseModel>;
    /**
     */
    getTreeMediaRootRaw(requestParameters: GetTreeMediaRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMediaTreeItemResponseModel>>;
    /**
     */
    getTreeMediaRoot(requestParameters?: GetTreeMediaRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMediaTreeItemResponseModel>;
    /**
     */
    postMediaRaw(requestParameters: PostMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postMedia(requestParameters?: PostMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postMediaValidateRaw(requestParameters: PostMediaValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postMediaValidate(requestParameters?: PostMediaValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putMediaByIdRaw(requestParameters: PutMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putMediaById(requestParameters: PutMediaByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putMediaByIdMoveRaw(requestParameters: PutMediaByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putMediaByIdMove(requestParameters: PutMediaByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putMediaByIdMoveToRecycleBinRaw(requestParameters: PutMediaByIdMoveToRecycleBinRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putMediaByIdMoveToRecycleBin(requestParameters: PutMediaByIdMoveToRecycleBinRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putMediaByIdValidateRaw(requestParameters: PutMediaByIdValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putMediaByIdValidate(requestParameters: PutMediaByIdValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putMediaSortRaw(requestParameters: PutMediaSortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putMediaSort(requestParameters?: PutMediaSortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putRecycleBinMediaByIdRestoreRaw(requestParameters: PutRecycleBinMediaByIdRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putRecycleBinMediaByIdRestore(requestParameters: PutRecycleBinMediaByIdRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}