@tryfinch/finch-api-mcp 6.22.1

package/src/tools/sandbox/individual/update-sandbox-individual.ts

@@ -0,0 +1,149 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Finch from '@tryfinch/finch-api';
+
+export const metadata: Metadata = {
+  resource: 'sandbox.individual',
+  operation: 'write',
+  tags: [],
+};
+
+export const tool: Tool = {
+  name: 'update_sandbox_individual',
+  description: 'Update sandbox individual',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      individual_id: {
+        type: 'string',
+      },
+      dob: {
+        type: 'string',
+        title: 'Date',
+      },
+      emails: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            data: {
+              type: 'string',
+            },
+            type: {
+              type: 'string',
+              enum: ['work', 'personal'],
+            },
+          },
+          required: [],
+        },
+      },
+      encrypted_ssn: {
+        type: 'string',
+        description:
+          "Social Security Number of the individual in **encrypted** format. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body.",
+      },
+      ethnicity: {
+        type: 'string',
+        description: 'The EEOC-defined ethnicity of the individual.',
+        enum: [
+          'asian',
+          'white',
+          'black_or_african_american',
+          'native_hawaiian_or_pacific_islander',
+          'american_indian_or_alaska_native',
+          'hispanic_or_latino',
+          'two_or_more_races',
+          'decline_to_specify',
+        ],
+      },
+      first_name: {
+        type: 'string',
+        description: 'The legal first name of the individual.',
+      },
+      gender: {
+        type: 'string',
+        description: 'The gender of the individual.',
+        enum: ['female', 'male', 'other', 'decline_to_specify'],
+      },
+      last_name: {
+        type: 'string',
+        description: 'The legal last name of the individual.',
+      },
+      middle_name: {
+        type: 'string',
+        description: 'The legal middle name of the individual.',
+      },
+      phone_numbers: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            data: {
+              type: 'string',
+            },
+            type: {
+              type: 'string',
+              enum: ['work', 'personal'],
+            },
+          },
+          required: [],
+        },
+      },
+      preferred_name: {
+        type: 'string',
+        description: 'The preferred name of the individual.',
+      },
+      residence: {
+        type: 'object',
+        title: 'Location',
+        properties: {
+          city: {
+            type: 'string',
+            description: 'City, district, suburb, town, or village.',
+          },
+          country: {
+            type: 'string',
+            description: 'The 2-letter ISO 3166 country code.',
+          },
+          line1: {
+            type: 'string',
+            description: 'Street address or PO box.',
+          },
+          line2: {
+            type: 'string',
+            description: 'Apartment, suite, unit, or building.',
+          },
+          name: {
+            type: 'string',
+          },
+          postal_code: {
+            type: 'string',
+            description: 'The postal code or zip code.',
+          },
+          source_id: {
+            type: 'string',
+          },
+          state: {
+            type: 'string',
+            description: 'The state code.',
+          },
+        },
+        required: [],
+      },
+      ssn: {
+        type: 'string',
+        description:
+          "Social Security Number of the individual. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).",
+      },
+    },
+  },
+};
+
+export const handler = (client: Finch, args: any) => {
+  const { individual_id, ...body } = args;
+  return client.sandbox.individual.update(individual_id, body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Finch from '@tryfinch/finch-api';
+
+export const metadata: Metadata = {
+  resource: 'sandbox.jobs.configuration',
+  operation: 'read',
+  tags: [],
+};
+
+export const tool: Tool = {
+  name: 'retrieve_jobs_sandbox_configuration',
+  description: 'Get configurations for sandbox jobs',
+  inputSchema: {
+    type: 'object',
+    properties: {},
+  },
+};
+
+export const handler = (client: Finch, args: any) => {
+  const {} = args;
+  return client.sandbox.jobs.configuration.retrieve();
+};
+
+export default { metadata, tool, handler };

package/src/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.ts

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Finch from '@tryfinch/finch-api';
+
+export const metadata: Metadata = {
+  resource: 'sandbox.jobs.configuration',
+  operation: 'write',
+  tags: [],
+};
+
+export const tool: Tool = {
+  name: 'update_jobs_sandbox_configuration',
+  description: 'Update configurations for sandbox jobs',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      completion_status: {
+        type: 'string',
+        enum: ['complete', 'reauth_error', 'permissions_error', 'error'],
+      },
+      type: {
+        type: 'string',
+        enum: ['data_sync_all'],
+      },
+    },
+  },
+};
+
+export const handler = (client: Finch, args: any) => {
+  const { ...body } = args;
+  return client.sandbox.jobs.configuration.update(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/sandbox/jobs/create-sandbox-jobs.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Finch from '@tryfinch/finch-api';
+
+export const metadata: Metadata = {
+  resource: 'sandbox.jobs',
+  operation: 'write',
+  tags: [],
+};
+
+export const tool: Tool = {
+  name: 'create_sandbox_jobs',
+  description: 'Enqueue a new sandbox job',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      type: {
+        type: 'string',
+        description: 'The type of job to start. Currently the only supported type is `data_sync_all`',
+        enum: ['data_sync_all'],
+      },
+    },
+  },
+};
+
+export const handler = (client: Finch, args: any) => {
+  const { ...body } = args;
+  return client.sandbox.jobs.create(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/sandbox/payment/create-sandbox-payment.ts

@@ -0,0 +1,300 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Finch from '@tryfinch/finch-api';
+
+export const metadata: Metadata = {
+  resource: 'sandbox.payment',
+  operation: 'write',
+  tags: [],
+};
+
+export const tool: Tool = {
+  name: 'create_sandbox_payment',
+  description: 'Add a new sandbox payment',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      end_date: {
+        type: 'string',
+      },
+      pay_statements: {
+        type: 'array',
+        items: {
+          type: 'object',
+          title: 'Pay Statement',
+          properties: {
+            earnings: {
+              type: 'array',
+              description: 'The array of earnings objects associated with this pay statement',
+              items: {
+                type: 'object',
+                properties: {
+                  amount: {
+                    type: 'integer',
+                    description: 'The earnings amount in cents.',
+                  },
+                  attributes: {
+                    type: 'object',
+                    properties: {
+                      metadata: {
+                        type: 'object',
+                        properties: {
+                          metadata: {
+                            type: 'object',
+                            description:
+                              'The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).',
+                          },
+                        },
+                        required: [],
+                      },
+                    },
+                    required: [],
+                  },
+                  currency: {
+                    type: 'string',
+                    description: 'The earnings currency code.',
+                  },
+                  hours: {
+                    type: 'number',
+                    description:
+                      'The number of hours associated with this earning. (For salaried employees, this could be hours per pay period, `0` or `null`, depending on the provider).',
+                  },
+                  name: {
+                    type: 'string',
+                    description: 'The exact name of the deduction from the pay statement.',
+                  },
+                  type: {
+                    type: 'string',
+                    description: 'The type of earning.',
+                    enum: [
+                      'salary',
+                      'wage',
+                      'reimbursement',
+                      'overtime',
+                      'severance',
+                      'double_overtime',
+                      'pto',
+                      'sick',
+                      'bonus',
+                      'commission',
+                      'tips',
+                      '1099',
+                      'other',
+                    ],
+                  },
+                },
+                required: [],
+              },
+            },
+            employee_deductions: {
+              type: 'array',
+              description: 'The array of deductions objects associated with this pay statement.',
+              items: {
+                type: 'object',
+                properties: {
+                  amount: {
+                    type: 'integer',
+                    description: 'The deduction amount in cents.',
+                  },
+                  attributes: {
+                    type: 'object',
+                    properties: {
+                      metadata: {
+                        type: 'object',
+                        properties: {
+                          metadata: {
+                            type: 'object',
+                            description:
+                              'The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).',
+                          },
+                        },
+                        required: [],
+                      },
+                    },
+                    required: [],
+                  },
+                  currency: {
+                    type: 'string',
+                    description: 'The deduction currency.',
+                  },
+                  name: {
+                    type: 'string',
+                    description: 'The deduction name from the pay statement.',
+                  },
+                  pre_tax: {
+                    type: 'boolean',
+                    description: 'Boolean indicating if the deduction is pre-tax.',
+                  },
+                  type: {
+                    type: 'string',
+                    title: 'BenefitType',
+                    description: 'Type of benefit.',
+                    enum: [
+                      '401k',
+                      '401k_roth',
+                      '401k_loan',
+                      '403b',
+                      '403b_roth',
+                      '457',
+                      '457_roth',
+                      's125_medical',
+                      's125_dental',
+                      's125_vision',
+                      'hsa_pre',
+                      'hsa_post',
+                      'fsa_medical',
+                      'fsa_dependent_care',
+                      'simple_ira',
+                      'simple',
+                      'commuter',
+                      'custom_post_tax',
+                      'custom_pre_tax',
+                    ],
+                  },
+                },
+                required: [],
+              },
+            },
+            employer_contributions: {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  amount: {
+                    type: 'integer',
+                    description: 'The contribution amount in cents.',
+                  },
+                  attributes: {
+                    type: 'object',
+                    properties: {
+                      metadata: {
+                        type: 'object',
+                        properties: {
+                          metadata: {
+                            type: 'object',
+                            description:
+                              'The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).',
+                          },
+                        },
+                        required: [],
+                      },
+                    },
+                    required: [],
+                  },
+                  currency: {
+                    type: 'string',
+                    description: 'The contribution currency.',
+                  },
+                  name: {
+                    type: 'string',
+                    description: 'The contribution name from the pay statement.',
+                  },
+                  type: {
+                    $ref: '#/properties/pay_statements/items/employee_deductions/items/type',
+                  },
+                },
+                required: [],
+              },
+            },
+            gross_pay: {
+              type: 'object',
+              title: 'Money',
+              properties: {
+                amount: {
+                  type: 'integer',
+                  description: 'Amount for money object (in cents)',
+                },
+                currency: {
+                  type: 'string',
+                },
+              },
+              required: [],
+            },
+            individual_id: {
+              type: 'string',
+              description: 'A stable Finch `id` (UUID v4) for an individual in the company',
+            },
+            net_pay: {
+              $ref: '#/properties/pay_statements/items/gross_pay',
+            },
+            payment_method: {
+              type: 'string',
+              description: 'The payment method.',
+              enum: ['check', 'direct_deposit'],
+            },
+            taxes: {
+              type: 'array',
+              description: 'The array of taxes objects associated with this pay statement.',
+              items: {
+                type: 'object',
+                properties: {
+                  amount: {
+                    type: 'integer',
+                    description: 'The tax amount in cents.',
+                  },
+                  attributes: {
+                    type: 'object',
+                    properties: {
+                      metadata: {
+                        type: 'object',
+                        properties: {
+                          metadata: {
+                            type: 'object',
+                            description:
+                              'The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).',
+                          },
+                        },
+                        required: [],
+                      },
+                    },
+                    required: [],
+                  },
+                  currency: {
+                    type: 'string',
+                    description: 'The currency code.',
+                  },
+                  employer: {
+                    type: 'boolean',
+                    description: '`true` if the amount is paid by the employers.',
+                  },
+                  name: {
+                    type: 'string',
+                    description: 'The exact name of tax from the pay statement.',
+                  },
+                  type: {
+                    type: 'string',
+                    description: 'The type of taxes.',
+                    enum: ['state', 'federal', 'local', 'fica'],
+                  },
+                },
+                required: [],
+              },
+            },
+            total_hours: {
+              type: 'number',
+              description: 'The number of hours worked for this pay period',
+            },
+            type: {
+              type: 'string',
+              description: 'The type of the payment associated with the pay statement.',
+              enum: ['regular_payroll', 'off_cycle_payroll', 'one_time_payment'],
+            },
+          },
+          required: [],
+        },
+      },
+      start_date: {
+        type: 'string',
+      },
+    },
+  },
+};
+
+export const handler = (client: Finch, args: any) => {
+  const { ...body } = args;
+  return client.sandbox.payment.create(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools.ts

@@ -0,0 +1 @@
+export * from './tools/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["DOM"],
+    "moduleResolution": "node"
+  }
+}

