Type Alias ThemesAPI

type ThemesAPI = {
    clearCache: typeof clearCache;
    deleteTheme: typeof deleteTheme;
    downloadFileFromTheme: typeof downloadFileFromTheme;
    downloadTheme: typeof downloadTheme;
    getTheme: typeof getTheme;
    getThemes: typeof getThemes;
    patchTheme: typeof patchTheme;
    uploadTheme: typeof uploadTheme;
}
Index

Properties

clearCache deleteTheme downloadFileFromTheme downloadTheme getTheme getThemes patchTheme uploadTheme

Properties

clearCache: typeof clearCache

Clears the cache for themes api requests.

deleteTheme: typeof deleteTheme

Deletes a specific theme matching either theme ID or theme name.

Theme identifier or its qextFilename.

DeleteThemeHttpError

downloadFileFromTheme: typeof downloadFileFromTheme

Downloads a file from the theme matching either theme ID or theme name, identified by the file path within the imported extension.

Theme identifier or its qextFilename.

Path to the file location within the specified theme archive. Folders separated with forward slashes.

DownloadFileFromThemeHttpError

downloadTheme: typeof downloadTheme

Downloads all files in the theme matching either theme ID or theme name as a .zip archive.

Theme identifier or its qextFilename

DownloadThemeHttpError

getTheme: typeof getTheme

Returns a specific theme matching either theme ID or theme name.

Theme identifier or its qextFilename

GetThemeHttpError

getThemes: typeof getThemes

Lists all imported themes in the tenant.

GetThemesHttpError

patchTheme: typeof patchTheme

Updates a specific theme matching either theme ID or theme name. Accepts either provided file or data object.

Theme identifier or its qextFilename.

Param: body

an object with the body content

PatchThemeHttpError

uploadTheme: typeof uploadTheme

Creates a new theme. Accepts either provided file or data object. The name of the new theme must be different to any existing themes.

Param: body

an object with the body content

UploadThemeHttpError

Settings

Member Visibility

On This Page

Properties