/** This is spectacularly generated code by spectacular based on Qlik Cloud Services APIs */ import Auth from '../auth/auth.js'; import ListableResource from '../listable.js'; import type { Config } from '../types/types.js'; export type Brand = { active?: boolean; /** The UTC timestamp when the brand was created. */ createdAt?: string; /** ID of a user that created the brand. */ createdBy?: string; description: string; /** Collection of resources that make up the brand. */ files: Array; id: string; name: string; /** The UTC timestamp when the brand was last updated. */ updatedAt?: string; /** ID of a user that last updated the brand. */ updatedBy?: string; [key: string]: any; }; export type BrandFile = { contentType?: string; eTag?: string; id?: 'logo' | 'favIcon' | 'styles' | string; path?: string; [key: string]: any; }; export type BrandPatch = { /** The operation to be performed. */ op: 'add' | 'remove' | 'replace' | string; /** The path for the given resource field to patch. @example "/description" */ path: '/name' | '/description' | string; /** The value to be used for this operation. */ value?: string; [key: string]: any; }; export type NoActiveBrand = { [key: string]: any; }; export declare class Brands { auth: Auth; config: Config; constructor(config: Config | Auth); /** Retrieves the current active brand */ getActive(): Promise; /** Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken. Activates a brand @param brand-id - The brand's unique identifier. */ activate(brandId: string): Promise; /** Sets the brand so it is no longer active. If the brand is already inactive, no action is taken. Deactivates a brand @param brand-id - The brand's unique identifier. */ deactivate(brandId: string): Promise; /** Deletes a specific brand file @param brand-id - The brand's unique identifier. @param brand-file-id - The unique identifier of a file within a brand. */ deleteFile(brandId: string, brandFileId: string): Promise; /** Downloads the brand file @param brand-id - The brand's unique identifier. @param brand-file-id - The unique identifier of a file within a brand. */ getFile(brandId: string, brandFileId: string): Promise; /** Creates a brand file @param brand-id - The brand's unique identifier. @param brand-file-id - The unique identifier of a file within a brand. @param file - The path and name of a file to upload. */ createFile(brandId: string, brandFileId: string, file?: Buffer): Promise; /** Updates existing file @param brand-id - The brand's unique identifier. @param brand-file-id - The unique identifier of a file within a brand. @param file - A file to upload. */ setFile(brandId: string, brandFileId: string, file?: Buffer): Promise; /** Deletes a specific brand @param brand-id - The brand's unique identifier. */ delete(brandId: string): Promise; /** Retrieves a specific brand @param brand-id - The brand's unique identifier. */ get(brandId: string): Promise; /** Patches a brand @param brand-id - The brand's unique identifier. @param BrandPatchData - */ patch(brandId: string, BrandPatchData: Array): Promise; /** Lists all brand entries for a tenant @param endingBefore - Cursor to previous. @param limit - Maximum number of brands to retrieve. @param sort - Field to sort by, prefixed with -/+ to indicate the order. @param startingAfter - Cursor to the next page. */ getBrands(queryParams?: { endingBefore?: string; limit?: number; sort?: 'id' | '+id' | '-id' | 'createdAt' | '+createdAt' | '-createdAt' | 'updatedAt' | '+updatedAt' | '-updatedAt'; startingAfter?: string; }): Promise>; /** Creates a new brand @param logo - The path and name of a JPG or PNG file that will be adjusted to fit in a 'box' measuring 109px in width and 62 px in height while maintaining aspect ratio. Maximum size of 300 KB, but smaller is recommended. @param name - Name of the brand. @param styles - The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational. @param favIcon - The path and name of a properly formatted ICO file. Maximum size is 100 KB. @param description - Description of the brand. */ create(logo?: Buffer, name?: string, styles?: Buffer, favIcon?: Buffer, description?: string): Promise; }