package/tools/access-tokens/create-access-tokens.d.mts

@@ -0,0 +1,24 @@
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from "..//index.mjs";
+import Finch from '@tryfinch/finch-api';
+export declare const metadata: Metadata;
+export declare const tool: Tool;
+export declare const handler: (client: Finch, args: any) => import("@tryfinch/finch-api/core").APIPromise<Finch.AccessTokens.CreateAccessTokenResponse>;
+declare const _default: {
+    metadata: Metadata;
+    tool: {
+        [x: string]: unknown;
+        name: string;
+        inputSchema: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+        };
+        description?: string | undefined;
+    };
+    handler: (client: Finch, args: any) => import("@tryfinch/finch-api/core").APIPromise<Finch.AccessTokens.CreateAccessTokenResponse>;
+};
+export default _default;
+//# sourceMappingURL=create-access-tokens.d.mts.map

package/tools/access-tokens/create-access-tokens.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-access-tokens.d.mts","sourceRoot":"","sources":["../../src/tools/access-tokens/create-access-tokens.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAItB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAoBlB,CAAC;AAEF,eAAO,MAAM,OAAO,WAAY,KAAK,QAAQ,GAAG,gGAG/C,CAAC;;;;;;;;;;;;;;;;;AAEF,wBAA2C"}

