Type Alias DownloadFileData

type DownloadFileData = {
    body?: never;
    headers?: { "x-request-id"?: string };
    path: { assetId: AssetId };
    query?: { urlTTL?: number };
    url: "/files/{assetId}/download";
}

Index

Properties

body? headers? path query? url

Properties

`Optional`body

body?: never

`Optional`headers

headers?: { "x-request-id"?: string }

Type Declaration

Optionalx-request-id?: string
The X-Request-Id header is used to identify a request. It can be used to correlate logs and other resources and is intended to be a non-persistent identifier.

path

path: { assetId: AssetId }

Type Declaration

assetId: AssetId
The ID of the asset to get.

`Optional`query

query?: { urlTTL?: number }

Type Declaration

OptionalurlTTL?: number
- Provides a client provided hint for Time-To-Live(TTL) in seconds for the pre-signed download URL.
NOTE:
- The server may adjust it to enforce internal limits.
- Clients must rely on the urlExpirationDate field in the response for the actual expiration time.

url

url: "/files/{assetId}/download"