@tryfinch/finch-api-mcp 6.31.0 → 8.0.0

package/src/tools/index.ts

@@ -1,175 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import Finch from '@tryfinch/finch-api';
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-
-import create_access_tokens from './access-tokens/create-access-tokens';
-import retrieve_hris_company from './hris/company/retrieve-hris-company';
-import list_company_hris_pay_statement_item from './hris/company/pay-statement-item/list-company-hris-pay-statement-item';
-import create_pay_statement_item_company_hris_rules from './hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules';
-import update_pay_statement_item_company_hris_rules from './hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules';
-import list_pay_statement_item_company_hris_rules from './hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules';
-import delete_pay_statement_item_company_hris_rules from './hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules';
-import list_hris_directory from './hris/directory/list-hris-directory';
-import list_individuals_hris_directory from './hris/directory/list-individuals-hris-directory';
-import retrieve_many_hris_individuals from './hris/individuals/retrieve-many-hris-individuals';
-import retrieve_many_hris_employments from './hris/employments/retrieve-many-hris-employments';
-import list_hris_payments from './hris/payments/list-hris-payments';
-import retrieve_many_hris_pay_statements from './hris/pay-statements/retrieve-many-hris-pay-statements';
-import list_hris_documents from './hris/documents/list-hris-documents';
-import retreive_hris_documents from './hris/documents/retreive-hris-documents';
-import create_hris_benefits from './hris/benefits/create-hris-benefits';
-import retrieve_hris_benefits from './hris/benefits/retrieve-hris-benefits';
-import update_hris_benefits from './hris/benefits/update-hris-benefits';
-import list_hris_benefits from './hris/benefits/list-hris-benefits';
-import list_supported_benefits_hris_benefits from './hris/benefits/list-supported-benefits-hris-benefits';
-import enroll_many_benefits_hris_individuals from './hris/benefits/individuals/enroll-many-benefits-hris-individuals';
-import enrolled_ids_benefits_hris_individuals from './hris/benefits/individuals/enrolled-ids-benefits-hris-individuals';
-import retrieve_many_benefits_benefits_hris_individuals from './hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals';
-import unenroll_many_benefits_hris_individuals from './hris/benefits/individuals/unenroll-many-benefits-hris-individuals';
-import list_providers from './providers/list-providers';
-import disconnect_account from './account/disconnect-account';
-import introspect_account from './account/introspect-account';
-import forward_request_forwarding from './request-forwarding/forward-request-forwarding';
-import create_jobs_automated from './jobs/automated/create-jobs-automated';
-import retrieve_jobs_automated from './jobs/automated/retrieve-jobs-automated';
-import list_jobs_automated from './jobs/automated/list-jobs-automated';
-import retrieve_jobs_manual from './jobs/manual/retrieve-jobs-manual';
-import create_sandbox_connections from './sandbox/connections/create-sandbox-connections';
-import create_connections_sandbox_accounts from './sandbox/connections/accounts/create-connections-sandbox-accounts';
-import update_connections_sandbox_accounts from './sandbox/connections/accounts/update-connections-sandbox-accounts';
-import update_sandbox_company from './sandbox/company/update-sandbox-company';
-import create_sandbox_directory from './sandbox/directory/create-sandbox-directory';
-import update_sandbox_individual from './sandbox/individual/update-sandbox-individual';
-import update_sandbox_employment from './sandbox/employment/update-sandbox-employment';
-import create_sandbox_payment from './sandbox/payment/create-sandbox-payment';
-import create_sandbox_jobs from './sandbox/jobs/create-sandbox-jobs';
-import retrieve_jobs_sandbox_configuration from './sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration';
-import update_jobs_sandbox_configuration from './sandbox/jobs/configuration/update-jobs-sandbox-configuration';
-import retrieve_payroll_pay_groups from './payroll/pay-groups/retrieve-payroll-pay-groups';
-import list_payroll_pay_groups from './payroll/pay-groups/list-payroll-pay-groups';
-import new_connect_sessions from './connect/sessions/new-connect-sessions';
-import reauthenticate_connect_sessions from './connect/sessions/reauthenticate-connect-sessions';
-
-export type HandlerFunction = (client: Finch, args: Record<string, unknown> | undefined) => Promise<any>;
-
-export type Metadata = {
-  resource: string;
-  operation: 'read' | 'write';
-  tags: string[];
-};
-
-export type Endpoint = {
-  metadata: Metadata;
-  tool: Tool;
-  handler: HandlerFunction;
-};
-
-export const endpoints: Endpoint[] = [];
-
-function addEndpoint(endpoint: Endpoint) {
-  endpoints.push(endpoint);
-}
-
-addEndpoint(create_access_tokens);
-addEndpoint(retrieve_hris_company);
-addEndpoint(list_company_hris_pay_statement_item);
-addEndpoint(create_pay_statement_item_company_hris_rules);
-addEndpoint(update_pay_statement_item_company_hris_rules);
-addEndpoint(list_pay_statement_item_company_hris_rules);
-addEndpoint(delete_pay_statement_item_company_hris_rules);
-addEndpoint(list_hris_directory);
-addEndpoint(list_individuals_hris_directory);
-addEndpoint(retrieve_many_hris_individuals);
-addEndpoint(retrieve_many_hris_employments);
-addEndpoint(list_hris_payments);
-addEndpoint(retrieve_many_hris_pay_statements);
-addEndpoint(list_hris_documents);
-addEndpoint(retreive_hris_documents);
-addEndpoint(create_hris_benefits);
-addEndpoint(retrieve_hris_benefits);
-addEndpoint(update_hris_benefits);
-addEndpoint(list_hris_benefits);
-addEndpoint(list_supported_benefits_hris_benefits);
-addEndpoint(enroll_many_benefits_hris_individuals);
-addEndpoint(enrolled_ids_benefits_hris_individuals);
-addEndpoint(retrieve_many_benefits_benefits_hris_individuals);
-addEndpoint(unenroll_many_benefits_hris_individuals);
-addEndpoint(list_providers);
-addEndpoint(disconnect_account);
-addEndpoint(introspect_account);
-addEndpoint(forward_request_forwarding);
-addEndpoint(create_jobs_automated);
-addEndpoint(retrieve_jobs_automated);
-addEndpoint(list_jobs_automated);
-addEndpoint(retrieve_jobs_manual);
-addEndpoint(create_sandbox_connections);
-addEndpoint(create_connections_sandbox_accounts);
-addEndpoint(update_connections_sandbox_accounts);
-addEndpoint(update_sandbox_company);
-addEndpoint(create_sandbox_directory);
-addEndpoint(update_sandbox_individual);
-addEndpoint(update_sandbox_employment);
-addEndpoint(create_sandbox_payment);
-addEndpoint(create_sandbox_jobs);
-addEndpoint(retrieve_jobs_sandbox_configuration);
-addEndpoint(update_jobs_sandbox_configuration);
-addEndpoint(retrieve_payroll_pay_groups);
-addEndpoint(list_payroll_pay_groups);
-addEndpoint(new_connect_sessions);
-addEndpoint(reauthenticate_connect_sessions);
-
-export type Filter = {
-  type: 'resource' | 'operation' | 'tag' | 'tool';
-  op: 'include' | 'exclude';
-  value: string;
-};
-
-export function query(filters: Filter[], endpoints: Endpoint[]): Endpoint[] {
-  const allExcludes = filters.length > 0 && filters.every((filter) => filter.op === 'exclude');
-  const unmatchedFilters = new Set(filters);
-
-  const filtered = endpoints.filter((endpoint: Endpoint) => {
-    let included = false || allExcludes;
-
-    for (const filter of filters) {
-      if (match(filter, endpoint)) {
-        unmatchedFilters.delete(filter);
-        included = filter.op === 'include';
-      }
-    }
-
-    return included;
-  });
-
-  // Check if any filters didn't match
-  if (unmatchedFilters.size > 0) {
-    throw new Error(
-      `The following filters did not match any endpoints: ${[...unmatchedFilters]
-        .map((f) => `${f.type}=${f.value}`)
-        .join(', ')}`,
-    );
-  }
-
-  return filtered;
-}
-
-function match({ type, value }: Filter, endpoint: Endpoint): boolean {
-  switch (type) {
-    case 'resource': {
-      const regexStr = '^' + normalizeResource(value).replace(/\*/g, '.*') + '$';
-      const regex = new RegExp(regexStr);
-      return regex.test(normalizeResource(endpoint.metadata.resource));
-    }
-    case 'operation':
-      return endpoint.metadata.operation === value;
-    case 'tag':
-      return endpoint.metadata.tags.includes(value);
-    case 'tool':
-      return endpoint.tool.name === value;
-  }
-}
-
-function normalizeResource(resource: string): string {
-  return resource.toLowerCase().replace(/[^a-z.*\-_]*/g, '');
-}

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

