Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateBrandStylePayload

Interface: CreateBrandStylePayload

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:232

Payload for BrandStylesClient.createManually.

Example ​

typescript
const style = await client.brandStyles.createManually({
  name: 'Acme Brand',
  colours: [
    { type: 'brand',  hex: '#0066CC', brightness: 40 },
    { type: 'accent', hex: '#FF5500', brightness: 60 },
  ],
  links: [
    { type: 'website',  link: 'https://example.com' },
    { type: 'linkedin', link: 'https://linkedin.com/company/example' },
  ],
  fonts: [
    { type: 'title', name: 'Helvetica', origin: 'system' },
    { type: 'body',  name: 'Arial',     origin: 'system' },
  ],
});

Properties ​

colours? ​

optional colours?: BrandStyleColourEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:240

description? ​

optional description?: string | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:235

domain? ​

optional domain?: string | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:237

Domain to associate with the style.

fonts? ​

optional fonts?: BrandStyleFontEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:242

images? ​

optional images?: BrandStyleImageEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:243

isDefault? ​

optional isDefault?: boolean | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:239

Set this style as the account default.

optional links?: BrandStyleLinkEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:241

name ​

name: string

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:234

Brand style name. Required.