Skip to main content

CabinetsResource

figranium.cabinets is the SDK’s typed client for the Cabinets API. Cabinets are durable, installation-wide download queues. Tasks can route intercepted downloads into a selected Cabinet, and later actions can upload the newest unuploaded item from that queue.

Access the resource

Supported operations

CabinetsResource covers the Cabinet lifecycle and item-management API.

Cabinet lifecycle

List, create, rename, migrate, clear, and delete Cabinets.

Item management

List Cabinet items, update upload status, and remove one or many items.

Archives

Create ZIP archives and safely extract compatible archives.

Downloads

Build item download URLs for files stored in a Cabinet.
The exact return types are exported by @figranium/sdk, so TypeScript consumers get typed Cabinet metadata and item records.

Use a Cabinet from a task

Tasks can set cabinetId to select where intercepted browser downloads are stored:
If a task omits cabinetId, Figranium uses the instance’s default Cabinet. An individual Upload action can override the task-level selection with its own cabinetId.

Upload status

Cabinet items track whether they have been uploaded. The upload action normally selects the newest unuploaded item. You can mark an item uploaded immediately with markAsUploaded, or keep finalization separate and call finalize_uploads later in the workflow.
Keep finalization separate when attaching a file and successfully submitting it are two different steps. That lets the workflow consume the Cabinet item only after the later step succeeds.

Action helpers

Build typed Upload and Finalize Uploads actions.

Tasks resource

Save and run tasks that select a Cabinet with cabinetId.

File downloads

Understand Cabinets, intercepted downloads, and the upload lifecycle.