Class DocumentService

Index

Constructors

Properties

Methods

deleteDocumentById deleteDocumentByIdPublicAccess deleteRecycleBinDocument deleteRecycleBinDocumentById getCollectionDocumentById getDocumentAreReferenced getDocumentById getDocumentByIdAuditLog getDocumentByIdAvailableSegmentOptions getDocumentByIdDomains getDocumentByIdNotifications getDocumentByIdPreviewUrl getDocumentByIdPublicAccess getDocumentByIdPublished getDocumentByIdPublishWithDescendantsResultByTaskId getDocumentByIdReferencedBy getDocumentByIdReferencedDescendants getDocumentConfiguration getDocumentUrls getItemDocument getItemDocumentAncestors getItemDocumentSearch getRecycleBinDocumentByIdOriginalParent getRecycleBinDocumentChildren getRecycleBinDocumentReferencedBy getRecycleBinDocumentRoot getRecycleBinDocumentSiblings getTreeDocumentAncestors getTreeDocumentChildren getTreeDocumentRoot getTreeDocumentSiblings patchDocumentByIdPatch postDocument postDocumentByIdCopy postDocumentByIdPublicAccess postDocumentCreateAndPublish postDocumentValidate putDocumentById putDocumentByIdDomains putDocumentByIdMove putDocumentByIdMoveToRecycleBin putDocumentByIdNotifications putDocumentByIdPublicAccess putDocumentByIdPublish putDocumentByIdPublishWithDescendants putDocumentByIdSortChildren putDocumentByIdUnpublish putDocumentByIdUpdateAndPublish putDocumentRootSortChildren putDocumentSort putRecycleBinDocumentByIdRestore

Constructors

constructor

new DocumentService(): DocumentService
Returns DocumentService

Properties

`Static`putUmbracoManagementApiV1

putUmbracoManagementApiV1: typeof PutUmbracoManagementApiV1 = PutUmbracoManagementApiV1

Methods

`Static`deleteDocumentById

deleteDocumentById<ThrowOnError extends boolean = true>(
    options: Options<DeleteDocumentByIdData, ThrowOnError>,
): RequestResult<
    DeleteDocumentByIdResponses,
    DeleteDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a document.

Deletes a document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteDocumentByIdData, ThrowOnError>
Returns RequestResult<
    DeleteDocumentByIdResponses,
    DeleteDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:605

`Static`deleteDocumentByIdPublicAccess

deleteDocumentByIdPublicAccess<ThrowOnError extends boolean = true>(
    options: Options<DeleteDocumentByIdPublicAccessData, ThrowOnError>,
): RequestResult<
    DeleteDocumentByIdPublicAccessResponses,
    DeleteDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
Removes public access settings for a document.

Removes public access protection/rules for the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteDocumentByIdPublicAccessData, ThrowOnError>
Returns RequestResult<
    DeleteDocumentByIdPublicAccessResponses,
    DeleteDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:809

`Static`deleteRecycleBinDocument

deleteRecycleBinDocument<ThrowOnError extends boolean = true>(
    options?: Options<DeleteRecycleBinDocumentData, ThrowOnError, unknown>,
): RequestResult<
    DeleteRecycleBinDocumentResponses,
    DeleteRecycleBinDocumentErrors,
    ThrowOnError,
    "fields",
>
Empties the document recycle bin.

Permanently deletes all documents in the recycle bin. This operation cannot be undone.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<DeleteRecycleBinDocumentData, ThrowOnError, unknown>
Returns RequestResult<
    DeleteRecycleBinDocumentResponses,
    DeleteRecycleBinDocumentErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1152

`Static`deleteRecycleBinDocumentById

deleteRecycleBinDocumentById<ThrowOnError extends boolean = true>(
    options: Options<DeleteRecycleBinDocumentByIdData, ThrowOnError>,
): RequestResult<
    DeleteRecycleBinDocumentByIdResponses,
    DeleteRecycleBinDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a document.

Deletes a document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteRecycleBinDocumentByIdData, ThrowOnError>
Returns RequestResult<
    DeleteRecycleBinDocumentByIdResponses,
    DeleteRecycleBinDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1165

`Static`getCollectionDocumentById

getCollectionDocumentById<ThrowOnError extends boolean = true>(
    options: Options<GetCollectionDocumentByIdData, ThrowOnError>,
): RequestResult<
    GetCollectionDocumentByIdResponses,
    GetCollectionDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a document collection.

