Type Alias GetFileImageRenditionData

type GetFileImageRenditionData = {
    body?: never;
    headers?: { "x-request-id"?: string };
    path: { assetId: AssetId };
    query?: { mediaType?: string; size?: number };
    url: "/files/{assetId}/image-rendition";
}

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?: { mediaType?: string; size?: number }

Type Declaration

OptionalmediaType?: string
The desired content type of the resulting rendition.
Optionalsize?: number
The desired dimension of the resulting rendition on the longest side, whether that is width or height.

url

url: "/files/{assetId}/image-rendition"