Brand methods: clear
The Brand Verbs clear as typed SDK methods, with inputs, result, refusals and an example.
Reference for Brand, one group of Brand methods.
Brand.clear
Clear checks a proposed Brand name against trademark registers, Domain availability and the Startup’s handles on outside platforms in one call. Verb page.
interface BrandVerbs {
clear(input: BrandClearInput, options?: SB.CallOptions): SB.Call<BrandClearOutput>
}Emits Brand.cleared.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
brand | Brand | required | The Brand whose name to check. |
markets | list of Market | The Markets whose registers to search. Defaults to the Startup’s Markets. | |
classes | integer[] | Trademark classes. Defaults to the classes of the Startup’s Products. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
verdict | string | required | clear lets the name ship, conflict blocks it, review waits for the Legal Lead. |
findings | json | required | Each similar mark, taken Domain or taken handle, with the register or platform it was found on. |
brand | Brand | required | The Brand whose name was checked. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const { verdict, findings, brand } = await $.Brand.clear({ brand: 'brand_PluVQrB1HF' })