Gets a document collection identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetCollectionDocumentByIdData, ThrowOnError>
Returns RequestResult<
    GetCollectionDocumentByIdResponses,
    GetCollectionDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:575

`Static`getDocumentAreReferenced

getDocumentAreReferenced<ThrowOnError extends boolean = true>(
    options?: Options<GetDocumentAreReferencedData, ThrowOnError, unknown>,
): RequestResult<
    GetDocumentAreReferencedResponses,
    GetDocumentAreReferencedErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of items that reference documents.

Gets a paginated collection of items that reference the documents identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetDocumentAreReferencedData, ThrowOnError, unknown>
Returns RequestResult<
    GetDocumentAreReferencedResponses,
    GetDocumentAreReferencedErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1006

`Static`getDocumentById

getDocumentById<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdResponses,
    GetDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a document.

Gets a document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdResponses,
    GetDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:618

`Static`getDocumentByIdAuditLog

getDocumentByIdAuditLog<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdAuditLogData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdAuditLogResponses,
    GetDocumentByIdAuditLogErrors,
    ThrowOnError,
    "fields",
>
Gets the audit log for a document.

Gets a paginated collection of audit log entries for the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdAuditLogData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdAuditLogResponses,
    GetDocumentByIdAuditLogErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:648

`Static`getDocumentByIdAvailableSegmentOptions

getDocumentByIdAvailableSegmentOptions<ThrowOnError extends boolean = true>(
    options: Options<
        GetDocumentByIdAvailableSegmentOptionsData,
        ThrowOnError,
    >,
): RequestResult<
    GetDocumentByIdAvailableSegmentOptionsResponses,
    GetDocumentByIdAvailableSegmentOptionsErrors,
    ThrowOnError,
    "fields",
>
Gets available segments.

Gets a collection of available content segments for the system.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdAvailableSegmentOptionsData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdAvailableSegmentOptionsResponses,
    GetDocumentByIdAvailableSegmentOptionsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:661

`Static`getDocumentByIdDomains

getDocumentByIdDomains<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdDomainsData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdDomainsResponses,
    GetDocumentByIdDomainsErrors,
    ThrowOnError,
    "fields",
>
Gets domains for a document.

Gets the domains and culture settings assigned to the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdDomainsData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdDomainsResponses,
    GetDocumentByIdDomainsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:691

`Static`getDocumentByIdNotifications

getDocumentByIdNotifications<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdNotificationsData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdNotificationsResponses,
    GetDocumentByIdNotificationsErrors,
    ThrowOnError,
    "fields",
>
Gets notifications for a document.

Gets the notifications for the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdNotificationsData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdNotificationsResponses,
    GetDocumentByIdNotificationsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:751

`Static`getDocumentByIdPreviewUrl

getDocumentByIdPreviewUrl<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdPreviewUrlData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdPreviewUrlResponses,
    GetDocumentByIdPreviewUrlErrors,
    ThrowOnError,
    "fields",
>
Gets the preview URL for a document.

Gets the preview URL for the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdPreviewUrlData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdPreviewUrlResponses,
    GetDocumentByIdPreviewUrlErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:796

`Static`getDocumentByIdPublicAccess

getDocumentByIdPublicAccess<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdPublicAccessData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdPublicAccessResponses,
    GetDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
Gets public access rules for a document.

Gets the public access protection settings for the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdPublicAccessData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdPublicAccessResponses,
    GetDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:822

`Static`getDocumentByIdPublished

getDocumentByIdPublished<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdPublishedData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdPublishedResponses,
    GetDocumentByIdPublishedErrors,
    ThrowOnError,
    "fields",
>
Gets a document.

Gets a document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdPublishedData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdPublishedResponses,
    GetDocumentByIdPublishedErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:916

`Static`getDocumentByIdPublishWithDescendantsResultByTaskId

getDocumentByIdPublishWithDescendantsResultByTaskId<
    ThrowOnError extends boolean = true,
>(
    options: Options<
        GetDocumentByIdPublishWithDescendantsResultByTaskIdData,
        ThrowOnError,
    >,
): RequestResult<
    GetDocumentByIdPublishWithDescendantsResultByTaskIdResponses,
    GetDocumentByIdPublishWithDescendantsResultByTaskIdErrors,
    ThrowOnError,
    "fields",
>
Gets the result of publishing a document with descendants.

Gets the status and result of a publish with descendants operation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdPublishWithDescendantsResultByTaskIdData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdPublishWithDescendantsResultByTaskIdResponses,
    GetDocumentByIdPublishWithDescendantsResultByTaskIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:903