@@ -1,59 +0,0 @@
-// 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: 'jobs.automated',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'create_jobs_automated',
-  description:
-    'Enqueue an automated job.\n\n`data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the `job_id` of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.\n\n`w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified by `individual_id`. This feature is currently in beta.\n\nThis endpoint is available for *Scale* tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.',
-  inputSchema: {
-    type: 'object',
-    anyOf: [
-      {
-        type: 'object',
-        properties: {
-          type: {
-            type: 'string',
-            description: 'The type of job to start.',
-            enum: ['data_sync_all'],
-          },
-        },
-      },
-      {
-        type: 'object',
-        properties: {
-          params: {
-            type: 'object',
-            properties: {
-              individual_id: {
-                type: 'string',
-                description: 'The unique ID of the individual for W-4 data sync.',
-              },
-            },
-            required: ['individual_id'],
-          },
-          type: {
-            type: 'string',
-            description: 'The type of job to start.',
-            enum: ['w4_form_employee_sync'],
-          },
-        },
-      },
-    ],
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.jobs.automated.create(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/jobs/automated/list-jobs-automated.ts

@@ -1,37 +0,0 @@
-// 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: 'jobs.automated',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_jobs_automated',
-  description:
-    'Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      limit: {
-        type: 'integer',
-        description: 'Number of items to return',
-      },
-      offset: {
-        type: 'integer',
-        description: 'Index to start from (defaults to 0)',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.jobs.automated.list(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/jobs/automated/retrieve-jobs-automated.ts

@@ -1,31 +0,0 @@
-// 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: 'jobs.automated',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retrieve_jobs_automated',
-  description: 'Get an automated job by `job_id`.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      job_id: {
-        type: 'string',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { job_id, ...body } = args as any;
-  return client.jobs.automated.retrieve(job_id);
-};
-
-export default { metadata, tool, handler };

package/src/tools/jobs/manual/retrieve-jobs-manual.ts

@@ -1,32 +0,0 @@
-// 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: 'jobs.manual',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retrieve_jobs_manual',
-  description:
-    'Get a manual job by `job_id`. Manual jobs are completed by a human and include Assisted Benefits jobs.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      job_id: {
-        type: 'string',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { job_id, ...body } = args as any;
-  return client.jobs.manual.retrieve(job_id);
-};
-
-export default { metadata, tool, handler };

package/src/tools/payroll/pay-groups/list-payroll-pay-groups.ts

@@ -1,37 +0,0 @@
-// 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: 'payroll.pay_groups',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_payroll_pay_groups',
-  description: 'Read company pay groups and frequencies',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      individual_id: {
-        type: 'string',
-      },
-      pay_frequencies: {
-        type: 'array',
-        items: {
-          type: 'string',
-        },
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.payroll.payGroups.list(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/payroll/pay-groups/retrieve-payroll-pay-groups.ts

@@ -1,31 +0,0 @@
-// 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: 'payroll.pay_groups',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retrieve_payroll_pay_groups',
-  description: 'Read information from a single pay group',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      pay_group_id: {
-        type: 'string',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { pay_group_id, ...body } = args as any;
-  return client.payroll.payGroups.retrieve(pay_group_id);
-};
-
-export default { metadata, tool, handler };

package/src/tools/providers/list-providers.ts

@@ -1,26 +0,0 @@
-// 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: 'providers',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_providers',
-  description: 'Return details on all available payroll and HR systems.',
-  inputSchema: {
-    type: 'object',
-    properties: {},
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  return client.providers.list();
-};
-
-export default { metadata, tool, handler };

package/src/tools/request-forwarding/forward-request-forwarding.ts

@@ -1,54 +0,0 @@
-// 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: 'request_forwarding',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'forward_request_forwarding',
-  description:
-    'The Forward API allows you to make direct requests to an employment system. If Finch’s unified API\ndoesn’t have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration’s API.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      method: {
-        type: 'string',
-        description:
-          'The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.',
-      },
-      route: {
-        type: 'string',
-        description:
-          'The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.',
-      },
-      data: {
-        type: 'string',
-        description:
-          'The body for the forwarded request. This value must be specified as either a string or a valid JSON object.',
-      },
-      headers: {
-        type: 'object',
-        description:
-          'The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{"Content-Type": "application/xml", "X-API-Version": "v1" }`',
-      },
-      params: {
-        type: 'object',
-        description:
-          'The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.requestForwarding.forward(body);
-};
-
-export default { metadata, tool, handler };

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

@@ -1,164 +0,0 @@
-// 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.company',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'update_sandbox_company',
-  description: "Update a sandbox company's data",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      accounts: {
-        type: 'array',
-        description: 'An array of bank account objects associated with the payroll/HRIS system.',
-        items: {
-          type: 'object',
-          properties: {
-            account_name: {
-              type: 'string',
-              description: 'The name of the bank associated in the payroll/HRIS system.',
-            },
-            account_number: {
-              type: 'string',
-              description: '10-12 digit number to specify the bank account',
-            },
-            account_type: {
-              type: 'string',
-              description: 'The type of bank account.',
-              enum: ['checking', 'savings'],
-            },
-            institution_name: {
-              type: 'string',
-              description: 'Name of the banking institution.',
-            },
-            routing_number: {
-              type: 'string',
-              description:
-                "A nine-digit code that's based on the U.S. Bank location where your account was opened.",
-            },
-          },
-          required: [],
-        },
-      },
-      departments: {
-        type: 'array',
-        description: 'The array of company departments.',
-        items: {
-          type: 'object',
-          properties: {
-            name: {
-              type: 'string',
-              description: 'The department name.',
-            },
-            parent: {
-              type: 'object',
-              description: 'The parent department, if present.',
-              properties: {
-                name: {
-                  type: 'string',
-                  description: "The parent department's name.",
-                },
-              },
-              required: [],
-            },
-          },
-          required: [],
-        },
-      },
-      ein: {
-        type: 'string',
-        description: 'The employer identification number.',
-      },
-      entity: {
-        type: 'object',
-        description: 'The entity type object.',
-        properties: {
-          subtype: {
-            type: 'string',
-            description: 'The tax payer subtype of the company.',
-            enum: ['s_corporation', 'c_corporation', 'b_corporation'],
-          },
-          type: {
-            type: 'string',
-            description: 'The tax payer type of the company.',
-            enum: ['llc', 'lp', 'corporation', 'sole_proprietor', 'non_profit', 'partnership', 'cooperative'],
-          },
-        },
-        required: [],
-      },
-      legal_name: {
-        type: 'string',
-        description: 'The legal name of the company.',
-      },
-      locations: {
-        type: 'array',
-        items: {
-          $ref: '#/$defs/location',
-        },
-      },
-      primary_email: {
-        type: 'string',
-        description: 'The email of the main administrator on the account.',
-      },
-      primary_phone_number: {
-        type: 'string',
-        description:
-          'The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. `+NNNNNNNNNNN xExtension`',
-      },
-    },
-    $defs: {
-      location: {
-        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.',
-          },
-          postal_code: {
-            type: 'string',
-            description: 'The postal code or zip code.',
-          },
-          state: {
-            type: 'string',
-            description: 'The state code.',
-          },
-          name: {
-            type: 'string',
-          },
-          source_id: {
-            type: 'string',
-          },
-        },
-        required: ['city', 'country', 'line1', 'line2', 'postal_code', 'state'],
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.sandbox.company.update(body);
-};
-
-export default { metadata, tool, handler };