File methods: update, delete

Reference for File, one group of File methods.

File.update

Changes the given properties of a File. Verb page.

TypeScript

interface FileVerbs {
  update(input: FileUpdateInput, options?: SB.CallOptions): SB.Call<File>
}

Emits File.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the File.
`contentType`	`string`		The media type, such as `application/pdf`.
`size`	`integer`		The size in bytes.
`name`	`string`		The file name it was uploaded with.
`visibility`	`string`		Who may read it: `Owner`, `Customer`, or `Public`. The default is `Owner`.

Returns

Output	Type	Required	Description
`file`	File	required	The File.

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 file = await $.File.update({ id: 'file_V1AuhyCTsH', size: 1 })

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

TypeScript

interface FileVerbs {
  delete(input: FileDeleteInput, options?: SB.CallOptions): SB.Call<File>
}

Emits File.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`file`	File	required	The File.

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 file = await $.File.delete({ id: 'file_V1AuhyCTsH' })