`Static`getDocumentByIdReferencedBy

getDocumentByIdReferencedBy<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdReferencedByData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdReferencedByResponses,
    GetDocumentByIdReferencedByErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of items that reference documents.

Gets a paginated collection of items that reference the documents identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdReferencedByData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdReferencedByResponses,
    GetDocumentByIdReferencedByErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:929

`Static`getDocumentByIdReferencedDescendants

getDocumentByIdReferencedDescendants<ThrowOnError extends boolean = true>(
    options: Options<GetDocumentByIdReferencedDescendantsData, ThrowOnError>,
): RequestResult<
    GetDocumentByIdReferencedDescendantsResponses,
    GetDocumentByIdReferencedDescendantsErrors,
    ThrowOnError,
    "fields",
>
Gets document descendants that are referenced.

Gets a paginated collection of descendant documents that are referenced by other content.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentByIdReferencedDescendantsData, ThrowOnError>
Returns RequestResult<
    GetDocumentByIdReferencedDescendantsResponses,
    GetDocumentByIdReferencedDescendantsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:942

`Static`getDocumentConfiguration

getDocumentConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetDocumentConfigurationData, ThrowOnError, unknown>,
): RequestResult<
    GetDocumentConfigurationResponses,
    GetDocumentConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the document configuration.

Gets the configuration settings for documents.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetDocumentConfigurationData, ThrowOnError, unknown>
Returns RequestResult<
    GetDocumentConfigurationResponses,
    GetDocumentConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1019

`Static`getDocumentUrls

getDocumentUrls<ThrowOnError extends boolean = true>(
    options?: Options<GetDocumentUrlsData, ThrowOnError, unknown>,
): RequestResult<
    GetDocumentUrlsResponses,
    GetDocumentUrlsErrors,
    ThrowOnError,
    "fields",
>
Gets URLs for a document.

Gets the URLs for the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetDocumentUrlsData, ThrowOnError, unknown>
Returns RequestResult<
    GetDocumentUrlsResponses,
    GetDocumentUrlsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1083

`Static`getItemDocument

getItemDocument<ThrowOnError extends boolean = true>(
    options?: Options<GetItemDocumentData, ThrowOnError, unknown>,
): RequestResult<
    GetItemDocumentResponses,
    GetItemDocumentErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of document items.

Gets a collection of document items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemDocumentData, ThrowOnError, unknown>
Returns RequestResult<
    GetItemDocumentResponses,
    GetItemDocumentErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1113

`Static`getItemDocumentAncestors

getItemDocumentAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetItemDocumentAncestorsData, ThrowOnError, unknown>,
): RequestResult<
    GetItemDocumentAncestorsResponses,
    GetItemDocumentAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets ancestors for a collection of document items.

Gets the ancestor chains for document items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemDocumentAncestorsData, ThrowOnError, unknown>
Returns RequestResult<
    GetItemDocumentAncestorsResponses,
    GetItemDocumentAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1126

`Static`getItemDocumentSearch

getItemDocumentSearch<ThrowOnError extends boolean = true>(
    options?: Options<GetItemDocumentSearchData, ThrowOnError, unknown>,
): RequestResult<
    GetItemDocumentSearchResponses,
    GetItemDocumentSearchErrors,
    ThrowOnError,
    "fields",
>
Searches document items.

Searches document items by the provided query with pagination support.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemDocumentSearchData, ThrowOnError, unknown>
Returns RequestResult<
    GetItemDocumentSearchResponses,
    GetItemDocumentSearchErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1139

`Static`getRecycleBinDocumentByIdOriginalParent

getRecycleBinDocumentByIdOriginalParent<ThrowOnError extends boolean = true>(
    options: Options<
        GetRecycleBinDocumentByIdOriginalParentData,
        ThrowOnError,
    >,
): RequestResult<
    GetRecycleBinDocumentByIdOriginalParentResponses,
    GetRecycleBinDocumentByIdOriginalParentErrors,
    ThrowOnError,
    "fields",
>
Gets the original parent of a document in the recycle bin.

Gets the original parent location of a document before it was moved to the recycle bin.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetRecycleBinDocumentByIdOriginalParentData, ThrowOnError>
Returns RequestResult<
    GetRecycleBinDocumentByIdOriginalParentResponses,
    GetRecycleBinDocumentByIdOriginalParentErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1178

`Static`getRecycleBinDocumentChildren

