@goodsamsoftware/freshbooks-mcp 1.0.0

package/dist/tools/other-income/otherincome-update.d.ts

@@ -0,0 +1,155 @@
+/**
+ * OtherIncome Update Tool
+ *
+ * Update an existing other income entry in FreshBooks.
+ */
+import { z } from "zod";
+import { OtherIncomeUpdateInputSchema, OtherIncomeSingleOutputSchema } from "./schemas.js";
+import { FreshBooksClientWrapper } from "../../client/index.js";
+/**
+ * Tool definition for otherincome_update
+ */
+export declare const otherincomeUpdateTool: {
+    name: string;
+    description: string;
+    inputSchema: z.ZodObject<{
+        accountId: z.ZodString;
+        incomeId: z.ZodNumber;
+        amount: z.ZodOptional<z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>>;
+        categoryName: z.ZodOptional<z.ZodString>;
+        date: z.ZodOptional<z.ZodString>;
+        paymentType: z.ZodOptional<z.ZodEnum<["Cash", "Check", "Credit", "Bank Transfer", "Debit", "PayPal", "Credit Card", "Other", "2Checkout", "Interac", "Visa", "MasterCard", "Discover", "Nova", "AMEX", "ACH"]>>;
+        note: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        taxes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            amount: z.ZodString;
+            percent: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }, {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        accountId: string;
+        incomeId: number;
+        date?: string | undefined;
+        amount?: {
+            code: string;
+            amount: string;
+        } | undefined;
+        note?: string | undefined;
+        paymentType?: "Check" | "Credit" | "Cash" | "Bank Transfer" | "Debit" | "PayPal" | "Credit Card" | "Other" | "2Checkout" | "ACH" | "Interac" | "Visa" | "MasterCard" | "Discover" | "Nova" | "AMEX" | undefined;
+        categoryName?: string | undefined;
+        source?: string | undefined;
+        taxes?: {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }[] | undefined;
+    }, {
+        accountId: string;
+        incomeId: number;
+        date?: string | undefined;
+        amount?: {
+            code: string;
+            amount: string;
+        } | undefined;
+        note?: string | undefined;
+        paymentType?: "Check" | "Credit" | "Cash" | "Bank Transfer" | "Debit" | "PayPal" | "Credit Card" | "Other" | "2Checkout" | "ACH" | "Interac" | "Visa" | "MasterCard" | "Discover" | "Nova" | "AMEX" | undefined;
+        categoryName?: string | undefined;
+        source?: string | undefined;
+        taxes?: {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }[] | undefined;
+    }>;
+    outputSchema: z.ZodObject<{
+        incomeId: z.ZodNumber;
+        amount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        categoryName: z.ZodString;
+        createdAt: z.ZodString;
+        date: z.ZodString;
+        note: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        paymentType: z.ZodEnum<["Cash", "Check", "Credit", "Bank Transfer", "Debit", "PayPal", "Credit Card", "Other", "2Checkout", "Interac", "Visa", "MasterCard", "Discover", "Nova", "AMEX", "ACH"]>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        taxes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            amount: z.ZodString;
+            percent: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }, {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }>, "many">>;
+        updated: z.ZodOptional<z.ZodString>;
+        visState: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+    }, "strip", z.ZodTypeAny, {
+        date: string;
+        createdAt: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        paymentType: "Check" | "Credit" | "Cash" | "Bank Transfer" | "Debit" | "PayPal" | "Credit Card" | "Other" | "2Checkout" | "ACH" | "Interac" | "Visa" | "MasterCard" | "Discover" | "Nova" | "AMEX";
+        incomeId: number;
+        categoryName: string;
+        note?: string | null | undefined;
+        visState?: 0 | 1 | 2 | undefined;
+        updated?: string | undefined;
+        source?: string | null | undefined;
+        taxes?: {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }[] | undefined;
+    }, {
+        date: string;
+        createdAt: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        paymentType: "Check" | "Credit" | "Cash" | "Bank Transfer" | "Debit" | "PayPal" | "Credit Card" | "Other" | "2Checkout" | "ACH" | "Interac" | "Visa" | "MasterCard" | "Discover" | "Nova" | "AMEX";
+        incomeId: number;
+        categoryName: string;
+        note?: string | null | undefined;
+        visState?: 0 | 1 | 2 | undefined;
+        updated?: string | undefined;
+        source?: string | null | undefined;
+        taxes?: {
+            name: string;
+            amount: string;
+            percent?: string | undefined;
+        }[] | undefined;
+    }>;
+    execute(input: z.infer<typeof OtherIncomeUpdateInputSchema>, client: FreshBooksClientWrapper): Promise<z.infer<typeof OtherIncomeSingleOutputSchema>>;
+};
+//# sourceMappingURL=otherincome-update.d.ts.map

package/dist/tools/other-income/otherincome-update.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otherincome-update.d.ts","sourceRoot":"","sources":["../../../src/tools/other-income/otherincome-update.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,MAAM,cAAc,CAAC;AAG3F,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmCvB,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,UAC3C,uBAAuB,GAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;CA6C1D,CAAC"}

