Document methods: update, delete

Reference for Document, one group of Document methods.

Document.update

Changes the given properties of a Document. Verb page.

TypeScript

interface DocumentVerbs {
  update(input: DocumentUpdateInput, options?: SB.CallOptions): SB.Call<Document>
}

Emits Document.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Document.
`form`	`string`		One of `document`, `deck`, or `sheet`.

Returns

Output	Type	Required	Description
`document`	Document	required	The Document.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const document = await $.Document.update({ id: 'document_af2wijcmRy', form: 'document' })

Deletes a Document: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface DocumentVerbs {
  delete(input: DocumentDeleteInput, options?: SB.CallOptions): SB.Call<Document>
}

Emits Document.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Document.

Returns

Output	Type	Required	Description
`document`	Document	required	The Document.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const document = await $.Document.delete({ id: 'document_af2wijcmRy' })