@goodsamsoftware/freshbooks-mcp 1.0.0

package/dist/tools/project/project-update.d.ts

@@ -0,0 +1,151 @@
+/**
+ * Project Update Tool
+ *
+ * Update an existing project in FreshBooks.
+ */
+import { z } from "zod";
+import { ProjectUpdateInputSchema, ProjectSingleOutputSchema } from "./schemas.js";
+import { FreshBooksClientWrapper } from "../../client/freshbooks-client.js";
+/**
+ * Tool definition for project_update
+ */
+export declare const projectUpdateTool: {
+    name: string;
+    description: string;
+    inputSchema: z.ZodObject<{
+        businessId: z.ZodNumber;
+        projectId: z.ZodNumber;
+        title: z.ZodOptional<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        dueDate: z.ZodOptional<z.ZodString>;
+        budget: z.ZodOptional<z.ZodString>;
+        fixedPrice: z.ZodOptional<z.ZodString>;
+        rate: z.ZodOptional<z.ZodString>;
+        billingMethod: z.ZodOptional<z.ZodEnum<["project_rate", "service_rate", "flat_rate", "team_member_rate"]>>;
+        projectType: z.ZodOptional<z.ZodEnum<["fixed_price", "hourly_rate"]>>;
+        internal: z.ZodOptional<z.ZodBoolean>;
+        projectManagerId: z.ZodOptional<z.ZodString>;
+        active: z.ZodOptional<z.ZodBoolean>;
+        complete: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        businessId: number;
+        projectId: number;
+        description?: string | undefined;
+        title?: string | undefined;
+        clientId?: string | undefined;
+        active?: boolean | undefined;
+        internal?: boolean | undefined;
+        dueDate?: string | undefined;
+        budget?: string | undefined;
+        fixedPrice?: string | undefined;
+        rate?: string | undefined;
+        billingMethod?: "project_rate" | "service_rate" | "flat_rate" | "team_member_rate" | undefined;
+        projectType?: "fixed_price" | "hourly_rate" | undefined;
+        projectManagerId?: string | undefined;
+        complete?: boolean | undefined;
+    }, {
+        businessId: number;
+        projectId: number;
+        description?: string | undefined;
+        title?: string | undefined;
+        clientId?: string | undefined;
+        active?: boolean | undefined;
+        internal?: boolean | undefined;
+        dueDate?: string | undefined;
+        budget?: string | undefined;
+        fixedPrice?: string | undefined;
+        rate?: string | undefined;
+        billingMethod?: "project_rate" | "service_rate" | "flat_rate" | "team_member_rate" | undefined;
+        projectType?: "fixed_price" | "hourly_rate" | undefined;
+        projectManagerId?: string | undefined;
+        complete?: boolean | undefined;
+    }>;
+    outputSchema: z.ZodObject<{
+        id: z.ZodNumber;
+        title: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        dueDate: z.ZodNullable<z.ZodString>;
+        clientId: z.ZodNullable<z.ZodString>;
+        internal: z.ZodBoolean;
+        budget: z.ZodNullable<z.ZodString>;
+        fixedPrice: z.ZodNullable<z.ZodString>;
+        rate: z.ZodNullable<z.ZodString>;
+        billingMethod: z.ZodNullable<z.ZodEnum<["project_rate", "service_rate", "flat_rate", "team_member_rate"]>>;
+        projectType: z.ZodEnum<["fixed_price", "hourly_rate"]>;
+        projectManagerId: z.ZodNullable<z.ZodString>;
+        active: z.ZodBoolean;
+        complete: z.ZodBoolean;
+        sample: z.ZodBoolean;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        loggedDuration: z.ZodNullable<z.ZodNumber>;
+        services: z.ZodNullable<z.ZodArray<z.ZodAny, "many">>;
+        billedAmount: z.ZodNumber;
+        billedStatus: z.ZodEnum<["unbilled", "partial", "billed"]>;
+        retainerId: z.ZodNullable<z.ZodString>;
+        expenseMarkup: z.ZodNumber;
+        groupId: z.ZodNullable<z.ZodString>;
+        group: z.ZodNullable<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        description: string | null;
+        title: string;
+        createdAt: string;
+        id: number;
+        clientId: string | null;
+        active: boolean;
+        internal: boolean;
+        retainerId: string | null;
+        services: any[] | null;
+        dueDate: string | null;
+        budget: string | null;
+        fixedPrice: string | null;
+        rate: string | null;
+        billingMethod: "project_rate" | "service_rate" | "flat_rate" | "team_member_rate" | null;
+        projectType: "fixed_price" | "hourly_rate";
+        projectManagerId: string | null;
+        complete: boolean;
+        sample: boolean;
+        updatedAt: string;
+        loggedDuration: number | null;
+        billedAmount: number;
+        billedStatus: "unbilled" | "partial" | "billed";
+        expenseMarkup: number;
+        groupId: string | null;
+        group?: any;
+    }, {
+        description: string | null;
+        title: string;
+        createdAt: string;
+        id: number;
+        clientId: string | null;
+        active: boolean;
+        internal: boolean;
+        retainerId: string | null;
+        services: any[] | null;
+        dueDate: string | null;
+        budget: string | null;
+        fixedPrice: string | null;
+        rate: string | null;
+        billingMethod: "project_rate" | "service_rate" | "flat_rate" | "team_member_rate" | null;
+        projectType: "fixed_price" | "hourly_rate";
+        projectManagerId: string | null;
+        complete: boolean;
+        sample: boolean;
+        updatedAt: string;
+        loggedDuration: number | null;
+        billedAmount: number;
+        billedStatus: "unbilled" | "partial" | "billed";
+        expenseMarkup: number;
+        groupId: string | null;
+        group?: any;
+    }>;
+    execute(input: z.infer<typeof ProjectUpdateInputSchema>, client: FreshBooksClientWrapper): Promise<z.infer<typeof ProjectSingleOutputSchema>>;
+};
+/**
+ * Wrapped handler for backward compatibility with tests
+ */
+export declare function handleProjectUpdate(input: z.infer<typeof ProjectUpdateInputSchema>, context: {
+    client: FreshBooksClientWrapper;
+}): Promise<z.infer<typeof ProjectSingleOutputSchema>>;
+//# sourceMappingURL=project-update.d.ts.map