getRecycleBinDocumentChildren<ThrowOnError extends boolean = true>(
    options?: Options<
        GetRecycleBinDocumentChildrenData,
        ThrowOnError,
        unknown,
    >,
): RequestResult<
    GetRecycleBinDocumentChildrenResponses,
    GetRecycleBinDocumentChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of documents in the recycle bin.

Gets a paginated collection of documents that are children of the provided parent in the recycle bin.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetRecycleBinDocumentChildrenData, ThrowOnError, unknown>
Returns RequestResult<
    GetRecycleBinDocumentChildrenResponses,
    GetRecycleBinDocumentChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1208

`Static`getRecycleBinDocumentReferencedBy

getRecycleBinDocumentReferencedBy<ThrowOnError extends boolean = true>(
    options?: Options<
        GetRecycleBinDocumentReferencedByData,
        ThrowOnError,
        unknown,
    >,
): RequestResult<
    GetRecycleBinDocumentReferencedByResponses,
    GetRecycleBinDocumentReferencedByErrors,
    ThrowOnError,
    "fields",
>
Gets items referencing a document in the recycle bin.

Gets a paginated collection of items that reference the document in the recycle bin.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetRecycleBinDocumentReferencedByData, ThrowOnError, unknown>
Returns RequestResult<
    GetRecycleBinDocumentReferencedByResponses,
    GetRecycleBinDocumentReferencedByErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1221

`Static`getRecycleBinDocumentRoot

getRecycleBinDocumentRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetRecycleBinDocumentRootData, ThrowOnError, unknown>,
): RequestResult<
    GetRecycleBinDocumentRootResponses,
    GetRecycleBinDocumentRootErrors,
    ThrowOnError,
    "fields",
>
Gets documents at the root of the recycle bin.

Gets a paginated collection of documents at the root level of the recycle bin.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetRecycleBinDocumentRootData, ThrowOnError, unknown>
Returns RequestResult<
    GetRecycleBinDocumentRootResponses,
    GetRecycleBinDocumentRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1234

`Static`getRecycleBinDocumentSiblings

getRecycleBinDocumentSiblings<ThrowOnError extends boolean = true>(
    options?: Options<
        GetRecycleBinDocumentSiblingsData,
        ThrowOnError,
        unknown,
    >,
): RequestResult<
    GetRecycleBinDocumentSiblingsResponses,
    GetRecycleBinDocumentSiblingsErrors,
    ThrowOnError,
    "fields",
>
Gets sibling documents in the recycle bin.

Gets a collection of sibling documents in the recycle bin at the same level as the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetRecycleBinDocumentSiblingsData, ThrowOnError, unknown>
Returns RequestResult<
    GetRecycleBinDocumentSiblingsResponses,
    GetRecycleBinDocumentSiblingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1247

`Static`getTreeDocumentAncestors

getTreeDocumentAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDocumentAncestorsData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeDocumentAncestorsResponses,
    GetTreeDocumentAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of ancestor document items.

Gets a collection of document items that are ancestors to the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDocumentAncestorsData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeDocumentAncestorsResponses,
    GetTreeDocumentAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1260

`Static`getTreeDocumentChildren

getTreeDocumentChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDocumentChildrenData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeDocumentChildrenResponses,
    GetTreeDocumentChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of document tree child items.

Gets a paginated collection of document tree items that are children of the provided parent Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDocumentChildrenData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeDocumentChildrenResponses,
    GetTreeDocumentChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1273

`Static`getTreeDocumentRoot

getTreeDocumentRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDocumentRootData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeDocumentRootResponses,
    GetTreeDocumentRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of document items from the root of the tree.

Gets a paginated collection of document items from the root of the tree with optional filtering.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDocumentRootData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeDocumentRootResponses,
    GetTreeDocumentRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1286

`Static`getTreeDocumentSiblings

getTreeDocumentSiblings<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDocumentSiblingsData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeDocumentSiblingsResponses,
    GetTreeDocumentSiblingsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of document tree sibling items.

Gets a collection of document tree items that are siblings of the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDocumentSiblingsData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeDocumentSiblingsResponses,
    GetTreeDocumentSiblingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1299

`Static`patchDocumentByIdPatch

patchDocumentByIdPatch<ThrowOnError extends boolean = true>(
    options: Options<PatchDocumentByIdPatchData, ThrowOnError>,
): RequestResult<
    PatchDocumentByIdPatchResponses,
    PatchDocumentByIdPatchErrors,
    ThrowOnError,
    "fields",
