UNPKG

umbraco-management-api-client

Version:

TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)

436 lines (435 loc) 22.9 kB
/** * 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 { CopyDocumentRequestModel, CreateDocumentRequestModel, DirectionModel, DocumentConfigurationResponseModel, DocumentResponseModel, DomainsResponseModel, GetDocumentByIdNotifications200ResponseInner, GetDocumentUrls200ResponseInner, GetItemDocument200ResponseInner, GetTreeDocumentAncestors200ResponseInner, MoveDocumentRequestModel, MoveMediaRequestModel, PagedAuditLogResponseModel, PagedDocumentCollectionResponseModel, PagedDocumentRecycleBinItemResponseModel, PagedDocumentTreeItemResponseModel, PagedIReferenceResponseModel, PagedModelDocumentItemResponseModel, PagedReferenceByIdModel, PublicAccessRequestModel, PublicAccessResponseModel, PublishDocumentRequestModel, PublishDocumentWithDescendantsRequestModel, PublishWithDescendantsResultModel, PublishedDocumentResponseModel, ReferenceByIdModel, SortingRequestModel, UnpublishDocumentRequestModel, UpdateDocumentNotificationsRequestModel, UpdateDocumentRequestModel, UpdateDomainsRequestModel, ValidateUpdateDocumentRequestModel } from '../models/index'; export interface DeleteDocumentByIdRequest { id: string; } export interface DeleteDocumentByIdPublicAccessRequest { id: string; } export interface DeleteRecycleBinDocumentByIdRequest { id: string; } export interface GetCollectionDocumentByIdRequest { id: string; dataTypeId?: string; orderBy?: string; orderCulture?: string; orderDirection?: DirectionModel; filter?: string; skip?: number; take?: number; } export interface GetDocumentAreReferencedRequest { id?: Set<string>; skip?: number; take?: number; } export interface GetDocumentByIdRequest { id: string; } export interface GetDocumentByIdAuditLogRequest { id: string; orderDirection?: DirectionModel; sinceDate?: Date; skip?: number; take?: number; } export interface GetDocumentByIdDomainsRequest { id: string; } export interface GetDocumentByIdNotificationsRequest { id: string; } export interface GetDocumentByIdPublicAccessRequest { id: string; } export interface GetDocumentByIdPublishWithDescendantsResultByTaskIdRequest { id: string; taskId: string; } export interface GetDocumentByIdPublishedRequest { id: string; } export interface GetDocumentByIdReferencedByRequest { id: string; skip?: number; take?: number; } export interface GetDocumentByIdReferencedDescendantsRequest { id: string; skip?: number; take?: number; } export interface GetDocumentUrlsRequest { id?: Set<string>; } export interface GetItemDocumentRequest { id?: Set<string>; } export interface GetItemDocumentSearchRequest { query?: string; trashed?: boolean; culture?: string; skip?: number; take?: number; parentId?: string; allowedDocumentTypes?: Array<string>; } export interface GetRecycleBinDocumentByIdOriginalParentRequest { id: string; } export interface GetRecycleBinDocumentChildrenRequest { parentId?: string; skip?: number; take?: number; } export interface GetRecycleBinDocumentReferencedByRequest { skip?: number; take?: number; } export interface GetRecycleBinDocumentRootRequest { skip?: number; take?: number; } export interface GetTreeDocumentAncestorsRequest { descendantId?: string; } export interface GetTreeDocumentChildrenRequest { parentId?: string; skip?: number; take?: number; dataTypeId?: string; } export interface GetTreeDocumentRootRequest { skip?: number; take?: number; dataTypeId?: string; } export interface PostDocumentRequest { createDocumentRequestModel?: CreateDocumentRequestModel; } export interface PostDocumentByIdCopyRequest { id: string; copyDocumentRequestModel?: CopyDocumentRequestModel; } export interface PostDocumentByIdPublicAccessRequest { id: string; publicAccessRequestModel?: PublicAccessRequestModel; } export interface PostDocumentValidateRequest { createDocumentRequestModel?: CreateDocumentRequestModel; } export interface PutDocumentByIdRequest { id: string; updateDocumentRequestModel?: UpdateDocumentRequestModel; } export interface PutDocumentByIdDomainsRequest { id: string; updateDomainsRequestModel?: UpdateDomainsRequestModel; } export interface PutDocumentByIdMoveRequest { id: string; moveDocumentRequestModel?: MoveDocumentRequestModel; } export interface PutDocumentByIdMoveToRecycleBinRequest { id: string; } export interface PutDocumentByIdNotificationsRequest { id: string; updateDocumentNotificationsRequestModel?: UpdateDocumentNotificationsRequestModel; } export interface PutDocumentByIdPublicAccessRequest { id: string; publicAccessRequestModel?: PublicAccessRequestModel; } export interface PutDocumentByIdPublishRequest { id: string; publishDocumentRequestModel?: PublishDocumentRequestModel; } export interface PutDocumentByIdPublishWithDescendantsRequest { id: string; publishDocumentWithDescendantsRequestModel?: PublishDocumentWithDescendantsRequestModel; } export interface PutDocumentByIdUnpublishRequest { id: string; unpublishDocumentRequestModel?: UnpublishDocumentRequestModel; } export interface PutDocumentSortRequest { sortingRequestModel?: SortingRequestModel; } export interface PutRecycleBinDocumentByIdRestoreRequest { id: string; moveMediaRequestModel?: MoveMediaRequestModel; } export interface PutUmbracoManagementApiV11DocumentByIdValidate11Request { id: string; validateUpdateDocumentRequestModel?: ValidateUpdateDocumentRequestModel; } /** * */ export declare class DocumentApi extends runtime.BaseAPI { /** */ deleteDocumentByIdRaw(requestParameters: DeleteDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ deleteDocumentById(requestParameters: DeleteDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ deleteDocumentByIdPublicAccessRaw(requestParameters: DeleteDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ deleteDocumentByIdPublicAccess(requestParameters: DeleteDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ deleteRecycleBinDocumentRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ deleteRecycleBinDocument(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ deleteRecycleBinDocumentByIdRaw(requestParameters: DeleteRecycleBinDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ deleteRecycleBinDocumentById(requestParameters: DeleteRecycleBinDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ getCollectionDocumentByIdRaw(requestParameters: GetCollectionDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentCollectionResponseModel>>; /** */ getCollectionDocumentById(requestParameters: GetCollectionDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentCollectionResponseModel>; /** */ getDocumentAreReferencedRaw(requestParameters: GetDocumentAreReferencedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedReferenceByIdModel>>; /** */ getDocumentAreReferenced(requestParameters?: GetDocumentAreReferencedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedReferenceByIdModel>; /** */ getDocumentByIdRaw(requestParameters: GetDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponseModel>>; /** */ getDocumentById(requestParameters: GetDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponseModel>; /** */ getDocumentByIdAuditLogRaw(requestParameters: GetDocumentByIdAuditLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedAuditLogResponseModel>>; /** */ getDocumentByIdAuditLog(requestParameters: GetDocumentByIdAuditLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedAuditLogResponseModel>; /** */ getDocumentByIdDomainsRaw(requestParameters: GetDocumentByIdDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainsResponseModel>>; /** */ getDocumentByIdDomains(requestParameters: GetDocumentByIdDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainsResponseModel>; /** */ getDocumentByIdNotificationsRaw(requestParameters: GetDocumentByIdNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetDocumentByIdNotifications200ResponseInner>>>; /** */ getDocumentByIdNotifications(requestParameters: GetDocumentByIdNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetDocumentByIdNotifications200ResponseInner>>; /** */ getDocumentByIdPublicAccessRaw(requestParameters: GetDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublicAccessResponseModel>>; /** */ getDocumentByIdPublicAccess(requestParameters: GetDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublicAccessResponseModel>; /** */ getDocumentByIdPublishWithDescendantsResultByTaskIdRaw(requestParameters: GetDocumentByIdPublishWithDescendantsResultByTaskIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublishWithDescendantsResultModel>>; /** */ getDocumentByIdPublishWithDescendantsResultByTaskId(requestParameters: GetDocumentByIdPublishWithDescendantsResultByTaskIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublishWithDescendantsResultModel>; /** */ getDocumentByIdPublishedRaw(requestParameters: GetDocumentByIdPublishedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublishedDocumentResponseModel>>; /** */ getDocumentByIdPublished(requestParameters: GetDocumentByIdPublishedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublishedDocumentResponseModel>; /** */ getDocumentByIdReferencedByRaw(requestParameters: GetDocumentByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedIReferenceResponseModel>>; /** */ getDocumentByIdReferencedBy(requestParameters: GetDocumentByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedIReferenceResponseModel>; /** */ getDocumentByIdReferencedDescendantsRaw(requestParameters: GetDocumentByIdReferencedDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedReferenceByIdModel>>; /** */ getDocumentByIdReferencedDescendants(requestParameters: GetDocumentByIdReferencedDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedReferenceByIdModel>; /** */ getDocumentConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentConfigurationResponseModel>>; /** */ getDocumentConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentConfigurationResponseModel>; /** */ getDocumentUrlsRaw(requestParameters: GetDocumentUrlsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetDocumentUrls200ResponseInner>>>; /** */ getDocumentUrls(requestParameters?: GetDocumentUrlsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetDocumentUrls200ResponseInner>>; /** */ getItemDocumentRaw(requestParameters: GetItemDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemDocument200ResponseInner>>>; /** */ getItemDocument(requestParameters?: GetItemDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemDocument200ResponseInner>>; /** */ getItemDocumentSearchRaw(requestParameters: GetItemDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelDocumentItemResponseModel>>; /** */ getItemDocumentSearch(requestParameters?: GetItemDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelDocumentItemResponseModel>; /** */ getRecycleBinDocumentByIdOriginalParentRaw(requestParameters: GetRecycleBinDocumentByIdOriginalParentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferenceByIdModel>>; /** */ getRecycleBinDocumentByIdOriginalParent(requestParameters: GetRecycleBinDocumentByIdOriginalParentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferenceByIdModel>; /** */ getRecycleBinDocumentChildrenRaw(requestParameters: GetRecycleBinDocumentChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentRecycleBinItemResponseModel>>; /** */ getRecycleBinDocumentChildren(requestParameters?: GetRecycleBinDocumentChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentRecycleBinItemResponseModel>; /** */ getRecycleBinDocumentReferencedByRaw(requestParameters: GetRecycleBinDocumentReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedIReferenceResponseModel>>; /** */ getRecycleBinDocumentReferencedBy(requestParameters?: GetRecycleBinDocumentReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedIReferenceResponseModel>; /** */ getRecycleBinDocumentRootRaw(requestParameters: GetRecycleBinDocumentRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentRecycleBinItemResponseModel>>; /** */ getRecycleBinDocumentRoot(requestParameters?: GetRecycleBinDocumentRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentRecycleBinItemResponseModel>; /** */ getTreeDocumentAncestorsRaw(requestParameters: GetTreeDocumentAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetTreeDocumentAncestors200ResponseInner>>>; /** */ getTreeDocumentAncestors(requestParameters?: GetTreeDocumentAncestorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetTreeDocumentAncestors200ResponseInner>>; /** */ getTreeDocumentChildrenRaw(requestParameters: GetTreeDocumentChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentTreeItemResponseModel>>; /** */ getTreeDocumentChildren(requestParameters?: GetTreeDocumentChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentTreeItemResponseModel>; /** */ getTreeDocumentRootRaw(requestParameters: GetTreeDocumentRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedDocumentTreeItemResponseModel>>; /** */ getTreeDocumentRoot(requestParameters?: GetTreeDocumentRootRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedDocumentTreeItemResponseModel>; /** */ postDocumentRaw(requestParameters: PostDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ postDocument(requestParameters?: PostDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ postDocumentByIdCopyRaw(requestParameters: PostDocumentByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ postDocumentByIdCopy(requestParameters: PostDocumentByIdCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ postDocumentByIdPublicAccessRaw(requestParameters: PostDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ postDocumentByIdPublicAccess(requestParameters: PostDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ postDocumentValidateRaw(requestParameters: PostDocumentValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ postDocumentValidate(requestParameters?: PostDocumentValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdRaw(requestParameters: PutDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentById(requestParameters: PutDocumentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdDomainsRaw(requestParameters: PutDocumentByIdDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentByIdDomains(requestParameters: PutDocumentByIdDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdMoveRaw(requestParameters: PutDocumentByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentByIdMove(requestParameters: PutDocumentByIdMoveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdMoveToRecycleBinRaw(requestParameters: PutDocumentByIdMoveToRecycleBinRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentByIdMoveToRecycleBin(requestParameters: PutDocumentByIdMoveToRecycleBinRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdNotificationsRaw(requestParameters: PutDocumentByIdNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentByIdNotifications(requestParameters: PutDocumentByIdNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdPublicAccessRaw(requestParameters: PutDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentByIdPublicAccess(requestParameters: PutDocumentByIdPublicAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdPublishRaw(requestParameters: PutDocumentByIdPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentByIdPublish(requestParameters: PutDocumentByIdPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentByIdPublishWithDescendantsRaw(requestParameters: PutDocumentByIdPublishWithDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublishWithDescendantsResultModel>>; /** */ putDocumentByIdPublishWithDescendants(requestParameters: PutDocumentByIdPublishWithDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublishWithDescendantsResultModel>; /** */ putDocumentByIdUnpublishRaw(requestParameters: PutDocumentByIdUnpublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentByIdUnpublish(requestParameters: PutDocumentByIdUnpublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putDocumentSortRaw(requestParameters: PutDocumentSortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putDocumentSort(requestParameters?: PutDocumentSortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putRecycleBinDocumentByIdRestoreRaw(requestParameters: PutRecycleBinDocumentByIdRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putRecycleBinDocumentByIdRestore(requestParameters: PutRecycleBinDocumentByIdRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; /** */ putUmbracoManagementApiV11DocumentByIdValidate11Raw(requestParameters: PutUmbracoManagementApiV11DocumentByIdValidate11Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>; /** */ putUmbracoManagementApiV11DocumentByIdValidate11(requestParameters: PutUmbracoManagementApiV11DocumentByIdValidate11Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>; }