Skip to main content

@dialstack/sdk-dev / server/src / FileObject

Interface: FileObject

Defined in: sdk/server/src/index.ts:1161

An uploaded file scoped to an account, returned inline when a resource that references it is expanded (e.g. a fax under expand: ['file']).

Properties​

created_at​

TypeScript
created_at: string;

Defined in: sdk/server/src/index.ts:1177

filename​

TypeScript
filename: string | null;

Defined in: sdk/server/src/index.ts:1166

id​

TypeScript
id: string;

Defined in: sdk/server/src/index.ts:1163

mime_type​

TypeScript
mime_type: string;

Defined in: sdk/server/src/index.ts:1169

object​

TypeScript
object: "file";

Defined in: sdk/server/src/index.ts:1162

purpose​

TypeScript
purpose: string;

Defined in: sdk/server/src/index.ts:1165

What the file is used for, e.g. fax_source.

size​

TypeScript
size: number;

Defined in: sdk/server/src/index.ts:1171

Size in bytes.

type​

TypeScript
type: string | null;

Defined in: sdk/server/src/index.ts:1168

Short type derived from the MIME type (e.g. pdf), or null if unrecognized.

updated_at​

TypeScript
updated_at: string;

Defined in: sdk/server/src/index.ts:1178

url​

TypeScript
url: string | null;

Defined in: sdk/server/src/index.ts:1176

Time-limited signed URL for the file's bytes, populated at response time only. Null unless the file was returned via an expand.

On this page