Prepress

Files

Explore the data types and operations available in Files.

86 types · Used in operation arguments and return values.

InboxMessageStatusPageObject

A keyset page of mailbox intake records.

InboxOperationResultObject

Outcome of an inbox runtime command.

InboxOutboundIDScalar

Outbound reply sent from an inbox, prefix ibo.

InboxOutboundStatusObject

Safe outbound status and recipient outcome counts without MIME or recipient addresses.

InboxOutboundStatusPageObject

A keyset page of outbound statuses.

InboxProbeResultObject

Read-only mailbox connection probe.

InboxQuarantineInspectionObject

Raw staged quarantine bytes returned only by a separate audited, permissioned inspection operation.

InboxRetentionPreviewObject

Bounded preview of what retention cleanup would remove or keep.

InboxSenderAuthorizationStatusObject

Whether a mailbox's sender settings have explicit operator approval.

IntScalar

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSONScalar

Arbitrary JSON value (object, array, number, boolean, string, or null). Not introspectable — when the shape is known, prefer a typed `Type` registration. Numbers stored as numbers come back as numbers, not stringified.

MagicQueryInfoObject

A discoverable Magic Query noun and its accepted options.

MagicQueryOperationObject

The real GraphQL operation + variables a Magic Query resolves to.

MagicQuerySchemaObject

Input (JSON Schema) and output (introspection) contract for a Magic Query noun.

MailboxCredentialPurposeEnum

Supported MailboxCredentialPurpose values.

QueryScalarScalar

A URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.

RequestFileUploadInputInput

Input for allocating a cloud upload URL. uploadedByUserId is derived from the auth context.

RequestFileUploadsPayloadObject

Result of requesting one or more upload URLs

S3BackendObject

Public projection of an S3 backend's configuration. Populated only when kind is S3. Credentials are elided; see hasCredentials.

StorageBackendConnectionObject

A page of the tenant's storage backends.

StorageBackendFilterInputInput

Filter for listStorageBackends. Omitted fields impose no constraint.

StorageBackendIDScalar

TypeID of a storage backend (`sbk_` prefix, e.g. "sbk_01K…"). Opaque to clients; the underlying row id never leaves the server.

StorageBackendOutputObject

A configured storage destination for a tenant (archives, transfers, folder bindings). Credentials are never returned; each backend kind's block exposes a hasCredentials flag instead.

StorageBackendProbeResultObject

Outcome of testStorageBackend: whether the backend is reachable right now, and why not if it isn't.

StorageBackendSortInputInput

One ordering rule for listStorageBackends. The argument takes a list, but only the first entry is applied.

StorageCapabilitiesOutputObject

Which backend kinds this deployment can actually run, so a client can hide options that would only fail on submit.

StringScalar

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

TopicExampleObject

A validated example. JSON strings contain illustrative inputs and responses, never live customer data.

UpdateFileInputInput

Input for updating a file. Only provided fields are changed.

UpdateFolderInputInput

Input for updateFolder. A patch: every field except id is optional, and an omitted (null) field keeps its stored value rather than clearing it.

UpdateStorageBackendInputInput

Input for updating a storage backend. Only provided fields are changed.

UpsertFileInputInput

Input for creating or updating an external-backed file. Cloud-backed files go through requestFileUploads / completeFileUploads.

UpsertFilePayloadObject

Result of creating or updating a file

UpsertStorageBackendInputInput

Create-or-update input for a storage backend: creates when id is omitted, updates the named row when it is present. Flat by kind — the resolver promotes the matching fields into the kind's config, and ignores the others.

UpsertStorageBackendPayloadObject

Result of upsertStorageBackend: either the persisted backend, or the validation errors that rejected it.

WorkflowTriggerIDScalar

Unique identifier for a workflow trigger