package/dist/tools/other-income/otherincome-update.js

@@ -0,0 +1,84 @@
+/**
+ * OtherIncome Update Tool
+ *
+ * Update an existing other income entry in FreshBooks.
+ */
+import { OtherIncomeUpdateInputSchema, OtherIncomeSingleOutputSchema } from "./schemas.js";
+import { ErrorHandler } from "../../errors/error-handler.js";
+/**
+ * Tool definition for otherincome_update
+ */
+export const otherincomeUpdateTool = {
+    name: "otherincome_update",
+    description: `Update an existing other income entry in FreshBooks.
+
+WHEN TO USE:
+- User needs to correct other income details
+- User says "update other income", "fix income entry", "change income amount"
+- User wants to update amount, category, date, or other details
+
+REQUIRED INFO:
+- incomeId: Income entry to update
+- accountId: FreshBooks account (get from context)
+
+UPDATABLE FIELDS:
+- amount: Correct the income amount
+- categoryName: Change the category
+- date: Adjust income date
+- paymentType: Change payment method
+- note: Update description
+- source: Update income source
+- taxes: Update tax information
+
+EXAMPLE PROMPTS:
+- "Update other income #12345 to $75"
+- "Change income entry 67890 category to 'Interest'"
+- "Fix other income 555 - date should be January 20"
+- "Update income note to include bank name"
+
+RETURNS:
+Updated other income entry with modified fields.`,
+    inputSchema: OtherIncomeUpdateInputSchema,
+    outputSchema: OtherIncomeSingleOutputSchema,
+    async execute(input, client) {
+        const handler = ErrorHandler.wrapHandler('otherincome_update', async (input, _context) => {
+            const { accountId, incomeId, ...updates } = input;
+            // Build update object using camelCase properties
+            // The FreshBooks SDK's transformOtherIncomeRequest() will convert to API format
+            const otherIncome = {};
+            if (updates.amount !== undefined)
+                otherIncome.amount = updates.amount;
+            if (updates.categoryName !== undefined)
+                otherIncome.categoryName = updates.categoryName;
+            if (updates.date !== undefined)
+                otherIncome.date = updates.date;
+            if (updates.paymentType !== undefined)
+                otherIncome.paymentType = updates.paymentType;
+            if (updates.note !== undefined)
+                otherIncome.note = updates.note;
+            if (updates.source !== undefined)
+                otherIncome.source = updates.source;
+            if (updates.taxes !== undefined) {
+                otherIncome.taxes = updates.taxes.map(tax => ({
+                    name: tax.name,
+                    amount: tax.amount,
+                    percent: tax.percent,
+                }));
+            }
+            const result = await client.executeWithRetry('otherincome_update', async (fbClient) => {
+                const response = await fbClient.otherIncomes.update(accountId, String(incomeId), otherIncome);
+                if (!response.ok) {
+                    throw response.error;
+                }
+                return response.data;
+            });
+            // FreshBooks returns: { other_income: { ... } }
+            const updatedIncome = result.other_income
+                ?? result.otherIncome
+                ?? result;
+            return updatedIncome;
+        });
+        return handler(input, { accountId: input.accountId });
+    },
+};
+//# sourceMappingURL=otherincome-update.js.map

package/dist/tools/other-income/otherincome-update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otherincome-update.js","sourceRoot":"","sources":["../../../src/tools/other-income/otherincome-update.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,MAAM,cAAc,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAI7D;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,oBAAoB;IAC1B,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;iDA2BkC;IAE/C,WAAW,EAAE,4BAA4B;IACzC,YAAY,EAAE,6BAA6B;IAE3C,KAAK,CAAC,OAAO,CACX,KAAmD,EACnD,MAA+B;QAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CACtC,oBAAoB,EACpB,KAAK,EAAE,KAAmD,EAAE,QAAqB,EAAE,EAAE;YACnF,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC;YAElD,iDAAiD;YACjD,gFAAgF;YAChF,MAAM,WAAW,GAA4B,EAAE,CAAC;YAEhD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAAE,WAAW,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YACtE,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS;gBAAE,WAAW,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;YACxF,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;gBAAE,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YAChE,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;gBAAE,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YACrF,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;gBAAE,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YAChE,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAAE,WAAW,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YACtE,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,WAAW,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC5C,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,OAAO,EAAE,GAAG,CAAC,OAAO;iBACrB,CAAC,CAAC,CAAC;YACN,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACpF,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,WAAkB,CAAC,CAAC;gBAErG,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,QAAQ,CAAC,KAAK,CAAC;gBACvB,CAAC;gBAED,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC,CAAC,CAAC;YAEH,gDAAgD;YAChD,MAAM,aAAa,GAAI,MAA4D,CAAC,YAAY;mBAC1F,MAA4D,CAAC,WAAW;mBACzE,MAAM,CAAC;YAEZ,OAAO,aAA8D,CAAC;QACxE,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC;CACF,CAAC"}