>
Make partial updates to a document. For more information, see the documentation at https://docs.umbraco.com/umbraco-cms/reference/management-api/patching/document-endpoint-guide or https://docs.umbraco.com/umbraco-cms/reference/management-api/patching/document-endpoint-spec
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PatchDocumentByIdPatchData, ThrowOnError>
Returns RequestResult<
    PatchDocumentByIdPatchResponses,
    PatchDocumentByIdPatchErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:779

`Static`postDocument

postDocument<ThrowOnError extends boolean = true>(
    options: Options<PostDocumentData, ThrowOnError>,
): RequestResult<
    PostDocumentResponses,
    PostDocumentErrors,
    ThrowOnError,
    "fields",
>
Creates a new document.

Creates a new document with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostDocumentData, ThrowOnError>
Returns RequestResult<PostDocumentResponses, PostDocumentErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:588

`Static`postDocumentByIdCopy

postDocumentByIdCopy<ThrowOnError extends boolean = true>(
    options: Options<PostDocumentByIdCopyData, ThrowOnError>,
): RequestResult<
    PostDocumentByIdCopyResponses,
    PostDocumentByIdCopyErrors,
    ThrowOnError,
    "fields",
>
Copies a document.

Creates a duplicate of an existing document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostDocumentByIdCopyData, ThrowOnError>
Returns RequestResult<
    PostDocumentByIdCopyResponses,
    PostDocumentByIdCopyErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:674

`Static`postDocumentByIdPublicAccess

postDocumentByIdPublicAccess<ThrowOnError extends boolean = true>(
    options: Options<PostDocumentByIdPublicAccessData, ThrowOnError>,
): RequestResult<
    PostDocumentByIdPublicAccessResponses,
    PostDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
Creates public access rules for a document.

Creates public access protection for the document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostDocumentByIdPublicAccessData, ThrowOnError>
Returns RequestResult<
    PostDocumentByIdPublicAccessResponses,
    PostDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:835

`Static`postDocumentCreateAndPublish

postDocumentCreateAndPublish<ThrowOnError extends boolean = true>(
    options: Options<PostDocumentCreateAndPublishData, ThrowOnError>,
): RequestResult<
    PostDocumentCreateAndPublishResponses,
    PostDocumentCreateAndPublishErrors,
    ThrowOnError,
    "fields",
>
Creates and publishes a new document.

Creates and publishes a new document with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostDocumentCreateAndPublishData, ThrowOnError>
Returns RequestResult<
    PostDocumentCreateAndPublishResponses,
    PostDocumentCreateAndPublishErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1032

`Static`postDocumentValidate

postDocumentValidate<ThrowOnError extends boolean = true>(
    options: Options<PostDocumentValidateData, ThrowOnError>,
): RequestResult<
    PostDocumentValidateResponses,
    PostDocumentValidateErrors,
    ThrowOnError,
    "fields",
>
Validates creating a document.

Validates the request model for creating a new document without actually creating it.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostDocumentValidateData, ThrowOnError>
Returns RequestResult<
    PostDocumentValidateResponses,
    PostDocumentValidateErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1096

`Static`putDocumentById

putDocumentById<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdResponses,
    PutDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a document.

Updates a document identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdResponses,
    PutDocumentByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:631

`Static`putDocumentByIdDomains

putDocumentByIdDomains<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdDomainsData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdDomainsResponses,
    PutDocumentByIdDomainsErrors,
    ThrowOnError,
    "fields",
>
Updates the domains for a document.

Updates the domains for the document identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdDomainsData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdDomainsResponses,
    PutDocumentByIdDomainsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:704

`Static`putDocumentByIdMove

putDocumentByIdMove<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdMoveData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdMoveResponses,
    PutDocumentByIdMoveErrors,
    ThrowOnError,
    "fields",
>
Moves a document.

Moves a document identified by the provided Id to a different location.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdMoveData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdMoveResponses,
    PutDocumentByIdMoveErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:721

`Static`putDocumentByIdMoveToRecycleBin

putDocumentByIdMoveToRecycleBin<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdMoveToRecycleBinData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdMoveToRecycleBinResponses,
    PutDocumentByIdMoveToRecycleBinErrors,
    ThrowOnError,
    "fields",
>
Moves a document to the recycle bin.

Moves a document identified by the provided Id to the recycle bin.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdMoveToRecycleBinData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdMoveToRecycleBinResponses,
    PutDocumentByIdMoveToRecycleBinErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:738

`Static`putDocumentByIdNotifications

putDocumentByIdNotifications<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdNotificationsData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdNotificationsResponses,
    PutDocumentByIdNotificationsErrors,
    ThrowOnError,
    "fields",
