Package-level declarations

Types

Link copied to clipboard
@Serializable
data class Upload(val id: UploadId, val bytes: Long, val createdAt: Long, val expiresAt: Long, val filename: String, val purpose: Purpose, val status: UploadStatus, val file: UploadedFile? = null, val objectType: String = "upload")

An intermediate upload. A completed upload exposes the resulting regular file in file.

Link copied to clipboard
@Serializable
data class UploadCompletionRequest(val partIds: List<UploadPartId>, val md5: String? = null)

Completes an upload by assembling parts in exactly the supplied order, with an optional MD5 digest.

Link copied to clipboard
@Serializable
data class UploadedFile(val id: FileId, val bytes: Long?, val createdAt: Long, val filename: String, val purpose: Purpose, val status: String? = null, val expiresAt: Long? = null, val statusDetails: String? = null, val objectType: String = "file")

File produced by completing an upload. Unlike older File models, byte counts may be null while processing or larger than a signed 32-bit integer. Its id works with regular file APIs.

Link copied to clipboard
@Serializable
data class UploadExpirationPolicy(val seconds: Long, val anchor: String = "created_at")

Expiration of the resulting file, distinct from the intermediate upload's own expiry.

Link copied to clipboard
@Serializable
value class UploadId(val id: String)

Identifier of an intermediate multipart upload.

Link copied to clipboard
@Serializable
data class UploadPart(val id: UploadPartId, val createdAt: Long, val uploadId: UploadId, val objectType: String = "upload.part")

A successfully added part. Its identifier can be passed to UploadCompletionRequest.

Link copied to clipboard
@Serializable
value class UploadPartId(val id: String)

Identifier of an uploaded part, ordered when completing its upload.

Link copied to clipboard
@Serializable
data class UploadRequest(val bytes: Long, val filename: String, val mimeType: String, val purpose: Purpose, val expiresAfter: UploadExpirationPolicy? = null)

Creates an intermediate upload for a file of the declared total byte length.

Link copied to clipboard
@Serializable
value class UploadStatus(val value: String)

Upload lifecycle state; string-backed to preserve future server states.