Skip to main content

@dialstack/sdk / server / FileObject

Interface: FileObject

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

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/src/server/index.ts:863


filename

TypeScript
filename: string | null;

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


id

TypeScript
id: string;

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


mime_type

TypeScript
mime_type: string;

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


object

TypeScript
object: "file";

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


purpose

TypeScript
purpose: string;

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

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


size

TypeScript
size: number;

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

Size in bytes.


type

TypeScript
type: string | null;

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

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


updated_at

TypeScript
updated_at: string;

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


url

TypeScript
url: string | null;

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

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