To manipulate the brands, access the brands object on the SDK. Through that, you can invoke all brand methods mentioned, like this:
const brand = await sdk.brands.getBrand({
designSystemId, versionId
})
Read methods
Fetch all remote brands in a version
Retrieves all brands associated with a specified design system version.
async getBrands(from: RemoteVersionIdentifier): Promise<Array<Brand>>
Fetch a specific brand
Fetches a specific brand using the provided identifiers for design system, version, and brand.
async getBrand(from: RemoteBrandIdentifier): Promise<Brand>
Create/update methods
Create a new brand
Creates a new brand for a specified design system version and retrieves the newly created brand object.
async createBrand(from: RemoteVersionIdentifier, model: BrandUpdateModel): Promise<Brand>
Edit a specific brand
Updates the details of a specific brand using the provided identifiers and the updated brand details.
async editBrand(from: RemoteBrandIdentifier, brand: Brand): Promise<void>
Delete methods
Delete a specific brand
Deletes a specific brand using the provided identifiers for design system, version, and brand.
async deleteBrand(from: RemoteBrandIdentifier): Promise<void>