>
Updates notification subscriptions for a document.

Updates which actions the current user is subscribed to receive notifications for on the specified document.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdNotificationsData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdNotificationsResponses,
    PutDocumentByIdNotificationsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:764

`Static`putDocumentByIdPublicAccess

putDocumentByIdPublicAccess<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdPublicAccessData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdPublicAccessResponses,
    PutDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
Updates public access protection for a document.

Updates the member protection settings for a document, controlling which members or member groups can access it.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdPublicAccessData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdPublicAccessResponses,
    PutDocumentByIdPublicAccessErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:852

`Static`putDocumentByIdPublish

putDocumentByIdPublish<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdPublishData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdPublishResponses,
    PutDocumentByIdPublishErrors,
    ThrowOnError,
    "fields",
>
Publishes a document.

Publishes a document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdPublishData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdPublishResponses,
    PutDocumentByIdPublishErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:869

`Static`putDocumentByIdPublishWithDescendants

putDocumentByIdPublishWithDescendants<ThrowOnError extends boolean = true>(
    options: Options<
        PutDocumentByIdPublishWithDescendantsData,
        ThrowOnError,
    >,
): RequestResult<
    PutDocumentByIdPublishWithDescendantsResponses,
    PutDocumentByIdPublishWithDescendantsErrors,
    ThrowOnError,
    "fields",
>
Publishes a document with its descendants.

Publishes a document and its descendants identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdPublishWithDescendantsData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdPublishWithDescendantsResponses,
    PutDocumentByIdPublishWithDescendantsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:886

`Static`putDocumentByIdSortChildren

putDocumentByIdSortChildren<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdSortChildrenData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdSortChildrenResponses,
    PutDocumentByIdSortChildrenErrors,
    ThrowOnError,
    "fields",
>
Sorts the children of a document by a field.

Sorts the children of the specified parent document by a system field in the given direction. When sorting by name, an optional culture selects the variant name; the culture is not validated, so children that do not vary by it (or an unrecognised culture) fall back to the invariant name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdSortChildrenData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdSortChildrenResponses,
    PutDocumentByIdSortChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:955

`Static`putDocumentByIdUnpublish

putDocumentByIdUnpublish<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdUnpublishData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdUnpublishResponses,
    PutDocumentByIdUnpublishErrors,
    ThrowOnError,
    "fields",
>
Unpublishes a document.

Unpublishes a document identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdUnpublishData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdUnpublishResponses,
    PutDocumentByIdUnpublishErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:972

`Static`putDocumentByIdUpdateAndPublish

putDocumentByIdUpdateAndPublish<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentByIdUpdateAndPublishData, ThrowOnError>,
): RequestResult<
    PutDocumentByIdUpdateAndPublishResponses,
    PutDocumentByIdUpdateAndPublishErrors,
    ThrowOnError,
    "fields",
>
Updates and publishes a document.

Updates and publishes a document identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentByIdUpdateAndPublishData, ThrowOnError>
Returns RequestResult<
    PutDocumentByIdUpdateAndPublishResponses,
    PutDocumentByIdUpdateAndPublishErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:989

`Static`putDocumentRootSortChildren

putDocumentRootSortChildren<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentRootSortChildrenData, ThrowOnError>,
): RequestResult<
    PutDocumentRootSortChildrenResponses,
    PutDocumentRootSortChildrenErrors,
    ThrowOnError,
    "fields",
>
Sorts the root-level documents by a field.

Sorts the root-level documents by a system field in the given direction. When sorting by name, an optional culture selects the variant name; the culture is not validated, so documents that do not vary by it (or an unrecognised culture) fall back to the invariant name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentRootSortChildrenData, ThrowOnError>
Returns RequestResult<
    PutDocumentRootSortChildrenResponses,
    PutDocumentRootSortChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1049

`Static`putDocumentSort

putDocumentSort<ThrowOnError extends boolean = true>(
    options: Options<PutDocumentSortData, ThrowOnError>,
): RequestResult<
    PutDocumentSortResponses,
    PutDocumentSortErrors,
    ThrowOnError,
    "fields",
>
Sorts documents.

Sorts documents in the specified parent container according to the provided sort order.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentSortData, ThrowOnError>
Returns RequestResult<
    PutDocumentSortResponses,
    PutDocumentSortErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1066

`Static`putRecycleBinDocumentByIdRestore

