Interface BrandsAPI

interface BrandsAPI {
    activateBrand: (
        brandId: string,
        body: unknown,
        options?: ApiCallOptions,
    ) => Promise<ActivateBrandHttpResponse>;
    clearCache: () => void;
    createBrand: (
        body: {
            description?: string;
            favIcon?: BodyInit;
            logo?: BodyInit;
            name: string;
            styles?: BodyInit;
        },
        options?: ApiCallOptions,
    ) => Promise<CreateBrandHttpResponse>;
    createBrandFile: (
        brandId: string,
        brandFileId: string,
        body: { file?: BodyInit },
        options?: ApiCallOptions,
    ) => Promise<CreateBrandFileHttpResponse>;
    deactivateBrand: (
        brandId: string,
        body: unknown,
        options?: ApiCallOptions,
    ) => Promise<DeactivateBrandHttpResponse>;
    deleteBrand: (
        brandId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteBrandHttpResponse>;
    deleteBrandFile: (
        brandId: string,
        brandFileId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteBrandFileHttpResponse>;
    getActiveBrand: (
        options?: ApiCallOptions,
    ) => Promise<GetActiveBrandHttpResponse>;
    getBrand: (
        brandId: string,
        options?: ApiCallOptions,
    ) => Promise<GetBrandHttpResponse>;
    getBrandFile: (
        brandId: string,
        brandFileId: string,
        options?: ApiCallOptions,
    ) => Promise<GetBrandFileHttpResponse>;
    getBrands: (
        query: {
            endingBefore?: string;
            limit?: number;
            sort?:
                | "id"
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
                | "createdAt"
                | "updatedAt"
                | "+id"
                | "-id";
            startingAfter?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetBrandsHttpResponse>;
    patchBrand: (
        brandId: string,
        body: BrandPatch[],
        options?: ApiCallOptions,
    ) => Promise<PatchBrandHttpResponse>;
    updateBrandFile: (
        brandId: string,
        brandFileId: string,
        body: { file?: BodyInit },
        options?: ApiCallOptions,
    ) => Promise<UpdateBrandFileHttpResponse>;
}
Index

Properties

activateBrand clearCache createBrand createBrandFile deactivateBrand deleteBrand deleteBrandFile getActiveBrand getBrand getBrandFile getBrands patchBrand updateBrandFile

Properties

activateBrand: (
    brandId: string,
    body: unknown,
    options?: ApiCallOptions,
) => Promise<ActivateBrandHttpResponse>

Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.

Type declaration

    • (
          brandId: string,
          body: unknown,
          options?: ApiCallOptions,
      ): Promise<ActivateBrandHttpResponse>

    • Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.

      Parameters

      • brandId: string

        The brand's unique identifier.

      • body: unknown

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<ActivateBrandHttpResponse>

      ActivateBrandHttpError

The brand's unique identifier.

Param: body

an object with the body content

ActivateBrandHttpError

clearCache: () => void

Clears the cache for brands api requests.

Type declaration

    • (): void

    • Clears the cache for brands api requests.

      Returns void

createBrand: (
    body: {
        description?: string;
        favIcon?: BodyInit;
        logo?: BodyInit;
        name: string;
        styles?: BodyInit;
    },
    options?: ApiCallOptions,
) => Promise<CreateBrandHttpResponse>

Creates a new brand.

Type declaration

    • (
          body: {
              description?: string;
              favIcon?: BodyInit;
              logo?: BodyInit;
              name: string;
              styles?: BodyInit;
          },
          options?: ApiCallOptions,
      ): Promise<CreateBrandHttpResponse>

    • Creates a new brand.

      Parameters

      • body: {
            description?: string;
            favIcon?: BodyInit;
            logo?: BodyInit;
            name: string;
            styles?: BodyInit;
        }

        an object with the body content

        • Optionaldescription?: string

          Description of the brand.

        • OptionalfavIcon?: BodyInit

          The path and name of a properly formatted ICO file. Maximum size is 100 KB.

        • Optionallogo?: BodyInit

          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.

        • name: string

          Name of the brand.

        • Optionalstyles?: BodyInit

          The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational.

      • Optionaloptions: ApiCallOptions

      Returns Promise<CreateBrandHttpResponse>

      CreateBrandHttpError

Param: body

an object with the body content

CreateBrandHttpError

createBrandFile: (
    brandId: string,
    brandFileId: string,
    body: { file?: BodyInit },
    options?: ApiCallOptions,
) => Promise<CreateBrandFileHttpResponse>

Creates a brand file for the specified identifier.

Type declaration

    • (
          brandId: string,
          brandFileId: string,
          body: { file?: BodyInit },
          options?: ApiCallOptions,
      ): Promise<CreateBrandFileHttpResponse>

    • Creates a brand file for the specified identifier.

      Parameters

      • brandId: string

        The brand's unique identifier.

      • brandFileId: string

        The unique identifier of a file within a brand.

      • body: { file?: BodyInit }

        an object with the body content

        • Optionalfile?: BodyInit

          The path and name of a file to upload.

      • Optionaloptions: ApiCallOptions

      Returns Promise<CreateBrandFileHttpResponse>

      CreateBrandFileHttpError

The brand's unique identifier.

The unique identifier of a file within a brand.

Param: body

an object with the body content

CreateBrandFileHttpError

deactivateBrand: (
    brandId: string,
    body: unknown,
    options?: ApiCallOptions,
) => Promise<DeactivateBrandHttpResponse>

Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.

Type declaration

    • (
          brandId: string,
          body: unknown,
          options?: ApiCallOptions,
      ): Promise<DeactivateBrandHttpResponse>

    • Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.

      Parameters

      • brandId: string

        The brand's unique identifier.

      • body: unknown

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<DeactivateBrandHttpResponse>

      DeactivateBrandHttpError

The brand's unique identifier.

Param: body

an object with the body content

DeactivateBrandHttpError

deleteBrand: (
    brandId: string,
    options?: ApiCallOptions,
) => Promise<DeleteBrandHttpResponse>

Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.

Type declaration

The brand's unique identifier.

DeleteBrandHttpError

deleteBrandFile: (
    brandId: string,
    brandFileId: string,
    options?: ApiCallOptions,
) => Promise<DeleteBrandFileHttpResponse>

Deletes the specified brand file.

Type declaration

The brand's unique identifier.

The unique identifier of a file within a brand.

DeleteBrandFileHttpError

getActiveBrand: (
    options?: ApiCallOptions,
) => Promise<GetActiveBrandHttpResponse>

Returns the current active brand. If using the Qlik default brand, no value is returned.

Type declaration

GetActiveBrandHttpError

getBrand: (
    brandId: string,
    options?: ApiCallOptions,
) => Promise<GetBrandHttpResponse>

Returns a specific brand.

Type declaration

The brand's unique identifier.

GetBrandHttpError

getBrandFile: (
    brandId: string,
    brandFileId: string,
    options?: ApiCallOptions,
) => Promise<GetBrandFileHttpResponse>

Downloads the specified brand file.

Type declaration

    • (
          brandId: string,
          brandFileId: string,
          options?: ApiCallOptions,
      ): Promise<GetBrandFileHttpResponse>

    • Downloads the specified brand file.

      Parameters

      • brandId: string

        The brand's unique identifier.

      • brandFileId: string

        The unique identifier of a file within a brand.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetBrandFileHttpResponse>

      GetBrandFileHttpError

The brand's unique identifier.

The unique identifier of a file within a brand.

GetBrandFileHttpError

getBrands: (
    query: {
        endingBefore?: string;
        limit?: number;
        sort?:
            | "id"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
            | "createdAt"
            | "updatedAt"
            | "+id"
            | "-id";
        startingAfter?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetBrandsHttpResponse>

Lists all brand entries for a tenant.

Type declaration

    • (
          query: {
              endingBefore?: string;
              limit?: number;
              sort?:
                  | "id"
                  | "+createdAt"
                  | "-createdAt"
                  | "+updatedAt"
                  | "-updatedAt"
                  | "createdAt"
                  | "updatedAt"
                  | "+id"
                  | "-id";
              startingAfter?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetBrandsHttpResponse>

    • Lists all brand entries for a tenant.

      Parameters

      • query: {
            endingBefore?: string;
            limit?: number;
            sort?:
                | "id"
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
                | "createdAt"
                | "updatedAt"
                | "+id"
                | "-id";
            startingAfter?: string;
        }

        an object with query parameters

        • OptionalendingBefore?: string

          Cursor to previous.

        • Optionallimit?: number

          Maximum number of brands to retrieve.

        • Optionalsort?:
              | "id"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
              | "createdAt"
              | "updatedAt"
              | "+id"
              | "-id"

          Field to sort by, prefixed with -/+ to indicate the order.

        • OptionalstartingAfter?: string

          Cursor to the next page.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetBrandsHttpResponse>

      GetBrandsHttpError

an object with query parameters

GetBrandsHttpError

patchBrand: (
    brandId: string,
    body: BrandPatch[],
    options?: ApiCallOptions,
) => Promise<PatchBrandHttpResponse>

Patches a brand.

Type declaration

The brand's unique identifier.

Param: body

an object with the body content

PatchBrandHttpError

updateBrandFile: (
    brandId: string,
    brandFileId: string,
    body: { file?: BodyInit },
    options?: ApiCallOptions,
) => Promise<UpdateBrandFileHttpResponse>

Updates the specified brand file.

Type declaration

    • (
          brandId: string,
          brandFileId: string,
          body: { file?: BodyInit },
          options?: ApiCallOptions,
      ): Promise<UpdateBrandFileHttpResponse>

    • Updates the specified brand file.

      Parameters

      • brandId: string

        The brand's unique identifier.

      • brandFileId: string

        The unique identifier of a file within a brand.

      • body: { file?: BodyInit }

        an object with the body content

        • Optionalfile?: BodyInit

          A file to upload.

      • Optionaloptions: ApiCallOptions

      Returns Promise<UpdateBrandFileHttpResponse>

      UpdateBrandFileHttpError

The brand's unique identifier.

The unique identifier of a file within a brand.

Param: body

an object with the body content

UpdateBrandFileHttpError

Settings

Member Visibility

On This Page

Properties