package/dist/tools/project/project-update.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-update.d.ts","sourceRoot":"","sources":["../../../src/tools/project/project-update.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAGnF,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA6CnB,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,UACvC,uBAAuB,GAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;CA+CtD,CAAC;AAEF;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,EAC/C,OAAO,EAAE;IAAE,MAAM,EAAE,uBAAuB,CAAA;CAAE,GAC3C,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAEpD"}

package/dist/tools/project/project-update.js

@@ -0,0 +1,106 @@
+/**
+ * Project Update Tool
+ *
+ * Update an existing project in FreshBooks.
+ */
+import { ProjectUpdateInputSchema, ProjectSingleOutputSchema } from "./schemas.js";
+import { ErrorHandler } from "../../errors/error-handler.js";
+/**
+ * Tool definition for project_update
+ */
+export const projectUpdateTool = {
+    name: "project_update",
+    description: `Update an existing project in FreshBooks.
+
+WHEN TO USE:
+- User wants to modify project details
+- User says "update project", "change project", "mark project complete"
+- Adjusting billing rates, due dates, or status
+
+REQUIRED INFO:
+- projectId: Which project to update (numeric)
+- accountId: FreshBooks account (get from context)
+
+UPDATABLE FIELDS:
+- title: Change project name
+- description: Update project description
+- dueDate: Change completion deadline (ISO 8601)
+- clientId: Reassign to different client
+- billingMethod: Change how project is billed
+- rate: Update hourly rate
+- fixedPrice: Change fixed price amount
+- budget: Adjust project budget
+- active: Activate or deactivate project
+- complete: Mark project as complete/incomplete
+- internal: Change billable status
+
+STATUS CHANGES:
+- Set active=false to pause project (stops appearing in active lists)
+- Set complete=true to mark project done
+- Both can be combined for archival
+
+EXAMPLE PROMPTS:
+- "Mark project 12345 as complete"
+- "Update project Website Redesign to increase rate to $150/hr"
+- "Change project 98765 due date to next Friday"
+- "Deactivate project Mobile App"
+
+RETURNS:
+Updated project with all current settings. Changes take effect immediately
+for new time entries.`,
+    inputSchema: ProjectUpdateInputSchema,
+    outputSchema: ProjectSingleOutputSchema,
+    async execute(input, client) {
+        const handler = ErrorHandler.wrapHandler("project_update", async (input, _context) => {
+            const { businessId, projectId, ...updates } = input;
+            // Build update object using camelCase properties
+            // The FreshBooks SDK's transformProjectRequest() will convert to API format
+            const project = {};
+            if (updates.title !== undefined)
+                project.title = updates.title;
+            if (updates.clientId !== undefined)
+                project.clientId = updates.clientId;
+            if (updates.description !== undefined)
+                project.description = updates.description;
+            if (updates.dueDate !== undefined)
+                project.dueDate = updates.dueDate;
+            if (updates.budget !== undefined)
+                project.budget = updates.budget;
+            if (updates.fixedPrice !== undefined)
+                project.fixedPrice = updates.fixedPrice;
+            if (updates.rate !== undefined)
+                project.rate = updates.rate;
+            if (updates.billingMethod !== undefined)
+                project.billingMethod = updates.billingMethod;
+            if (updates.projectType !== undefined)
+                project.projectType = updates.projectType;
+            if (updates.internal !== undefined)
+                project.internal = updates.internal;
+            if (updates.projectManagerId !== undefined)
+                project.projectManagerId = updates.projectManagerId;
+            if (updates.active !== undefined)
+                project.active = updates.active;
+            if (updates.complete !== undefined)
+                project.complete = updates.complete;
+            // Execute the API call
+            const result = await client.executeWithRetry("project_update", async (fbClient) => {
+                const response = await fbClient.projects.update(project, businessId, projectId);
+                if (!response.ok) {
+                    throw response.error;
+                }
+                return response.data;
+            });
+            // FreshBooks returns: { project: { ... } }
+            const updatedProject = result.project ?? result;
+            return updatedProject;
+        });
+        return handler(input, { businessId: input.businessId });
+    },
+};
+/**
+ * Wrapped handler for backward compatibility with tests
+ */
+export async function handleProjectUpdate(input, context) {
+    return projectUpdateTool.execute(input, context.client);
+}
+//# sourceMappingURL=project-update.js.map

