updateCompany
Modify company details in Teamwork, including address, contact information, and tags, by providing the company ID and updated data.
Instructions
This tool allows you to update a company. It requires parameters: companyId and companyRequest.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| companyId | Yes | Path parameter: companyId | |
| companyRequest | Yes | ||
| options | No | Additional options for the request |
Implementation Reference
- The handler function for the 'updateCompany' tool. It extracts companyId and companyRequest from input, validates them, calls the teamwork service to update the company, and returns the result or error response.export async function handleUpdateCompany(input: any) { logger.info('Calling teamworkService.updateCompany()'); logger.info(`Company ID: ${input?.companyId}`); try { const companyId = input.companyId; const companyData = input.companyRequest; if (!companyId) { throw new Error("Company ID is required"); } if (!companyData) { throw new Error("Company data is required for update"); } const result = await teamworkService.updateCompany(companyId, companyData); logger.info(`Company updated successfully with ID: ${companyId}`); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } catch (error: any) { return createErrorResponse(error, 'Updating company'); } }
- The tool definition object containing the name, description, inputSchema (with detailed properties for company update data), required fields, and annotations.export const updateCompanyDefinition = { name: "updateCompany", description: "This tool allows you to update a company. It requires parameters: companyId and companyRequest.", inputSchema: { type: 'object', properties: { companyId: { type: 'integer', description: 'Path parameter: companyId' }, companyRequest: { type: 'object', properties: { addressOne: { type: 'string', description: 'First line of address' }, addressTwo: { type: 'string', description: 'Second line of address' }, city: { type: 'string', description: 'City' }, company: { type: 'object', properties: { name: { type: 'string', description: 'Company name' } } }, countryCode: { type: 'string', description: 'Country code' }, emailOne: { type: 'string', description: 'First email address' }, emailTwo: { type: 'string', description: 'Second email address' }, fax: { type: 'string', description: 'Fax number' }, name: { type: 'string', description: 'Company name' }, phone: { type: 'string', description: 'Phone number' }, state: { type: 'string', description: 'State' }, tags: { type: 'array', items: { type: 'string' }, description: 'List of tags' }, website: { type: 'string', description: 'Website URL' }, zip: { type: 'string', description: 'ZIP/Postal code' } } }, options: { type: 'object', properties: {}, description: 'Additional options for the request' } }, required: [ 'companyId', 'companyRequest' ] }, annotations: { title: "Update Company", readOnlyHint: false, destructiveHint: false, openWorldHint: false } };
- src/tools/index.ts:38-42 (registration)Imports the updateCompanyDefinition and handleUpdateCompany from the specific tool file, aliased for registration in the tools index.import { createCompanyDefinition as createCompany, handleCreateCompany } from './companies/createCompany.js'; import { updateCompanyDefinition as updateCompany, handleUpdateCompany } from './companies/updateCompany.js'; import { deleteCompanyDefinition as deleteCompany, handleDeleteCompany } from './companies/deleteCompany.js'; import { getCompaniesDefinition as getCompanies, handleGetCompanies } from './companies/getCompanies.js'; import { getCompanyByIdDefinition as getCompanyById, handleGetCompanyById } from './companies/getCompanyById.js';
- src/tools/index.ts:89-91 (registration)Adds the updateCompany tool to the toolPairs array, pairing its definition with the handler function for global registration.{ definition: createCompany, handler: handleCreateCompany }, { definition: updateCompany, handler: handleUpdateCompany }, { definition: deleteCompany, handler: handleDeleteCompany },
- Helper service function that makes the actual PATCH API request to Teamwork to update the company data.export const updateCompany = async (companyId: number, companyData: any) => { try { logger.info(`Updating company with ID ${companyId}`); const api = ensureApiClient(); const response = await api.patch(`companies/${companyId}.json`, companyData); logger.info(`Successfully updated company with ID ${companyId}`); return response.data; } catch (error: any) { logger.error(`Error updating company with ID ${companyId}: ${error.message}`); throw new Error(`Failed to update company with ID ${companyId}: ${error.message}`); } };