Reference

BackstageClient.brands

BackstageClient.brands in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / brands

brands: {
  create: (request: {
     accountId?: string;
     brand?: {
        displayName?: string;
        faviconUrl?: string;
        fontStylesheetUrl?: string;
        logoDarkUrl?: string;
        logoUrl?: string;
        replyToEmail?: string;
     };
     colors?: {
        accent?: string;
        accentForeground?: string;
        background?: string;
        border?: string;
        destructive?: string;
        destructiveForeground?: string;
        foreground?: string;
        input?: string;
        muted?: string;
        mutedForeground?: string;
        primary?: string;
        primaryForeground?: string;
        ring?: string;
        secondary?: string;
        secondaryForeground?: string;
        success?: string;
        successForeground?: string;
        warning?: string;
        warningForeground?: string;
     };
     conciergePersona?: {
        avatarAssetId?: string;
        greeting?: string;
        name?: string;
     };
     description?: string;
     design?: {
        buttonSize?: "small" | "medium" | "large";
        cinemaGradient?: {
           position: "bottom" | "center";
           strength: 20 | 50 | 70;
        };
        heroLayout?: {
           size: "small" | "medium" | "large";
           type: "hero" | "cinema";
        };
        modalHeader?: {
           channel?: "hidden" | "blurred" | "plain";
           event?: "blurred" | "plain";
        };
        navbar?: {
           transparent?: boolean;
        };
        twoColumnSplit?: [number, number];
      } & {
      [key: string]: unknown;
     };
     extendsBrandId?: string;
     isActive?: boolean;
     isBaseBrand?: boolean;
     name: string;
     shape?: {
        radiusFull?: string;
        radiusLg?: string;
        radiusMd?: string;
        radiusNone?: string;
        radiusSm?: string;
     };
     typography?: {
        baseSize?: string;
        fontFamily?: string;
        fontFamilyMono?: string;
        headingFontFamily?: string;
        headingFontWeight?: number;
        scaleRatio?: number;
     };
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string | null;
     brand: {
        displayName?: string;
        faviconUrl?: string;
        fontStylesheetUrl?: string;
        logoDarkUrl?: string;
        logoUrl?: string;
     };
     colors: {
        accent?: string;
        accentForeground?: string;
        background?: string;
        border?: string;
        destructive?: string;
        destructiveForeground?: string;
        foreground?: string;
        input?: string;
        muted?: string;
        mutedForeground?: string;
        primary?: string;
        primaryForeground?: string;
        ring?: string;
        secondary?: string;
        secondaryForeground?: string;
        success?: string;
        successForeground?: string;
        warning?: string;
        warningForeground?: string;
     };
     conciergePersona: {
        avatarAssetId?: string;
        greeting?: string;
        name?: string;
     };
     createdAt: string;
     description: string | null;
     design:   | {
        buttonSize?: "small" | "medium" | "large";
        cinemaGradient?: {
           position: "bottom" | "center";
           strength: 20 | 50 | 70;
        };
        heroLayout?: {
           size: "small" | "medium" | "large";
           type: "hero" | "cinema";
        };
        modalHeader?: {
           channel?: "hidden" | "blurred" | "plain";
           event?: "blurred" | "plain";
        };
        navbar?: {
           transparent?: boolean;
        };
        twoColumnSplit?: [number, number];
      }
        | null;
     extendsBrandId: string | null;
     id: string;
     isActive: boolean;
     isBaseBrand: boolean;
     name: string;
     organisationId: string;
     shape: {
        radiusFull?: string;
        radiusLg?: string;
        radiusMd?: string;
        radiusNone?: string;
        radiusSm?: string;
     };
     typography: {
        baseSize?: string;
        fontFamily?: string;
        fontFamilyMono?: string;
        headingFontFamily?: string;
        headingFontWeight?: number;
        scaleRatio?: number;
     };
     updatedAt: string;
  }>;
  delete: (id: string, requestOptions?: RequestOptions) => Promise<boolean>;
  get: (id: string, requestOptions?: RequestOptions) => Promise<{
     accountId: string | null;
     brand: {
        displayName?: string;
        faviconUrl?: string;
        fontStylesheetUrl?: string;
        logoDarkUrl?: string;
        logoUrl?: string;
     };
     colors: {
        accent?: string;
        accentForeground?: string;
        background?: string;
        border?: string;
        destructive?: string;
        destructiveForeground?: string;
        foreground?: string;
        input?: string;
        muted?: string;
        mutedForeground?: string;
        primary?: string;
        primaryForeground?: string;
        ring?: string;
        secondary?: string;
        secondaryForeground?: string;
        success?: string;
        successForeground?: string;
        warning?: string;
        warningForeground?: string;
     };
     conciergePersona: {
        avatarAssetId?: string;
        greeting?: string;
        name?: string;
     };
     createdAt: string;
     description: string | null;
     design:   | {
        buttonSize?: "small" | "medium" | "large";
        cinemaGradient?: {
           position: "bottom" | "center";
           strength: 20 | 50 | 70;
        };
        heroLayout?: {
           size: "small" | "medium" | "large";
           type: "hero" | "cinema";
        };
        modalHeader?: {
           channel?: "hidden" | "blurred" | "plain";
           event?: "blurred" | "plain";
        };
        navbar?: {
           transparent?: boolean;
        };
        twoColumnSplit?: [number, number];
      }
        | null;
     extendsBrandId: string | null;
     id: string;
     isActive: boolean;
     isBaseBrand: boolean;
     name: string;
     organisationId: string;
     shape: {
        radiusFull?: string;
        radiusLg?: string;
        radiusMd?: string;
        radiusNone?: string;
        radiusSm?: string;
     };
     typography: {
        baseSize?: string;
        fontFamily?: string;
        fontFamilyMono?: string;
        headingFontFamily?: string;
        headingFontWeight?: number;
        scaleRatio?: number;
     };
     updatedAt: string;
  }>;
  list: (requestOptions?: RequestOptions) => Promise<{
     accountId: string | null;
     brand: {
        displayName?: string;
        faviconUrl?: string;
        fontStylesheetUrl?: string;
        logoDarkUrl?: string;
        logoUrl?: string;
     };
     colors: {
        accent?: string;
        accentForeground?: string;
        background?: string;
        border?: string;
        destructive?: string;
        destructiveForeground?: string;
        foreground?: string;
        input?: string;
        muted?: string;
        mutedForeground?: string;
        primary?: string;
        primaryForeground?: string;
        ring?: string;
        secondary?: string;
        secondaryForeground?: string;
        success?: string;
        successForeground?: string;
        warning?: string;
        warningForeground?: string;
     };
     conciergePersona: {
        avatarAssetId?: string;
        greeting?: string;
        name?: string;
     };
     createdAt: string;
     description: string | null;
     design:   | {
        buttonSize?: "small" | "medium" | "large";
        cinemaGradient?: {
           position: "bottom" | "center";
           strength: 20 | 50 | 70;
        };
        heroLayout?: {
           size: "small" | "medium" | "large";
           type: "hero" | "cinema";
        };
        modalHeader?: {
           channel?: "hidden" | "blurred" | "plain";
           event?: "blurred" | "plain";
        };
        navbar?: {
           transparent?: boolean;
        };
        twoColumnSplit?: [number, number];
      }
        | null;
     extendsBrandId: string | null;
     id: string;
     isActive: boolean;
     isBaseBrand: boolean;
     name: string;
     organisationId: string;
     shape: {
        radiusFull?: string;
        radiusLg?: string;
        radiusMd?: string;
        radiusNone?: string;
        radiusSm?: string;
     };
     typography: {
        baseSize?: string;
        fontFamily?: string;
        fontFamilyMono?: string;
        headingFontFamily?: string;
        headingFontWeight?: number;
        scaleRatio?: number;
     };
     updatedAt: string;
  }[]>;
  resolved: (id: string, requestOptions?: RequestOptions) => Promise<{
     accountId: string | null;
     brand: {
        displayName?: string;
        faviconUrl?: string;
        fontStylesheetUrl?: string;
        logoDarkUrl?: string;
        logoUrl?: string;
     };
     colors: {
        accent?: string;
        accentForeground?: string;
        background?: string;
        border?: string;
        destructive?: string;
        destructiveForeground?: string;
        foreground?: string;
        input?: string;
        muted?: string;
        mutedForeground?: string;
        primary?: string;
        primaryForeground?: string;
        ring?: string;
        secondary?: string;
        secondaryForeground?: string;
        success?: string;
        successForeground?: string;
        warning?: string;
        warningForeground?: string;
     };
     conciergePersona: {
        avatarAssetId?: string;
        greeting?: string;
        name?: string;
     };
     description: string | null;
     design:   | {
        buttonSize?: "small" | "medium" | "large";
        cinemaGradient?: {
           position: "bottom" | "center";
           strength: 20 | 50 | 70;
        };
        heroLayout?: {
           size: "small" | "medium" | "large";
           type: "hero" | "cinema";
        };
        modalHeader?: {
           channel?: "hidden" | "blurred" | "plain";
           event?: "blurred" | "plain";
        };
        navbar?: {
           transparent?: boolean;
        };
        twoColumnSplit?: [number, number];
      }
        | null;
     extendsBrandId: string | null;
     id: string;
     isActive: boolean;
     isBaseBrand: boolean;
     name: string;
     organisationId: string;
     shape: {
        radiusFull?: string;
        radiusLg?: string;
        radiusMd?: string;
        radiusNone?: string;
        radiusSm?: string;
     };
     typography: {
        baseSize?: string;
        fontFamily?: string;
        fontFamilyMono?: string;
        headingFontFamily?: string;
        headingFontWeight?: number;
        scaleRatio?: number;
     };
  }>;
  update: (id: string, request: {
     brand?: {
        displayName?: string;
        faviconUrl?: string;
        fontStylesheetUrl?: string;
        logoDarkUrl?: string;
        logoUrl?: string;
        replyToEmail?: string;
     };
     colors?: {
        accent?: string;
        accentForeground?: string;
        background?: string;
        border?: string;
        destructive?: string;
        destructiveForeground?: string;
        foreground?: string;
        input?: string;
        muted?: string;
        mutedForeground?: string;
        primary?: string;
        primaryForeground?: string;
        ring?: string;
        secondary?: string;
        secondaryForeground?: string;
        success?: string;
        successForeground?: string;
        warning?: string;
        warningForeground?: string;
     };
     conciergePersona?: {
        avatarAssetId?: string;
        greeting?: string;
        name?: string;
     };
     description?: any;
     design?: any;
     extendsBrandId?: any;
     isActive?: boolean;
     isBaseBrand?: boolean;
     name?: string;
     shape?: {
        radiusFull?: string;
        radiusLg?: string;
        radiusMd?: string;
        radiusNone?: string;
        radiusSm?: string;
     };
     typography?: {
        baseSize?: string;
        fontFamily?: string;
        fontFamilyMono?: string;
        headingFontFamily?: string;
        headingFontWeight?: number;
        scaleRatio?: number;
     };
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string | null;
     brand: {
        displayName?: string;
        faviconUrl?: string;
        fontStylesheetUrl?: string;
        logoDarkUrl?: string;
        logoUrl?: string;
     };
     colors: {
        accent?: string;
        accentForeground?: string;
        background?: string;
        border?: string;
        destructive?: string;
        destructiveForeground?: string;
        foreground?: string;
        input?: string;
        muted?: string;
        mutedForeground?: string;
        primary?: string;
        primaryForeground?: string;
        ring?: string;
        secondary?: string;
        secondaryForeground?: string;
        success?: string;
        successForeground?: string;
        warning?: string;
        warningForeground?: string;
     };
     conciergePersona: {
        avatarAssetId?: string;
        greeting?: string;
        name?: string;
     };
     createdAt: string;
     description: string | null;
     design:   | {
        buttonSize?: "small" | "medium" | "large";
        cinemaGradient?: {
           position: "bottom" | "center";
           strength: 20 | 50 | 70;
        };
        heroLayout?: {
           size: "small" | "medium" | "large";
           type: "hero" | "cinema";
        };
        modalHeader?: {
           channel?: "hidden" | "blurred" | "plain";
           event?: "blurred" | "plain";
        };
        navbar?: {
           transparent?: boolean;
        };
        twoColumnSplit?: [number, number];
      }
        | null;
     extendsBrandId: string | null;
     id: string;
     isActive: boolean;
     isBaseBrand: boolean;
     name: string;
     organisationId: string;
     shape: {
        radiusFull?: string;
        radiusLg?: string;
        radiusMd?: string;
        radiusNone?: string;
        radiusSm?: string;
     };
     typography: {
        baseSize?: string;
        fontFamily?: string;
        fontFamilyMono?: string;
        headingFontFamily?: string;
        headingFontWeight?: number;
        scaleRatio?: number;
     };
     updatedAt: string;
  }>;
};

Defined in: client.ts:8323

Brands methods

create()#

create: (request: {
  accountId?: string;
  brand?: {
     displayName?: string;
     faviconUrl?: string;
     fontStylesheetUrl?: string;
     logoDarkUrl?: string;
     logoUrl?: string;
     replyToEmail?: string;
  };
  colors?: {
     accent?: string;
     accentForeground?: string;
     background?: string;
     border?: string;
     destructive?: string;
     destructiveForeground?: string;
     foreground?: string;
     input?: string;
     muted?: string;
     mutedForeground?: string;
     primary?: string;
     primaryForeground?: string;
     ring?: string;
     secondary?: string;
     secondaryForeground?: string;
     success?: string;
     successForeground?: string;
     warning?: string;
     warningForeground?: string;
  };
  conciergePersona?: {
     avatarAssetId?: string;
     greeting?: string;
     name?: string;
  };
  description?: string;
  design?: {
     buttonSize?: "small" | "medium" | "large";
     cinemaGradient?: {
        position: "bottom" | "center";
        strength: 20 | 50 | 70;
     };
     heroLayout?: {
        size: "small" | "medium" | "large";
        type: "hero" | "cinema";
     };
     modalHeader?: {
        channel?: "hidden" | "blurred" | "plain";
        event?: "blurred" | "plain";
     };
     navbar?: {
        transparent?: boolean;
     };
     twoColumnSplit?: [number, number];
   } & {
   [key: string]: unknown;
  };
  extendsBrandId?: string;
  isActive?: boolean;
  isBaseBrand?: boolean;
  name: string;
  shape?: {
     radiusFull?: string;
     radiusLg?: string;
     radiusMd?: string;
     radiusNone?: string;
     radiusSm?: string;
  };
  typography?: {
     baseSize?: string;
     fontFamily?: string;
     fontFamilyMono?: string;
     headingFontFamily?: string;
     headingFontWeight?: number;
     scaleRatio?: number;
  };
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string | null;
  brand: {
     displayName?: string;
     faviconUrl?: string;
     fontStylesheetUrl?: string;
     logoDarkUrl?: string;
     logoUrl?: string;
  };
  colors: {
     accent?: string;
     accentForeground?: string;
     background?: string;
     border?: string;
     destructive?: string;
     destructiveForeground?: string;
     foreground?: string;
     input?: string;
     muted?: string;
     mutedForeground?: string;
     primary?: string;
     primaryForeground?: string;
     ring?: string;
     secondary?: string;
     secondaryForeground?: string;
     success?: string;
     successForeground?: string;
     warning?: string;
     warningForeground?: string;
  };
  conciergePersona: {
     avatarAssetId?: string;
     greeting?: string;
     name?: string;
  };
  createdAt: string;
  description: string | null;
  design:   | {
     buttonSize?: "small" | "medium" | "large";
     cinemaGradient?: {
        position: "bottom" | "center";
        strength: 20 | 50 | 70;
     };
     heroLayout?: {
        size: "small" | "medium" | "large";
        type: "hero" | "cinema";
     };
     modalHeader?: {
        channel?: "hidden" | "blurred" | "plain";
        event?: "blurred" | "plain";
     };
     navbar?: {
        transparent?: boolean;
     };
     twoColumnSplit?: [number, number];
   }
     | null;
  extendsBrandId: string | null;
  id: string;
  isActive: boolean;
  isBaseBrand: boolean;
  name: string;
  organisationId: string;
  shape: {
     radiusFull?: string;
     radiusLg?: string;
     radiusMd?: string;
     radiusNone?: string;
     radiusSm?: string;
  };
  typography: {
     baseSize?: string;
     fontFamily?: string;
     fontFamilyMono?: string;
     headingFontFamily?: string;
     headingFontWeight?: number;
     scaleRatio?: number;
  };
  updatedAt: string;
}>;

Create brand Create a new branding entity

Parameters#

Parameter	Type	Description
`request`	{ `accountId?`: `string`; `brand?`: { `displayName?`: `string`; `faviconUrl?`: `string`; `fontStylesheetUrl?`: `string`; `logoDarkUrl?`: `string`; `logoUrl?`: `string`; `replyToEmail?`: `string`; }; `colors?`: { `accent?`: `string`; `accentForeground?`: `string`; `background?`: `string`; `border?`: `string`; `destructive?`: `string`; `destructiveForeground?`: `string`; `foreground?`: `string`; `input?`: `string`; `muted?`: `string`; `mutedForeground?`: `string`; `primary?`: `string`; `primaryForeground?`: `string`; `ring?`: `string`; `secondary?`: `string`; `secondaryForeground?`: `string`; `success?`: `string`; `successForeground?`: `string`; `warning?`: `string`; `warningForeground?`: `string`; }; `conciergePersona?`: { `avatarAssetId?`: `string`; `greeting?`: `string`; `name?`: `string`; }; `description?`: `string`; `design?`: { `buttonSize?`: `"small"` \| `"medium"` \| `"large"`; `cinemaGradient?`: { `position`: `"bottom"` \| `"center"`; `strength`: `20` \| `50` \| `70`; }; `heroLayout?`: { `size`: `"small"` \| `"medium"` \| `"large"`; `type`: `"hero"` \| `"cinema"`; }; `modalHeader?`: { `channel?`: `"hidden"` \| `"blurred"` \| `"plain"`; `event?`: `"blurred"` \| `"plain"`; }; `navbar?`: { `transparent?`: `boolean`; }; `twoColumnSplit?`: [`number`, `number`]; } & { [`key`: `string`]: `unknown`; }; `extendsBrandId?`: `string`; `isActive?`: `boolean`; `isBaseBrand?`: `boolean`; `name`: `string`; `shape?`: { `radiusFull?`: `string`; `radiusLg?`: `string`; `radiusMd?`: `string`; `radiusNone?`: `string`; `radiusSm?`: `string`; }; `typography?`: { `baseSize?`: `string`; `fontFamily?`: `string`; `fontFamilyMono?`: `string`; `headingFontFamily?`: `string`; `headingFontWeight?`: `number`; `scaleRatio?`: `number`; }; }	-
`request.accountId?`	`string`	-
`request.brand?`	{ `displayName?`: `string`; `faviconUrl?`: `string`; `fontStylesheetUrl?`: `string`; `logoDarkUrl?`: `string`; `logoUrl?`: `string`; `replyToEmail?`: `string`; }	-
`request.brand.displayName?`	`string`	-
`request.brand.faviconUrl?`	`string`	-
`request.brand.fontStylesheetUrl?`	`string`	Description A stylesheet that loads the brand's web fonts: https, on Google Fonts, Adobe Fonts or Bunny Fonts. The storefront and the Elements add it to the page once. Example `https://fonts.googleapis.com/css2?family=Anton&display=swap`
`request.brand.logoDarkUrl?`	`string`	-
`request.brand.logoUrl?`	`string`	-
`request.brand.replyToEmail?`	`string`	Format: email Description Where a reply to this brand's email goes; the sending address stays platform-wide Example `boxoffice@example.com`
`request.colors?`	{ `accent?`: `string`; `accentForeground?`: `string`; `background?`: `string`; `border?`: `string`; `destructive?`: `string`; `destructiveForeground?`: `string`; `foreground?`: `string`; `input?`: `string`; `muted?`: `string`; `mutedForeground?`: `string`; `primary?`: `string`; `primaryForeground?`: `string`; `ring?`: `string`; `secondary?`: `string`; `secondaryForeground?`: `string`; `success?`: `string`; `successForeground?`: `string`; `warning?`: `string`; `warningForeground?`: `string`; }	-
`request.colors.accent?`	`string`	-
`request.colors.accentForeground?`	`string`	-
`request.colors.background?`	`string`	-
`request.colors.border?`	`string`	-
`request.colors.destructive?`	`string`	-
`request.colors.destructiveForeground?`	`string`	-
`request.colors.foreground?`	`string`	-
`request.colors.input?`	`string`	-
`request.colors.muted?`	`string`	-
`request.colors.mutedForeground?`	`string`	-
`request.colors.primary?`	`string`	-
`request.colors.primaryForeground?`	`string`	-
`request.colors.ring?`	`string`	-
`request.colors.secondary?`	`string`	-
`request.colors.secondaryForeground?`	`string`	-
`request.colors.success?`	`string`	-
`request.colors.successForeground?`	`string`	-
`request.colors.warning?`	`string`	-
`request.colors.warningForeground?`	`string`	-
`request.conciergePersona?`	{ `avatarAssetId?`: `string`; `greeting?`: `string`; `name?`: `string`; }	-
`request.conciergePersona.avatarAssetId?`	`string`	Description A public image asset of the organisation's (POST /assets). The widget shows it to anyone. Example `ast_abc123`
`request.conciergePersona.greeting?`	`string`	Description The first thing the widget says. Example `Hello! Ask me anything about your visit.`
`request.conciergePersona.name?`	`string`	Description The name the widget speaks as. Unset everywhere, it is "Concierge". Example `Frank`
`request.description?`	`string`	-
`request.design?`	{ `buttonSize?`: `"small"` \| `"medium"` \| `"large"`; `cinemaGradient?`: { `position`: `"bottom"` \| `"center"`; `strength`: `20` \| `50` \| `70`; }; `heroLayout?`: { `size`: `"small"` \| `"medium"` \| `"large"`; `type`: `"hero"` \| `"cinema"`; }; `modalHeader?`: { `channel?`: `"hidden"` \| `"blurred"` \| `"plain"`; `event?`: `"blurred"` \| `"plain"`; }; `navbar?`: { `transparent?`: `boolean`; }; `twoColumnSplit?`: [`number`, `number`]; } & { [`key`: `string`]: `unknown`; }	-
`request.extendsBrandId?`	`string`	-
`request.isActive?`	`boolean`	-
`request.isBaseBrand?`	`boolean`	-
`request.name?`	`string`	-
`request.shape?`	{ `radiusFull?`: `string`; `radiusLg?`: `string`; `radiusMd?`: `string`; `radiusNone?`: `string`; `radiusSm?`: `string`; }	-
`request.shape.radiusFull?`	`string`	-
`request.shape.radiusLg?`	`string`	-
`request.shape.radiusMd?`	`string`	-
`request.shape.radiusNone?`	`string`	-
`request.shape.radiusSm?`	`string`	-
`request.typography?`	{ `baseSize?`: `string`; `fontFamily?`: `string`; `fontFamilyMono?`: `string`; `headingFontFamily?`: `string`; `headingFontWeight?`: `number`; `scaleRatio?`: `number`; }	-
`request.typography.baseSize?`	`string`	-
`request.typography.fontFamily?`	`string`	Description The body font stack.
`request.typography.fontFamilyMono?`	`string`	-
`request.typography.headingFontFamily?`	`string`	Description The heading font stack. Headings follow the body font when it is not set. Example `'DM Serif Display', Georgia, serif`
`request.typography.headingFontWeight?`	`number`	Description The weight headings are set in (1-1000). A one-weight display face wants 400. Example `600`
`request.typography.scaleRatio?`	`number`	-
`requestOptions?`	`RequestOptions`	-

Returns#

Promise<{ accountId: string | null; brand: { displayName?: string; faviconUrl?: string; fontStylesheetUrl?: string; logoDarkUrl?: string; logoUrl?: string; }; colors: { accent?: string; accentForeground?: string; background?: string; border?: string; destructive?: string; destructiveForeground?: string; foreground?: string; input?: string; muted?: string; mutedForeground?: string; primary?: string; primaryForeground?: string; ring?: string; secondary?: string; secondaryForeground?: string; success?: string; successForeground?: string; warning?: string; warningForeground?: string; }; conciergePersona: { avatarAssetId?: string; greeting?: string; name?: string; }; createdAt: string; description: string | null; design: | { buttonSize?: "small" | "medium" | "large"; cinemaGradient?: { position: "bottom" | "center"; strength: 20 | 50 | 70; }; heroLayout?: { size: "small" | "medium" | "large"; type: "hero" | "cinema"; }; modalHeader?: { channel?: "hidden" | "blurred" | "plain"; event?: "blurred" | "plain"; }; navbar?: { transparent?: boolean; }; twoColumnSplit?: [number, number]; } | null; extendsBrandId: string | null; id: string; isActive: boolean; isBaseBrand: boolean; name: string; organisationId: string; shape: { radiusFull?: string; radiusLg?: string; radiusMd?: string; radiusNone?: string; radiusSm?: string; }; typography: { baseSize?: string; fontFamily?: string; fontFamilyMono?: string; headingFontFamily?: string; headingFontWeight?: number; scaleRatio?: number; }; updatedAt: string; }>

Operation Id#

createBrand

delete()#

delete: (id: string, requestOptions?: RequestOptions) => Promise<boolean>;

Delete brand Soft-delete a brand

Parameters#

Parameter	Type
`id`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<boolean>

Operation Id#

deleteBrand

get()#

get: (id: string, requestOptions?: RequestOptions) => Promise<{
  accountId: string | null;
  brand: {
     displayName?: string;
     faviconUrl?: string;
     fontStylesheetUrl?: string;
     logoDarkUrl?: string;
     logoUrl?: string;
  };
  colors: {
     accent?: string;
     accentForeground?: string;
     background?: string;
     border?: string;
     destructive?: string;
     destructiveForeground?: string;
     foreground?: string;
     input?: string;
     muted?: string;
     mutedForeground?: string;
     primary?: string;
     primaryForeground?: string;
     ring?: string;
     secondary?: string;
     secondaryForeground?: string;
     success?: string;
     successForeground?: string;
     warning?: string;
     warningForeground?: string;
  };
  conciergePersona: {
     avatarAssetId?: string;
     greeting?: string;
     name?: string;
  };
  createdAt: string;
  description: string | null;
  design:   | {
     buttonSize?: "small" | "medium" | "large";
     cinemaGradient?: {
        position: "bottom" | "center";
        strength: 20 | 50 | 70;
     };
     heroLayout?: {
        size: "small" | "medium" | "large";
        type: "hero" | "cinema";
     };
     modalHeader?: {
        channel?: "hidden" | "blurred" | "plain";
        event?: "blurred" | "plain";
     };
     navbar?: {
        transparent?: boolean;
     };
     twoColumnSplit?: [number, number];
   }
     | null;
  extendsBrandId: string | null;
  id: string;
  isActive: boolean;
  isBaseBrand: boolean;
  name: string;
  organisationId: string;
  shape: {
     radiusFull?: string;
     radiusLg?: string;
     radiusMd?: string;
     radiusNone?: string;
     radiusSm?: string;
  };
  typography: {
     baseSize?: string;
     fontFamily?: string;
     fontFamilyMono?: string;
     headingFontFamily?: string;
     headingFontWeight?: number;
     scaleRatio?: number;
  };
  updatedAt: string;
}>;

Get brand Get a specific brand by ID

Parameters#

Parameter	Type
`id`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

getBrand

list()#

list: (requestOptions?: RequestOptions) => Promise<{
  accountId: string | null;
  brand: {
     displayName?: string;
     faviconUrl?: string;
     fontStylesheetUrl?: string;
     logoDarkUrl?: string;
     logoUrl?: string;
  };
  colors: {
     accent?: string;
     accentForeground?: string;
     background?: string;
     border?: string;
     destructive?: string;
     destructiveForeground?: string;
     foreground?: string;
     input?: string;
     muted?: string;
     mutedForeground?: string;
     primary?: string;
     primaryForeground?: string;
     ring?: string;
     secondary?: string;
     secondaryForeground?: string;
     success?: string;
     successForeground?: string;
     warning?: string;
     warningForeground?: string;
  };
  conciergePersona: {
     avatarAssetId?: string;
     greeting?: string;
     name?: string;
  };
  createdAt: string;
  description: string | null;
  design:   | {
     buttonSize?: "small" | "medium" | "large";
     cinemaGradient?: {
        position: "bottom" | "center";
        strength: 20 | 50 | 70;
     };
     heroLayout?: {
        size: "small" | "medium" | "large";
        type: "hero" | "cinema";
     };
     modalHeader?: {
        channel?: "hidden" | "blurred" | "plain";
        event?: "blurred" | "plain";
     };
     navbar?: {
        transparent?: boolean;
     };
     twoColumnSplit?: [number, number];
   }
     | null;
  extendsBrandId: string | null;
  id: string;
  isActive: boolean;
  isBaseBrand: boolean;
  name: string;
  organisationId: string;
  shape: {
     radiusFull?: string;
     radiusLg?: string;
     radiusMd?: string;
     radiusNone?: string;
     radiusSm?: string;
  };
  typography: {
     baseSize?: string;
     fontFamily?: string;
     fontFamilyMono?: string;
     headingFontFamily?: string;
     headingFontWeight?: number;
     scaleRatio?: number;
  };
  updatedAt: string;
}[]>;

List brands List all branding entities for the organisation

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

listBrands

resolved()#

resolved: (id: string, requestOptions?: RequestOptions) => Promise<{
  accountId: string | null;
  brand: {
     displayName?: string;
     faviconUrl?: string;
     fontStylesheetUrl?: string;
     logoDarkUrl?: string;
     logoUrl?: string;
  };
  colors: {
     accent?: string;
     accentForeground?: string;
     background?: string;
     border?: string;
     destructive?: string;
     destructiveForeground?: string;
     foreground?: string;
     input?: string;
     muted?: string;
     mutedForeground?: string;
     primary?: string;
     primaryForeground?: string;
     ring?: string;
     secondary?: string;
     secondaryForeground?: string;
     success?: string;
     successForeground?: string;
     warning?: string;
     warningForeground?: string;
  };
  conciergePersona: {
     avatarAssetId?: string;
     greeting?: string;
     name?: string;
  };
  description: string | null;
  design:   | {
     buttonSize?: "small" | "medium" | "large";
     cinemaGradient?: {
        position: "bottom" | "center";
        strength: 20 | 50 | 70;
     };
     heroLayout?: {
        size: "small" | "medium" | "large";
        type: "hero" | "cinema";
     };
     modalHeader?: {
        channel?: "hidden" | "blurred" | "plain";
        event?: "blurred" | "plain";
     };
     navbar?: {
        transparent?: boolean;
     };
     twoColumnSplit?: [number, number];
   }
     | null;
  extendsBrandId: string | null;
  id: string;
  isActive: boolean;
  isBaseBrand: boolean;
  name: string;
  organisationId: string;
  shape: {
     radiusFull?: string;
     radiusLg?: string;
     radiusMd?: string;
     radiusNone?: string;
     radiusSm?: string;
  };
  typography: {
     baseSize?: string;
     fontFamily?: string;
     fontFamilyMono?: string;
     headingFontFamily?: string;
     headingFontWeight?: number;
     scaleRatio?: number;
  };
}>;

Get resolved brand Get a brand with its inheritance chain deep-merged (parent tokens overridden by the child)

Parameters#

Parameter	Type
`id`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string | null; brand: { displayName?: string; faviconUrl?: string; fontStylesheetUrl?: string; logoDarkUrl?: string; logoUrl?: string; }; colors: { accent?: string; accentForeground?: string; background?: string; border?: string; destructive?: string; destructiveForeground?: string; foreground?: string; input?: string; muted?: string; mutedForeground?: string; primary?: string; primaryForeground?: string; ring?: string; secondary?: string; secondaryForeground?: string; success?: string; successForeground?: string; warning?: string; warningForeground?: string; }; conciergePersona: { avatarAssetId?: string; greeting?: string; name?: string; }; description: string | null; design: | { buttonSize?: "small" | "medium" | "large"; cinemaGradient?: { position: "bottom" | "center"; strength: 20 | 50 | 70; }; heroLayout?: { size: "small" | "medium" | "large"; type: "hero" | "cinema"; }; modalHeader?: { channel?: "hidden" | "blurred" | "plain"; event?: "blurred" | "plain"; }; navbar?: { transparent?: boolean; }; twoColumnSplit?: [number, number]; } | null; extendsBrandId: string | null; id: string; isActive: boolean; isBaseBrand: boolean; name: string; organisationId: string; shape: { radiusFull?: string; radiusLg?: string; radiusMd?: string; radiusNone?: string; radiusSm?: string; }; typography: { baseSize?: string; fontFamily?: string; fontFamilyMono?: string; headingFontFamily?: string; headingFontWeight?: number; scaleRatio?: number; }; }>

Operation Id#

getResolvedBrand

update()#

update: (id: string, request: {
  brand?: {
     displayName?: string;
     faviconUrl?: string;
     fontStylesheetUrl?: string;
     logoDarkUrl?: string;
     logoUrl?: string;
     replyToEmail?: string;
  };
  colors?: {
     accent?: string;
     accentForeground?: string;
     background?: string;
     border?: string;
     destructive?: string;
     destructiveForeground?: string;
     foreground?: string;
     input?: string;
     muted?: string;
     mutedForeground?: string;
     primary?: string;
     primaryForeground?: string;
     ring?: string;
     secondary?: string;
     secondaryForeground?: string;
     success?: string;
     successForeground?: string;
     warning?: string;
     warningForeground?: string;
  };
  conciergePersona?: {
     avatarAssetId?: string;
     greeting?: string;
     name?: string;
  };
  description?: any;
  design?: any;
  extendsBrandId?: any;
  isActive?: boolean;
  isBaseBrand?: boolean;
  name?: string;
  shape?: {
     radiusFull?: string;
     radiusLg?: string;
     radiusMd?: string;
     radiusNone?: string;
     radiusSm?: string;
  };
  typography?: {
     baseSize?: string;
     fontFamily?: string;
     fontFamilyMono?: string;
     headingFontFamily?: string;
     headingFontWeight?: number;
     scaleRatio?: number;
  };
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string | null;
  brand: {
     displayName?: string;
     faviconUrl?: string;
     fontStylesheetUrl?: string;
     logoDarkUrl?: string;
     logoUrl?: string;
  };
  colors: {
     accent?: string;
     accentForeground?: string;
     background?: string;
     border?: string;
     destructive?: string;
     destructiveForeground?: string;
     foreground?: string;
     input?: string;
     muted?: string;
     mutedForeground?: string;
     primary?: string;
     primaryForeground?: string;
     ring?: string;
     secondary?: string;
     secondaryForeground?: string;
     success?: string;
     successForeground?: string;
     warning?: string;
     warningForeground?: string;
  };
  conciergePersona: {
     avatarAssetId?: string;
     greeting?: string;
     name?: string;
  };
  createdAt: string;
  description: string | null;
  design:   | {
     buttonSize?: "small" | "medium" | "large";
     cinemaGradient?: {
        position: "bottom" | "center";
        strength: 20 | 50 | 70;
     };
     heroLayout?: {
        size: "small" | "medium" | "large";
        type: "hero" | "cinema";
     };
     modalHeader?: {
        channel?: "hidden" | "blurred" | "plain";
        event?: "blurred" | "plain";
     };
     navbar?: {
        transparent?: boolean;
     };
     twoColumnSplit?: [number, number];
   }
     | null;
  extendsBrandId: string | null;
  id: string;
  isActive: boolean;
  isBaseBrand: boolean;
  name: string;
  organisationId: string;
  shape: {
     radiusFull?: string;
     radiusLg?: string;
     radiusMd?: string;
     radiusNone?: string;
     radiusSm?: string;
  };
  typography: {
     baseSize?: string;
     fontFamily?: string;
     fontFamilyMono?: string;
     headingFontFamily?: string;
     headingFontWeight?: number;
     scaleRatio?: number;
  };
  updatedAt: string;
}>;

Update brand Update an existing brand

Parameters#

Parameter	Type	Description
`id`	`string`	-
`request`	{ `brand?`: { `displayName?`: `string`; `faviconUrl?`: `string`; `fontStylesheetUrl?`: `string`; `logoDarkUrl?`: `string`; `logoUrl?`: `string`; `replyToEmail?`: `string`; }; `colors?`: { `accent?`: `string`; `accentForeground?`: `string`; `background?`: `string`; `border?`: `string`; `destructive?`: `string`; `destructiveForeground?`: `string`; `foreground?`: `string`; `input?`: `string`; `muted?`: `string`; `mutedForeground?`: `string`; `primary?`: `string`; `primaryForeground?`: `string`; `ring?`: `string`; `secondary?`: `string`; `secondaryForeground?`: `string`; `success?`: `string`; `successForeground?`: `string`; `warning?`: `string`; `warningForeground?`: `string`; }; `conciergePersona?`: { `avatarAssetId?`: `string`; `greeting?`: `string`; `name?`: `string`; }; `description?`: `any`; `design?`: `any`; `extendsBrandId?`: `any`; `isActive?`: `boolean`; `isBaseBrand?`: `boolean`; `name?`: `string`; `shape?`: { `radiusFull?`: `string`; `radiusLg?`: `string`; `radiusMd?`: `string`; `radiusNone?`: `string`; `radiusSm?`: `string`; }; `typography?`: { `baseSize?`: `string`; `fontFamily?`: `string`; `fontFamilyMono?`: `string`; `headingFontFamily?`: `string`; `headingFontWeight?`: `number`; `scaleRatio?`: `number`; }; }	-
`request.brand?`	{ `displayName?`: `string`; `faviconUrl?`: `string`; `fontStylesheetUrl?`: `string`; `logoDarkUrl?`: `string`; `logoUrl?`: `string`; `replyToEmail?`: `string`; }	-
`request.brand.displayName?`	`string`	-
`request.brand.faviconUrl?`	`string`	-
`request.brand.fontStylesheetUrl?`	`string`	Description A stylesheet that loads the brand's web fonts: https, on Google Fonts, Adobe Fonts or Bunny Fonts. The storefront and the Elements add it to the page once. Example `https://fonts.googleapis.com/css2?family=Anton&display=swap`
`request.brand.logoDarkUrl?`	`string`	-
`request.brand.logoUrl?`	`string`	-
`request.brand.replyToEmail?`	`string`	Format: email Description Where a reply to this brand's email goes; the sending address stays platform-wide Example `boxoffice@example.com`
`request.colors?`	{ `accent?`: `string`; `accentForeground?`: `string`; `background?`: `string`; `border?`: `string`; `destructive?`: `string`; `destructiveForeground?`: `string`; `foreground?`: `string`; `input?`: `string`; `muted?`: `string`; `mutedForeground?`: `string`; `primary?`: `string`; `primaryForeground?`: `string`; `ring?`: `string`; `secondary?`: `string`; `secondaryForeground?`: `string`; `success?`: `string`; `successForeground?`: `string`; `warning?`: `string`; `warningForeground?`: `string`; }	-
`request.colors.accent?`	`string`	-
`request.colors.accentForeground?`	`string`	-
`request.colors.background?`	`string`	-
`request.colors.border?`	`string`	-
`request.colors.destructive?`	`string`	-
`request.colors.destructiveForeground?`	`string`	-
`request.colors.foreground?`	`string`	-
`request.colors.input?`	`string`	-
`request.colors.muted?`	`string`	-
`request.colors.mutedForeground?`	`string`	-
`request.colors.primary?`	`string`	-
`request.colors.primaryForeground?`	`string`	-
`request.colors.ring?`	`string`	-
`request.colors.secondary?`	`string`	-
`request.colors.secondaryForeground?`	`string`	-
`request.colors.success?`	`string`	-
`request.colors.successForeground?`	`string`	-
`request.colors.warning?`	`string`	-
`request.colors.warningForeground?`	`string`	-
`request.conciergePersona?`	{ `avatarAssetId?`: `string`; `greeting?`: `string`; `name?`: `string`; }	-
`request.conciergePersona.avatarAssetId?`	`string`	Description A public image asset of the organisation's (POST /assets). The widget shows it to anyone. Example `ast_abc123`
`request.conciergePersona.greeting?`	`string`	Description The first thing the widget says. Example `Hello! Ask me anything about your visit.`
`request.conciergePersona.name?`	`string`	Description The name the widget speaks as. Unset everywhere, it is "Concierge". Example `Frank`
`request.description?`	`any`	-
`request.design?`	`any`	-
`request.extendsBrandId?`	`any`	-
`request.isActive?`	`boolean`	-
`request.isBaseBrand?`	`boolean`	-
`request.name?`	`string`	-
`request.shape?`	{ `radiusFull?`: `string`; `radiusLg?`: `string`; `radiusMd?`: `string`; `radiusNone?`: `string`; `radiusSm?`: `string`; }	-
`request.shape.radiusFull?`	`string`	-
`request.shape.radiusLg?`	`string`	-
`request.shape.radiusMd?`	`string`	-
`request.shape.radiusNone?`	`string`	-
`request.shape.radiusSm?`	`string`	-
`request.typography?`	{ `baseSize?`: `string`; `fontFamily?`: `string`; `fontFamilyMono?`: `string`; `headingFontFamily?`: `string`; `headingFontWeight?`: `number`; `scaleRatio?`: `number`; }	-
`request.typography.baseSize?`	`string`	-
`request.typography.fontFamily?`	`string`	Description The body font stack.
`request.typography.fontFamilyMono?`	`string`	-
`request.typography.headingFontFamily?`	`string`	Description The heading font stack. Headings follow the body font when it is not set. Example `'DM Serif Display', Georgia, serif`
`request.typography.headingFontWeight?`	`number`	Description The weight headings are set in (1-1000). A one-weight display face wants 400. Example `600`
`request.typography.scaleRatio?`	`number`	-
`requestOptions?`	`RequestOptions`	-

Returns#

Operation Id#

updateBrand