Class DocumentService

constructor

• new DocumentService(): DocumentService

  Returns DocumentService

StaticputUmbracoManagementApiV1Service

StaticdeleteDocumentById

• 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",
  >

StaticdeleteDocumentByIdPublicAccess

• 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",
  >

StaticdeleteRecycleBinDocument

• deleteRecycleBinDocument<ThrowOnError extends boolean = true>(
      options?: Options<DeleteRecycleBinDocumentData, ThrowOnError>,
  ): 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>

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

StaticdeleteRecycleBinDocumentById

• 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",
  >

StaticgetCollectionDocumentById

• 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",
  >

StaticgetDocumentAreReferenced

• getDocumentAreReferenced<ThrowOnError extends boolean = true>(
      options?: Options<GetDocumentAreReferencedData, ThrowOnError>,
  ): 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>

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

StaticgetDocumentById

• 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",
  >

StaticgetDocumentByIdAuditLog

• 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",
  >

StaticgetDocumentByIdAvailableSegmentOptions

• 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",
  >

  Deprecated

StaticgetDocumentByIdDomains

• 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",
  >

StaticgetDocumentByIdNotifications

• 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",
  >

StaticgetDocumentByIdPreviewUrl

• 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",
  >

StaticgetDocumentByIdPublicAccess

• 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",
  >

StaticgetDocumentByIdPublished

• 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",
  >

StaticgetDocumentByIdPublishWithDescendantsResultByTaskId

• 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",
  >

StaticgetDocumentByIdReferencedBy

• 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",
  >

StaticgetDocumentByIdReferencedDescendants

• 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",
  >

StaticgetDocumentConfiguration

• getDocumentConfiguration<ThrowOnError extends boolean = true>(
      options?: Options<GetDocumentConfigurationData, ThrowOnError>,
  ): 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>

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

StaticgetDocumentUrls

• getDocumentUrls<ThrowOnError extends boolean = true>(
      options?: Options<GetDocumentUrlsData, ThrowOnError>,
  ): 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>

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

StaticgetItemDocument

• getItemDocument<ThrowOnError extends boolean = true>(
      options?: Options<GetItemDocumentData, ThrowOnError>,
  ): 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>

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

StaticgetItemDocumentAncestors

• getItemDocumentAncestors<ThrowOnError extends boolean = true>(
      options?: Options<GetItemDocumentAncestorsData, ThrowOnError>,
  ): 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>

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

StaticgetItemDocumentSearch

• getItemDocumentSearch<ThrowOnError extends boolean = true>(
      options?: Options<GetItemDocumentSearchData, ThrowOnError>,
  ): 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>

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

StaticgetRecycleBinDocumentByIdOriginalParent

• 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",
  >

StaticgetRecycleBinDocumentChildren

• getRecycleBinDocumentChildren<ThrowOnError extends boolean = true>(
      options?: Options<GetRecycleBinDocumentChildrenData, ThrowOnError>,
  ): 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>

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

StaticgetRecycleBinDocumentReferencedBy

• getRecycleBinDocumentReferencedBy<ThrowOnError extends boolean = true>(
      options?: Options<GetRecycleBinDocumentReferencedByData, ThrowOnError>,
  ): 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>

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

StaticgetRecycleBinDocumentRoot

• getRecycleBinDocumentRoot<ThrowOnError extends boolean = true>(
      options?: Options<GetRecycleBinDocumentRootData, ThrowOnError>,
  ): 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>

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

StaticgetRecycleBinDocumentSiblings

• getRecycleBinDocumentSiblings<ThrowOnError extends boolean = true>(
      options?: Options<GetRecycleBinDocumentSiblingsData, ThrowOnError>,
  ): 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>

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

StaticgetTreeDocumentAncestors

• getTreeDocumentAncestors<ThrowOnError extends boolean = true>(
      options?: Options<GetTreeDocumentAncestorsData, ThrowOnError>,
  ): 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>

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

StaticgetTreeDocumentChildren

• getTreeDocumentChildren<ThrowOnError extends boolean = true>(
      options?: Options<GetTreeDocumentChildrenData, ThrowOnError>,
  ): 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>

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

StaticgetTreeDocumentRoot

• getTreeDocumentRoot<ThrowOnError extends boolean = true>(
      options?: Options<GetTreeDocumentRootData, ThrowOnError>,
  ): 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>

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

StaticgetTreeDocumentSiblings

• getTreeDocumentSiblings<ThrowOnError extends boolean = true>(
      options?: Options<GetTreeDocumentSiblingsData, ThrowOnError>,
  ): 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>

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

StaticpatchDocumentByIdPatch

• 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",
  >

StaticpostDocument

• 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

  • Optionaloptions: Options<PostDocumentData, ThrowOnError>

  Returns RequestResult<PostDocumentResponses, PostDocumentErrors, ThrowOnError, "fields">

StaticpostDocumentByIdCopy

• 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",
  >

StaticpostDocumentByIdPublicAccess

• 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",
  >

StaticpostDocumentValidate

• 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

  • Optionaloptions: Options<PostDocumentValidateData, ThrowOnError>

  Returns RequestResult<
      PostDocumentValidateResponses,
      PostDocumentValidateErrors,
      ThrowOnError,
      "fields",
  >

StaticputDocumentById

• 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",
  >

StaticputDocumentByIdDomains

• 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",
  >

StaticputDocumentByIdMove

• 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",
  >

StaticputDocumentByIdMoveToRecycleBin

• 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",
  >

StaticputDocumentByIdNotifications

• 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",
  >

StaticputDocumentByIdPublicAccess

• 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",
  >

StaticputDocumentByIdPublish

• 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",
  >

StaticputDocumentByIdPublishWithDescendants

• 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",
  >

StaticputDocumentByIdUnpublish

• 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",
  >

StaticputDocumentSort

• 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

  • Optionaloptions: Options<PutDocumentSortData, ThrowOnError>

  Returns RequestResult<
      PutDocumentSortResponses,
      PutDocumentSortErrors,
      ThrowOnError,
      "fields",
  >

StaticputRecycleBinDocumentByIdRestore

• 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",
  >