package/dist/tools/project/project-update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-update.js","sourceRoot":"","sources":["../../../src/tools/project/project-update.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AACnF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAI7D;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAqCO;IAEpB,WAAW,EAAE,wBAAwB;IACrC,YAAY,EAAE,yBAAyB;IAEvC,KAAK,CAAC,OAAO,CACX,KAA+C,EAC/C,MAA+B;QAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CACtC,gBAAgB,EAChB,KAAK,EAAE,KAA+C,EAAE,QAAqB,EAAE,EAAE;YAC/E,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC;YAEpD,iDAAiD;YACjD,4EAA4E;YAC5E,MAAM,OAAO,GAA4B,EAAE,CAAC;YAE5C,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;gBAAE,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;YAC/D,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YACxE,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;gBAAE,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YACjF,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;gBAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YACrE,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAClE,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS;gBAAE,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;YAC9E,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;gBAAE,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YAC5D,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;gBAAE,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;YACvF,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;gBAAE,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YACjF,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YACxE,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS;gBAAE,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;YAChG,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAClE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAExE,uBAAuB;YACvB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAC1C,gBAAgB,EAChB,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACjB,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;gBAEhF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,QAAQ,CAAC,KAAK,CAAC;gBACvB,CAAC;gBAED,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC,CACF,CAAC;YAEF,2CAA2C;YAC3C,MAAM,cAAc,GAAI,MAAgC,CAAC,OAAO,IAAI,MAAM,CAAC;YAE3E,OAAO,cAA2D,CAAC;QACrE,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,KAA+C,EAC/C,OAA4C;IAE5C,OAAO,iBAAiB,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;AAC1D,CAAC"}