putRecycleBinDocumentByIdRestore<ThrowOnError extends boolean = true>(
    options: Options<PutRecycleBinDocumentByIdRestoreData, ThrowOnError>,
): RequestResult<
    PutRecycleBinDocumentByIdRestoreResponses,
    PutRecycleBinDocumentByIdRestoreErrors,
    ThrowOnError,
    "fields",
>
Restores a document from the recycle bin.

Restores a document from the recycle bin to its original location or a specified parent.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutRecycleBinDocumentByIdRestoreData, ThrowOnError>
Returns RequestResult<
    PutRecycleBinDocumentByIdRestoreResponses,
    PutRecycleBinDocumentByIdRestoreErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:1191

Class DocumentService

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DocumentService

Properties

StaticputUmbracoManagementApiV1

Methods

StaticdeleteDocumentById

Type Parameters

Parameters

Returns RequestResult< DeleteDocumentByIdResponses, DeleteDocumentByIdErrors, ThrowOnError, "fields",>

StaticdeleteDocumentByIdPublicAccess

Type Parameters

Parameters

Returns RequestResult< DeleteDocumentByIdPublicAccessResponses, DeleteDocumentByIdPublicAccessErrors, ThrowOnError, "fields",>

StaticdeleteRecycleBinDocument

Type Parameters

Parameters

Returns RequestResult< DeleteRecycleBinDocumentResponses, DeleteRecycleBinDocumentErrors, ThrowOnError, "fields",>

StaticdeleteRecycleBinDocumentById

Type Parameters

Parameters

Returns RequestResult< DeleteRecycleBinDocumentByIdResponses, DeleteRecycleBinDocumentByIdErrors, ThrowOnError, "fields",>

StaticgetCollectionDocumentById

Type Parameters

Parameters

Returns RequestResult< GetCollectionDocumentByIdResponses, GetCollectionDocumentByIdErrors, ThrowOnError, "fields",>

StaticgetDocumentAreReferenced

Type Parameters

Parameters

Returns RequestResult< GetDocumentAreReferencedResponses, GetDocumentAreReferencedErrors, ThrowOnError, "fields",>

StaticgetDocumentById

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdResponses, GetDocumentByIdErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdAuditLog

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdAuditLogResponses, GetDocumentByIdAuditLogErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdAvailableSegmentOptions

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdAvailableSegmentOptionsResponses, GetDocumentByIdAvailableSegmentOptionsErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdDomains

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdDomainsResponses, GetDocumentByIdDomainsErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdNotifications

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdNotificationsResponses, GetDocumentByIdNotificationsErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdPreviewUrl

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdPreviewUrlResponses, GetDocumentByIdPreviewUrlErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdPublicAccess

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdPublicAccessResponses, GetDocumentByIdPublicAccessErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdPublished

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdPublishedResponses, GetDocumentByIdPublishedErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdPublishWithDescendantsResultByTaskId

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdPublishWithDescendantsResultByTaskIdResponses, GetDocumentByIdPublishWithDescendantsResultByTaskIdErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdReferencedBy

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdReferencedByResponses, GetDocumentByIdReferencedByErrors, ThrowOnError, "fields",>

StaticgetDocumentByIdReferencedDescendants

Type Parameters

Parameters

Returns RequestResult< GetDocumentByIdReferencedDescendantsResponses, GetDocumentByIdReferencedDescendantsErrors, ThrowOnError, "fields",>

StaticgetDocumentConfiguration

`Static`putUmbracoManagementApiV1

`Static`deleteDocumentById

Returns RequestResult<
DeleteDocumentByIdResponses,
DeleteDocumentByIdErrors,
ThrowOnError,
"fields",
>

`Static`deleteDocumentByIdPublicAccess

Returns RequestResult<
DeleteDocumentByIdPublicAccessResponses,
DeleteDocumentByIdPublicAccessErrors,
ThrowOnError,
"fields",
>

`Static`deleteRecycleBinDocument

Returns RequestResult<
DeleteRecycleBinDocumentResponses,
DeleteRecycleBinDocumentErrors,
ThrowOnError,
"fields",
>

`Static`deleteRecycleBinDocumentById

Returns RequestResult<
DeleteRecycleBinDocumentByIdResponses,
DeleteRecycleBinDocumentByIdErrors,
ThrowOnError,
"fields",
>

`Static`getCollectionDocumentById

Returns RequestResult<
GetCollectionDocumentByIdResponses,
GetCollectionDocumentByIdErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentAreReferenced

Returns RequestResult<
GetDocumentAreReferencedResponses,
GetDocumentAreReferencedErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentById

Returns RequestResult<
GetDocumentByIdResponses,
GetDocumentByIdErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdAuditLog

Returns RequestResult<
GetDocumentByIdAuditLogResponses,
GetDocumentByIdAuditLogErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdAvailableSegmentOptions

Returns RequestResult<
GetDocumentByIdAvailableSegmentOptionsResponses,
GetDocumentByIdAvailableSegmentOptionsErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdDomains

Returns RequestResult<
GetDocumentByIdDomainsResponses,
GetDocumentByIdDomainsErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdNotifications

Returns RequestResult<
GetDocumentByIdNotificationsResponses,
GetDocumentByIdNotificationsErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdPreviewUrl

Returns RequestResult<
GetDocumentByIdPreviewUrlResponses,
GetDocumentByIdPreviewUrlErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdPublicAccess

Returns RequestResult<
GetDocumentByIdPublicAccessResponses,
GetDocumentByIdPublicAccessErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdPublished

Returns RequestResult<
GetDocumentByIdPublishedResponses,
GetDocumentByIdPublishedErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdPublishWithDescendantsResultByTaskId

Returns RequestResult<
GetDocumentByIdPublishWithDescendantsResultByTaskIdResponses,
GetDocumentByIdPublishWithDescendantsResultByTaskIdErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdReferencedBy

Returns RequestResult<
GetDocumentByIdReferencedByResponses,
GetDocumentByIdReferencedByErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentByIdReferencedDescendants

Returns RequestResult<
GetDocumentByIdReferencedDescendantsResponses,
GetDocumentByIdReferencedDescendantsErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentConfiguration

Returns RequestResult<
GetDocumentConfigurationResponses,
GetDocumentConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`getDocumentUrls

Returns RequestResult<
GetDocumentUrlsResponses,
GetDocumentUrlsErrors,
ThrowOnError,
"fields",
>

`Static`getItemDocument

Returns RequestResult<
GetItemDocumentResponses,
GetItemDocumentErrors,
ThrowOnError,
"fields",
>

`Static`getItemDocumentAncestors

Returns RequestResult<
GetItemDocumentAncestorsResponses,
GetItemDocumentAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getItemDocumentSearch

Returns RequestResult<
GetItemDocumentSearchResponses,
GetItemDocumentSearchErrors,
ThrowOnError,
"fields",
>

`Static`getRecycleBinDocumentByIdOriginalParent

Returns RequestResult<
GetRecycleBinDocumentByIdOriginalParentResponses,
GetRecycleBinDocumentByIdOriginalParentErrors,
ThrowOnError,
"fields",
>

`Static`getRecycleBinDocumentChildren

Returns RequestResult<
GetRecycleBinDocumentChildrenResponses,
GetRecycleBinDocumentChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getRecycleBinDocumentReferencedBy

Returns RequestResult<
GetRecycleBinDocumentReferencedByResponses,
GetRecycleBinDocumentReferencedByErrors,
ThrowOnError,
"fields",
>

`Static`getRecycleBinDocumentRoot

Returns RequestResult<
GetRecycleBinDocumentRootResponses,
GetRecycleBinDocumentRootErrors,
ThrowOnError,
"fields",
>

`Static`getRecycleBinDocumentSiblings

Returns RequestResult<
GetRecycleBinDocumentSiblingsResponses,
GetRecycleBinDocumentSiblingsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeDocumentAncestors

Returns RequestResult<
GetTreeDocumentAncestorsResponses,
GetTreeDocumentAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeDocumentChildren

Returns RequestResult<
GetTreeDocumentChildrenResponses,
GetTreeDocumentChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getTreeDocumentRoot

Returns RequestResult<
GetTreeDocumentRootResponses,
GetTreeDocumentRootErrors,
ThrowOnError,
"fields",
>

`Static`getTreeDocumentSiblings

Returns RequestResult<
GetTreeDocumentSiblingsResponses,
GetTreeDocumentSiblingsErrors,
ThrowOnError,
"fields",
>

`Static`patchDocumentByIdPatch

Returns RequestResult<
PatchDocumentByIdPatchResponses,
PatchDocumentByIdPatchErrors,
ThrowOnError,
"fields",
>

`Static`postDocument

`Static`postDocumentByIdCopy

Returns RequestResult<
PostDocumentByIdCopyResponses,
PostDocumentByIdCopyErrors,
ThrowOnError,
"fields",
>

`Static`postDocumentByIdPublicAccess