Type Alias DeleteFileData

type DeleteFileData = {
    body?: never;
    headers?: { "x-request-id"?: string };
    path: { assetId: AssetId };
    query?: { permanent?: boolean };
    url: "/files/{assetId}";
}

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?: { permanent?: boolean }

Type Declaration

Optionalpermanent?: boolean
Permanent used for indicating the mode of delete operation.
- If true, the operation will do a permanent delete.
- If false, the operation will do a soft delete.
- If not provided, the default value is false.

url

url: "/files/{assetId}"