package/tools/access-tokens/create-access-tokens.d.ts

@@ -0,0 +1,24 @@
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from "..//index.js";
+import Finch from '@tryfinch/finch-api';
+export declare const metadata: Metadata;
+export declare const tool: Tool;
+export declare const handler: (client: Finch, args: any) => import("@tryfinch/finch-api/core").APIPromise<Finch.AccessTokens.CreateAccessTokenResponse>;
+declare const _default: {
+    metadata: Metadata;
+    tool: {
+        [x: string]: unknown;
+        name: string;
+        inputSchema: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+        };
+        description?: string | undefined;
+    };
+    handler: (client: Finch, args: any) => import("@tryfinch/finch-api/core").APIPromise<Finch.AccessTokens.CreateAccessTokenResponse>;
+};
+export default _default;
+//# sourceMappingURL=create-access-tokens.d.ts.map

package/tools/access-tokens/create-access-tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-access-tokens.d.ts","sourceRoot":"","sources":["../../src/tools/access-tokens/create-access-tokens.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAItB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAoBlB,CAAC;AAEF,eAAO,MAAM,OAAO,WAAY,KAAK,QAAQ,GAAG,gGAG/C,CAAC;;;;;;;;;;;;;;;;;AAEF,wBAA2C"}

package/tools/access-tokens/create-access-tokens.js

@@ -0,0 +1,37 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.tool = exports.metadata = void 0;
+exports.metadata = {
+    resource: 'access_tokens',
+    operation: 'write',
+    tags: [],
+};
+exports.tool = {
+    name: 'create_access_tokens',
+    description: 'Exchange the authorization code for an access token',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            code: {
+                type: 'string',
+            },
+            client_id: {
+                type: 'string',
+            },
+            client_secret: {
+                type: 'string',
+            },
+            redirect_uri: {
+                type: 'string',
+            },
+        },
+    },
+};
+const handler = (client, args) => {
+    const { ...body } = args;
+    return client.accessTokens.create(body);
+};
+exports.handler = handler;
+exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };
+//# sourceMappingURL=create-access-tokens.js.map

package/tools/access-tokens/create-access-tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-access-tokens.js","sourceRoot":"","sources":["../../src/tools/access-tokens/create-access-tokens.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAMzE,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,eAAe;IACzB,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;CACT,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EAAE,qDAAqD;IAClE,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;aACf;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;aACf;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;aACf;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAS,EAAE,EAAE;IAClD,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IACzB,OAAO,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}