client.fileUploadIntentsOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/file-upload-intentsfileUploadIntents.create
Reserves workspace storage and returns a short-lived private HTTPS PUT target bound to the exact content length, MIME type, destination, credential, and idempotency key.
client.fileUploadIntents.create(data: FileUploadIntentCreate, options: MutationOptions = {})- Return form
Promise- Operation ID
createFileUploadIntent- Required scopes
files:write- SDK parameters
data: FileUploadIntentCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
FileUploadIntentCreateapplication/json- Success
201 FileUploadIntent envelope
/file-upload-intents/{id}/finalizefileUploadIntents.finalize
Verifies the uploaded object size and MIME type, consumes the storage reservation, creates canonical file records, and returns only the public file projection.
client.fileUploadIntents.finalize(id: string, options: RequestOptions = {})- Return form
Promise- Operation ID
finalizeFileUploadIntent- Required scopes
files:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 File envelope
/file-upload-intents/{id}fileUploadIntents.cancel
Cancels a credential-owned unfinalized upload reservation. Repeated cancellation is safe; finalized intents cannot be canceled.
client.fileUploadIntents.cancel(id: string, options: RequestOptions = {})- Return form
Promise- Operation ID
cancelFileUploadIntent- Required scopes
files:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 FileUploadCancellation envelope
Errors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.