CompanyResource
API reference for the Company resource.
Methods
getCurrent
Get current company details.
typescript
async getCurrent(): Promise<Company>update
Update company information.
typescript
async update(id: string, data: UpdateCompanyInput): Promise<Company>Parameters:
typescript
interface UpdateCompanyInput {
name?: string;
industry?: string;
size?: string;
website?: string;
address?: string;
phone?: string;
logo?: string;
settings?: Record<string, unknown>;
}updateSettings
Update company settings by category.
typescript
async updateSettings(settings: Record<string, unknown>, category?: string): Promise<Record<string, unknown>>uploadLogo
Upload a company logo.
typescript
async uploadLogo(logoData: string): Promise<{ url: string }>Types
Company
typescript
interface Company {
id: string;
type: 'company';
name: string;
industry?: string;
size?: string;
website?: string;
address?: string;
phone?: string;
logo?: string;
settings?: Record<string, unknown>;
createdAt: Date;
updatedAt: Date;
}Example
typescript
// Get company info
const company = await client.company.getCurrent();
console.log(`Company: ${company.name}`);
// Update settings
await client.company.updateSettings({
notifications: true,
timezone: 'UTC',
}, 'general');