@tryfinch/finch-api-mcp 6.31.0 → 8.0.0

package/src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts

@@ -1,78 +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: 'hris.company.pay_statement_item.rules',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'create_pay_statement_item_company_hris_rules',
-  description:
-    '**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\nCustom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      attributes: {
-        type: 'object',
-        description: 'Specifies the fields to be applied when the condition is met.',
-        properties: {
-          metadata: {
-            type: 'object',
-            description:
-              'The metadata to be attached in the entity. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).',
-          },
-        },
-        required: [],
-      },
-      conditions: {
-        type: 'array',
-        items: {
-          type: 'object',
-          properties: {
-            field: {
-              type: 'string',
-              description: 'The field to be checked in the rule.',
-            },
-            operator: {
-              type: 'string',
-              description: 'The operator to be used in the rule.',
-              enum: ['equals'],
-            },
-            value: {
-              type: 'string',
-              description: 'The value of the field to be checked in the rule.',
-            },
-          },
-          required: [],
-        },
-      },
-      effective_end_date: {
-        type: 'string',
-        title: 'Date',
-        description: 'Specifies when the rules should stop applying rules based on the date.',
-      },
-      effective_start_date: {
-        type: 'string',
-        title: 'Date',
-        description: 'Specifies when the rule should begin applying based on the date.',
-      },
-      entity_type: {
-        type: 'string',
-        description: 'The entity type to which the rule is applied.',
-        enum: ['pay_statement_item'],
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.hris.company.payStatementItem.rules.create(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.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: 'hris.company.pay_statement_item.rules',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'delete_pay_statement_item_company_hris_rules',
-  description:
-    '**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\nDelete a rule for a pay statement item.\n',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      rule_id: {
-        type: 'string',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { rule_id, ...body } = args as any;
-  return client.hris.company.payStatementItem.rules.delete(rule_id);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.ts

@@ -1,27 +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: 'hris.company.pay_statement_item.rules',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_pay_statement_item_company_hris_rules',
-  description:
-    '**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\nList all rules of a connection account.\n',
-  inputSchema: {
-    type: 'object',
-    properties: {},
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  return client.hris.company.payStatementItem.rules.list();
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.ts

@@ -1,35 +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: 'hris.company.pay_statement_item.rules',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'update_pay_statement_item_company_hris_rules',
-  description:
-    '**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\nUpdate a rule for a pay statement item.\n',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      rule_id: {
-        type: 'string',
-      },
-      optionalProperty: {
-        type: 'object',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { rule_id, ...body } = args as any;
-  return client.hris.company.payStatementItem.rules.update(rule_id, body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/company/retrieve-hris-company.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: 'hris.company',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retrieve_hris_company',
-  description: 'Read basic company data',
-  inputSchema: {
-    type: 'object',
-    properties: {},
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  return client.hris.company.retrieve();
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/directory/list-hris-directory.ts

@@ -1,36 +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: 'hris.directory',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_hris_directory',
-  description: 'Read company directory and organization structure',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      limit: {
-        type: 'integer',
-        description: 'Number of employees to return (defaults to all)',
-      },
-      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.hris.directory.list(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/directory/list-individuals-hris-directory.ts

@@ -1,36 +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: 'hris.directory',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_individuals_hris_directory',
-  description: 'Read company directory and organization structure',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      limit: {
-        type: 'integer',
-        description: 'Number of employees to return (defaults to all)',
-      },
-      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.hris.directory.listIndividuals(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/documents/list-hris-documents.ts

@@ -1,53 +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: 'hris.documents',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_hris_documents',
-  description:
-    '**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      individual_ids: {
-        type: 'array',
-        description:
-          'Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals',
-        items: {
-          type: 'string',
-        },
-      },
-      limit: {
-        type: 'integer',
-        description: 'Number of documents to return (defaults to all)',
-      },
-      offset: {
-        type: 'integer',
-        description: 'Index to start from (defaults to 0)',
-      },
-      types: {
-        type: 'array',
-        description: 'Comma-delimited list of document types to filter on. If empty, defaults to all types',
-        items: {
-          type: 'string',
-          enum: ['w4_2020', 'w4_2005'],
-        },
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.hris.documents.list(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/documents/retreive-hris-documents.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: 'hris.documents',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retreive_hris_documents',
-  description:
-    '**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      document_id: {
-        type: 'string',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { document_id, ...body } = args as any;
-  return client.hris.documents.retreive(document_id);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/employments/retrieve-many-hris-employments.ts

@@ -1,43 +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: 'hris.employments',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retrieve_many_hris_employments',
-  description: 'Read individual employment and income data',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      requests: {
-        type: 'array',
-        description: 'The array of batch requests.',
-        items: {
-          type: 'object',
-          properties: {
-            individual_id: {
-              type: 'string',
-              description:
-                'A stable Finch `id` (UUID v4) for an individual in the company. There is no limit to the number of `individual_id` to send per request. It is preferantial to send all ids in a single request for Finch to optimize provider rate-limits.',
-            },
-          },
-          required: ['individual_id'],
-        },
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.hris.employments.retrieveMany(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/individuals/retrieve-many-hris-individuals.ts

@@ -1,52 +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: 'hris.individuals',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retrieve_many_hris_individuals',
-  description: 'Read individual data, excluding income and employment data',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      options: {
-        type: 'object',
-        properties: {
-          include: {
-            type: 'array',
-            items: {
-              type: 'string',
-            },
-          },
-        },
-        required: [],
-      },
-      requests: {
-        type: 'array',
-        items: {
-          type: 'object',
-          properties: {
-            individual_id: {
-              type: 'string',
-            },
-          },
-          required: [],
-        },
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.hris.individuals.retrieveMany(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/pay-statements/retrieve-many-hris-pay-statements.ts

@@ -1,51 +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: 'hris.pay_statements',
-  operation: 'write',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'retrieve_many_hris_pay_statements',
-  description:
-    'Read detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      requests: {
-        type: 'array',
-        description: 'The array of batch requests.',
-        items: {
-          type: 'object',
-          properties: {
-            payment_id: {
-              type: 'string',
-              description: 'A stable Finch `id` (UUID v4) for a payment.',
-            },
-            limit: {
-              type: 'integer',
-              description: 'Number of pay statements to return (defaults to all).',
-            },
-            offset: {
-              type: 'integer',
-              description: 'Index to start from.',
-            },
-          },
-          required: ['payment_id'],
-        },
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.hris.payStatements.retrieveMany(body);
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/payments/list-hris-payments.ts

@@ -1,38 +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: 'hris.payments',
-  operation: 'read',
-  tags: [],
-};
-
-export const tool: Tool = {
-  name: 'list_hris_payments',
-  description: 'Read payroll and contractor related payments by the company.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      end_date: {
-        type: 'string',
-        description: 'The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format.',
-        format: 'date',
-      },
-      start_date: {
-        type: 'string',
-        description: 'The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format.',
-        format: 'date',
-      },
-    },
-  },
-};
-
-export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return client.hris.payments.list(body);
-};
-
-export default { metadata, tool, handler };