Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / BrandStyle

Interface: BrandStyle

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

Full brand style detail as returned by BrandStylesClient.get.

Properties ​

accountId ​

accountId: number

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

ID of the account this brand style belongs to.

colours? ​

optional colours?: BrandStyleColour[] | null

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

createdAt ​

createdAt: string

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

description? ​

optional description?: string | null

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

domain? ​

optional domain?: string | null

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

Domain the style was auto-detected from, if applicable.

fonts? ​

optional fonts?: BrandStyleFont[] | null

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

id ​

id: number

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

images? ​

optional images?: BrandStyleImage[] | null

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

isDefault ​

isDefault: boolean

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

Whether this is the account's default brand style.

The default style is used when no specific style is requested.

isFetchable? ​

optional isFetchable?: boolean | null

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

Whether the brand assets can be re-fetched from the domain.

Only relevant for styles created via BrandStylesClient.createFromDomain.

optional links?: BrandStyleLink[] | null

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

name ​

name: string

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

Human-readable name.

updatedAt ​

updatedAt: string

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