Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 2.26 KB

trashedWebLinks.md

File metadata and controls

96 lines (61 loc) · 2.26 KB

TrashedWebLinksManager

Restore web link

Restores a web link that has been moved to the trash.

An optional new parent ID can be provided to restore the web link to in case the original folder has been deleted.

This operation is performed by calling function restoreWeblinkFromTrash.

See the endpoint docs at API Reference.

await client.trashedWebLinks.restoreWeblinkFromTrash(weblink.id);

Arguments

  • webLinkId string
    • The ID of the web link. Example: "12345"

  • optionalsInput RestoreWeblinkFromTrashOptionalsInput

Returns

This function returns a value of type TrashWebLinkRestored.

Returns a web link object when it has been restored.

Get trashed web link

Retrieves a web link that has been moved to the trash.

This operation is performed by calling function getTrashedWebLinkById.

See the endpoint docs at API Reference.

await client.trashedWebLinks.getTrashedWebLinkById(weblink.id);

Arguments

  • webLinkId string
    • The ID of the web link. Example: "12345"

  • optionalsInput GetTrashedWebLinkByIdOptionalsInput

Returns

This function returns a value of type TrashWebLink.

Returns the web link that was trashed, including information about when the it was moved to the trash.

Permanently remove web link

Permanently deletes a web link that is in the trash. This action cannot be undone.

This operation is performed by calling function deleteTrashedWebLinkById.

See the endpoint docs at API Reference.

await client.trashedWebLinks.deleteTrashedWebLinkById(weblink.id);

Arguments

  • webLinkId string
    • The ID of the web link. Example: "12345"

  • optionalsInput DeleteTrashedWebLinkByIdOptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when the web link was permanently deleted.