@tryfinch/finch-api-mcp 6.31.0 → 7.0.0

package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"list-company-hris-pay-statement-item.d.mts","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.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,IAsClB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,4MAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"list-company-hris-pay-statement-item.d.mts","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAuDlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAWrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAXoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAatF,wBAA2C"}

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

@@ -1,32 +1,51 @@
+import { Metadata } from '@tryfinch/finch-api-mcp/tools/types';
 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: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").PagePromise<Finch.HRIS.CompanyResource.PayStatementItem.PayStatementItemListResponsesPage, Finch.HRIS.CompanyResource.PayStatementItem.PayStatementItemListResponse>;
+export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 declare const _default: {
     metadata: Metadata;
     tool: {
-        [x: string]: unknown;
-        name: string;
         inputSchema: {
             [x: string]: unknown;
             type: "object";
             properties?: {
-                [x: string]: unknown;
+                [x: string]: object;
             } | undefined;
+            required?: string[] | undefined;
         };
+        name: string;
         description?: string | undefined;
-        annotations?: {
+        outputSchema?: {
             [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: object;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
             title?: string | undefined;
             readOnlyHint?: boolean | undefined;
             destructiveHint?: boolean | undefined;
             idempotentHint?: boolean | undefined;
             openWorldHint?: boolean | undefined;
         } | undefined;
+        execution?: {
+            taskSupport?: "optional" | "required" | "forbidden" | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+        icons?: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+        }[] | undefined;
+        title?: string | undefined;
     };
-    handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").PagePromise<Finch.HRIS.CompanyResource.PayStatementItem.PayStatementItemListResponsesPage, Finch.HRIS.CompanyResource.PayStatementItem.PayStatementItemListResponse>;
+    handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 };
 export default _default;
 //# sourceMappingURL=list-company-hris-pay-statement-item.d.ts.map

package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"list-company-hris-pay-statement-item.d.ts","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.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,IAsClB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,4MAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"list-company-hris-pay-statement-item.d.ts","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAuDlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAWrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAXoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAatF,wBAA2C"}

package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.js

@@ -1,15 +1,24 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handler = exports.tool = exports.metadata = void 0;
+const filtering_1 = require("@tryfinch/finch-api-mcp/filtering");
+const types_1 = require("@tryfinch/finch-api-mcp/tools/types");
+const finch_api_1 = __importDefault(require("@tryfinch/finch-api"));
 exports.metadata = {
     resource: 'hris.company.pay_statement_item',
     operation: 'read',
     tags: [],
+    httpMethod: 'get',
+    httpPath: '/employer/pay-statement-item',
+    operationId: 'get-pay-statement-item',
 };
 exports.tool = {
     name: 'list_company_hris_pay_statement_item',
-    description: "**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\n Retrieve a list of detailed pay statement items for the access token's connection account.\n",
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\n**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\n Retrieve a list of detailed pay statement items for the access token's connection account.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    responses: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/pay_statement_item_list_response'\n      }\n    }\n  },\n  required: [    'responses'\n  ],\n  $defs: {\n    pay_statement_item_list_response: {\n      type: 'object',\n      properties: {\n        attributes: {\n          type: 'object',\n          description: 'The attributes of the pay statement item.',\n          properties: {\n            metadata: {\n              type: 'object',\n              description: 'The metadata of the pay statement item derived by the rules engine if available. Each attribute will be a key-value pair defined by a rule.',\n              additionalProperties: true\n            },\n            employer: {\n              type: 'boolean',\n              description: '`true` if the amount is paid by the employers. This field is only available for taxes.'\n            },\n            pre_tax: {\n              type: 'boolean',\n              description: '`true` if the pay statement item is pre-tax. This field is only available for employee deductions.'\n            },\n            type: {\n              type: 'string',\n              description: 'The type of the pay statement item.'\n            }\n          },\n          required: [            'metadata'\n          ]\n        },\n        category: {\n          type: 'string',\n          description: 'The category of the pay statement item.',\n          enum: [            'earnings',\n            'taxes',\n            'employee_deductions',\n            'employer_contributions'\n          ]\n        },\n        name: {\n          type: 'string',\n          description: 'The name of the pay statement item.'\n        }\n      },\n      required: [        'attributes',\n        'category',\n        'name'\n      ]\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
@@ -26,6 +35,13 @@ exports.tool = {
                 description: 'The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.',
                 format: 'date',
             },
+            entity_ids: {
+                type: 'array',
+                description: "The entity IDs to specify which entities' data to access.",
+                items: {
+                    type: 'string',
+                },
+            },
             name: {
                 type: 'string',
                 description: 'Case-insensitive partial match search by pay statement item name.',
@@ -39,12 +55,30 @@ exports.tool = {
                 type: 'string',
                 description: 'String search by pay statement item type.',
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: [],
+    },
+    annotations: {
+        readOnlyHint: true,
     },
 };
-const handler = (client, args) => {
-    const body = args;
-    return client.hris.company.payStatementItem.list(body);
+const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    const response = await client.hris.company.payStatementItem.list(body).asResponse();
+    try {
+        return (0, types_1.asTextContentResult)(await (0, filtering_1.maybeFilter)(jq_filter, await response.json()));
+    }
+    catch (error) {
+        if (error instanceof finch_api_1.default.APIError || (0, filtering_1.isJqError)(error)) {
+            return (0, types_1.asErrorResult)(error.message);
+        }
+        throw error;
+    }
 };
 exports.handler = handler;
 exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };

package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-company-hris-pay-statement-item.js","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAMzE,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,iCAAiC;IAC3C,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;CACT,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,sCAAsC;IAC5C,WAAW,EACT,uNAAuN;IACzN,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,2GAA2G;gBAC7G,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,CAAC;iBAC7E;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,sGAAsG;gBACxG,MAAM,EAAE,MAAM;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mEAAmE;aACjF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,oHAAoH;gBACtH,MAAM,EAAE,MAAM;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,2CAA2C;aACzD;SACF;KACF;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}
+{"version":3,"file":"list-company-hris-pay-statement-item.js","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;AAEtF,iEAA2E;AAC3E,+DAAmG;AAGnG,oEAAwC;AAE3B,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,iCAAiC;IAC3C,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,8BAA8B;IACxC,WAAW,EAAE,wBAAwB;CACtC,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,sCAAsC;IAC5C,WAAW,EACT,6tEAA6tE;IAC/tE,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,2GAA2G;gBAC7G,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,CAAC;iBAC7E;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,sGAAsG;gBACxG,MAAM,EAAE,MAAM;aACf;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,2DAA2D;gBACxE,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mEAAmE;aACjF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,oHAAoH;gBACtH,MAAM,EAAE,MAAM;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,2CAA2C;aACzD;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,EAAE;KACb;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IACpF,IAAI,CAAC;QACH,OAAO,IAAA,2BAAmB,EAAC,MAAM,IAAA,uBAAW,EAAC,SAAS,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAClF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,mBAAK,CAAC,QAAQ,IAAI,IAAA,qBAAS,EAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,IAAA,qBAAa,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAXW,QAAA,OAAO,WAWlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}

package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.mjs

@@ -1,12 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
+import { asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
+import Finch from '@tryfinch/finch-api';
 export const metadata = {
     resource: 'hris.company.pay_statement_item',
     operation: 'read',
     tags: [],
+    httpMethod: 'get',
+    httpPath: '/employer/pay-statement-item',
+    operationId: 'get-pay-statement-item',
 };
 export const tool = {
     name: 'list_company_hris_pay_statement_item',
-    description: "**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\n Retrieve a list of detailed pay statement items for the access token's connection account.\n",
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\n**Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon\n Retrieve a list of detailed pay statement items for the access token's connection account.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    responses: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/pay_statement_item_list_response'\n      }\n    }\n  },\n  required: [    'responses'\n  ],\n  $defs: {\n    pay_statement_item_list_response: {\n      type: 'object',\n      properties: {\n        attributes: {\n          type: 'object',\n          description: 'The attributes of the pay statement item.',\n          properties: {\n            metadata: {\n              type: 'object',\n              description: 'The metadata of the pay statement item derived by the rules engine if available. Each attribute will be a key-value pair defined by a rule.',\n              additionalProperties: true\n            },\n            employer: {\n              type: 'boolean',\n              description: '`true` if the amount is paid by the employers. This field is only available for taxes.'\n            },\n            pre_tax: {\n              type: 'boolean',\n              description: '`true` if the pay statement item is pre-tax. This field is only available for employee deductions.'\n            },\n            type: {\n              type: 'string',\n              description: 'The type of the pay statement item.'\n            }\n          },\n          required: [            'metadata'\n          ]\n        },\n        category: {\n          type: 'string',\n          description: 'The category of the pay statement item.',\n          enum: [            'earnings',\n            'taxes',\n            'employee_deductions',\n            'employer_contributions'\n          ]\n        },\n        name: {\n          type: 'string',\n          description: 'The name of the pay statement item.'\n        }\n      },\n      required: [        'attributes',\n        'category',\n        'name'\n      ]\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
@@ -23,6 +29,13 @@ export const tool = {
                 description: 'The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.',
                 format: 'date',
             },
+            entity_ids: {
+                type: 'array',
+                description: "The entity IDs to specify which entities' data to access.",
+                items: {
+                    type: 'string',
+                },
+            },
             name: {
                 type: 'string',
                 description: 'Case-insensitive partial match search by pay statement item name.',
@@ -36,12 +49,30 @@ export const tool = {
                 type: 'string',
                 description: 'String search by pay statement item type.',
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: [],
+    },
+    annotations: {
+        readOnlyHint: true,
     },
 };
-export const handler = (client, args) => {
-    const body = args;
-    return client.hris.company.payStatementItem.list(body);
+export const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    const response = await client.hris.company.payStatementItem.list(body).asResponse();
+    try {
+        return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
+    }
+    catch (error) {
+        if (error instanceof Finch.APIError || isJqError(error)) {
+            return asErrorResult(error.message);
+        }
+        throw error;
+    }
 };
 export default { metadata, tool, handler };
 //# sourceMappingURL=list-company-hris-pay-statement-item.mjs.map

package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"list-company-hris-pay-statement-item.mjs","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAMtF,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,iCAAiC;IAC3C,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,sCAAsC;IAC5C,WAAW,EACT,uNAAuN;IACzN,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,2GAA2G;gBAC7G,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,CAAC;iBAC7E;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,sGAAsG;gBACxG,MAAM,EAAE,MAAM;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mEAAmE;aACjF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,oHAAoH;gBACtH,MAAM,EAAE,MAAM;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,2CAA2C;aACzD;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"list-company-hris-pay-statement-item.mjs","sourceRoot":"","sources":["../../../../src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mCAAmC;OACnE,EAAY,aAAa,EAAE,mBAAmB,EAAE,MAAM,qCAAqC;OAG3F,KAAK,MAAM,qBAAqB;AAEvC,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,iCAAiC;IAC3C,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,8BAA8B;IACxC,WAAW,EAAE,wBAAwB;CACtC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,sCAAsC;IAC5C,WAAW,EACT,6tEAA6tE;IAC/tE,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,2GAA2G;gBAC7G,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,CAAC;iBAC7E;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,sGAAsG;gBACxG,MAAM,EAAE,MAAM;aACf;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,2DAA2D;gBACxE,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mEAAmE;aACjF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,oHAAoH;gBACtH,MAAM,EAAE,MAAM;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,2CAA2C;aACzD;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,EAAE;KACb;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IACpF,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAClF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,CAAC,QAAQ,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}

package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.d.mts

@@ -1,32 +1,51 @@
+import { Metadata } from '@tryfinch/finch-api-mcp/tools/types';
 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: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.HRIS.CompanyResource.PayStatementItem.Rules.RuleCreateResponse>;
+export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 declare const _default: {
     metadata: Metadata;
     tool: {
-        [x: string]: unknown;
-        name: string;
         inputSchema: {
             [x: string]: unknown;
             type: "object";
             properties?: {
-                [x: string]: unknown;
+                [x: string]: object;
             } | undefined;
+            required?: string[] | undefined;
         };
+        name: string;
         description?: string | undefined;
-        annotations?: {
+        outputSchema?: {
             [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: object;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
             title?: string | undefined;
             readOnlyHint?: boolean | undefined;
             destructiveHint?: boolean | undefined;
             idempotentHint?: boolean | undefined;
             openWorldHint?: boolean | undefined;
         } | undefined;
+        execution?: {
+            taskSupport?: "optional" | "required" | "forbidden" | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+        icons?: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+        }[] | undefined;
+        title?: string | undefined;
     };
-    handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.HRIS.CompanyResource.PayStatementItem.Rules.RuleCreateResponse>;
+    handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 };
 export default _default;
 //# sourceMappingURL=create-pay-statement-item-company-hris-rules.d.mts.map

package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"create-pay-statement-item-company-hris-rules.d.mts","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.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,IA0DlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,wHAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"create-pay-statement-item-company-hris-rules.d.mts","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAwElB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAYrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAZoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AActF,wBAA2C"}

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

@@ -1,32 +1,51 @@
+import { Metadata } from '@tryfinch/finch-api-mcp/tools/types';
 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: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.HRIS.CompanyResource.PayStatementItem.Rules.RuleCreateResponse>;
+export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 declare const _default: {
     metadata: Metadata;
     tool: {
-        [x: string]: unknown;
-        name: string;
         inputSchema: {
             [x: string]: unknown;
             type: "object";
             properties?: {
-                [x: string]: unknown;
+                [x: string]: object;
             } | undefined;
+            required?: string[] | undefined;
         };
+        name: string;
         description?: string | undefined;
-        annotations?: {
+        outputSchema?: {
             [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: object;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
             title?: string | undefined;
             readOnlyHint?: boolean | undefined;
             destructiveHint?: boolean | undefined;
             idempotentHint?: boolean | undefined;
             openWorldHint?: boolean | undefined;
         } | undefined;
+        execution?: {
+            taskSupport?: "optional" | "required" | "forbidden" | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+        icons?: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+        }[] | undefined;
+        title?: string | undefined;
     };
-    handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.HRIS.CompanyResource.PayStatementItem.Rules.RuleCreateResponse>;
+    handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 };
 export default _default;
 //# sourceMappingURL=create-pay-statement-item-company-hris-rules.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"create-pay-statement-item-company-hris-rules.d.ts","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.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,IA0DlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,wHAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"create-pay-statement-item-company-hris-rules.d.ts","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAwElB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAYrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAZoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AActF,wBAA2C"}

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

@@ -1,18 +1,34 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handler = exports.tool = exports.metadata = void 0;
+const filtering_1 = require("@tryfinch/finch-api-mcp/filtering");
+const types_1 = require("@tryfinch/finch-api-mcp/tools/types");
+const finch_api_1 = __importDefault(require("@tryfinch/finch-api"));
 exports.metadata = {
     resource: 'hris.company.pay_statement_item.rules',
     operation: 'write',
     tags: [],
+    httpMethod: 'post',
+    httpPath: '/employer/pay-statement-item/rule',
+    operationId: 'create-rule',
 };
 exports.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',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\n**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\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/rule_create_response',\n  $defs: {\n    rule_create_response: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'Finch id (uuidv4) for the rule.'\n        },\n        attributes: {\n          type: 'object',\n          description: 'Specifies the fields to be applied when the condition is met.',\n          properties: {\n            metadata: {\n              type: 'object',\n              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.).',\n              additionalProperties: true\n            }\n          }\n        },\n        conditions: {\n          type: 'array',\n          items: {\n            type: 'object',\n            properties: {\n              field: {\n                type: 'string',\n                description: 'The field to be checked in the rule.'\n              },\n              operator: {\n                type: 'string',\n                description: 'The operator to be used in the rule.',\n                enum: [                  'equals'\n                ]\n              },\n              value: {\n                type: 'string',\n                description: 'The value of the field to be checked in the rule.'\n              }\n            }\n          }\n        },\n        created_at: {\n          type: 'string',\n          description: 'The datetime when the rule was created.',\n          format: 'date-time'\n        },\n        effective_end_date: {\n          type: 'string',\n          title: 'Date',\n          description: 'Specifies when the rules should stop applying rules based on the date.'\n        },\n        effective_start_date: {\n          type: 'string',\n          title: 'Date',\n          description: 'Specifies when the rule should begin applying based on the date.'\n        },\n        entity_type: {\n          type: 'string',\n          description: 'The entity type to which the rule is applied.',\n          enum: [            'pay_statement_item'\n          ]\n        },\n        priority: {\n          type: 'integer',\n          description: 'The priority of the rule.'\n        },\n        updated_at: {\n          type: 'string',\n          description: 'The datetime when the rule was last updated.',\n          format: 'date-time'\n        }\n      }\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
+            entity_ids: {
+                type: 'array',
+                description: 'The entity IDs to create the rule for.',
+                items: {
+                    type: 'string',
+                },
+            },
             attributes: {
                 type: 'object',
                 description: 'Specifies the fields to be applied when the condition is met.',
@@ -20,9 +36,9 @@ exports.tool = {
                     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.).',
+                        additionalProperties: true,
                     },
                 },
-                required: [],
             },
             conditions: {
                 type: 'array',
@@ -43,7 +59,6 @@ exports.tool = {
                             description: 'The value of the field to be checked in the rule.',
                         },
                     },
-                    required: [],
                 },
             },
             effective_end_date: {
@@ -61,12 +76,27 @@ exports.tool = {
                 description: 'The entity type to which the rule is applied.',
                 enum: ['pay_statement_item'],
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: [],
     },
+    annotations: {},
 };
-const handler = (client, args) => {
-    const body = args;
-    return client.hris.company.payStatementItem.rules.create(body);
+const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    try {
+        return (0, types_1.asTextContentResult)(await (0, filtering_1.maybeFilter)(jq_filter, await client.hris.company.payStatementItem.rules.create(body)));
+    }
+    catch (error) {
+        if (error instanceof finch_api_1.default.APIError || (0, filtering_1.isJqError)(error)) {
+            return (0, types_1.asErrorResult)(error.message);
+        }
+        throw error;
+    }
 };
 exports.handler = handler;
 exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };

package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-pay-statement-item-company-hris-rules.js","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAMzE,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,uCAAuC;IACjD,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;CACT,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,8CAA8C;IACpD,WAAW,EACT,4ZAA4Z;IAC9Z,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+DAA+D;gBAC5E,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,wJAAwJ;qBAC3J;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;yBACpD;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;4BACnD,IAAI,EAAE,CAAC,QAAQ,CAAC;yBACjB;wBACD,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,mDAAmD;yBACjE;qBACF;oBACD,QAAQ,EAAE,EAAE;iBACb;aACF;YACD,kBAAkB,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,wEAAwE;aACtF;YACD,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,kEAAkE;aAChF;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+CAA+C;gBAC5D,IAAI,EAAE,CAAC,oBAAoB,CAAC;aAC7B;SACF;KACF;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}
+{"version":3,"file":"create-pay-statement-item-company-hris-rules.js","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;AAEtF,iEAA2E;AAC3E,+DAAmG;AAGnG,oEAAwC;AAE3B,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,uCAAuC;IACjD,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,mCAAmC;IAC7C,WAAW,EAAE,aAAa;CAC3B,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,8CAA8C;IACpD,WAAW,EACT,0/FAA0/F;IAC5/F,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,wCAAwC;gBACrD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+DAA+D;gBAC5E,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,wJAAwJ;wBAC1J,oBAAoB,EAAE,IAAI;qBAC3B;iBACF;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;yBACpD;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;4BACnD,IAAI,EAAE,CAAC,QAAQ,CAAC;yBACjB;wBACD,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,mDAAmD;yBACjE;qBACF;iBACF;aACF;YACD,kBAAkB,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,wEAAwE;aACtF;YACD,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,kEAAkE;aAChF;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+CAA+C;gBAC5D,IAAI,EAAE,CAAC,oBAAoB,CAAC;aAC7B;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,EAAE;KACb;IACD,WAAW,EAAE,EAAE;CAChB,CAAC;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,IAAI,CAAC;QACH,OAAO,IAAA,2BAAmB,EACxB,MAAM,IAAA,uBAAW,EAAC,SAAS,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAC5F,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,mBAAK,CAAC,QAAQ,IAAI,IAAA,qBAAS,EAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,IAAA,qBAAa,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAZW,QAAA,OAAO,WAYlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}

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

@@ -1,15 +1,28 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
+import { asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
+import Finch from '@tryfinch/finch-api';
 export const metadata = {
     resource: 'hris.company.pay_statement_item.rules',
     operation: 'write',
     tags: [],
+    httpMethod: 'post',
+    httpPath: '/employer/pay-statement-item/rule',
+    operationId: 'create-rule',
 };
 export const 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',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\n**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\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/rule_create_response',\n  $defs: {\n    rule_create_response: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'Finch id (uuidv4) for the rule.'\n        },\n        attributes: {\n          type: 'object',\n          description: 'Specifies the fields to be applied when the condition is met.',\n          properties: {\n            metadata: {\n              type: 'object',\n              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.).',\n              additionalProperties: true\n            }\n          }\n        },\n        conditions: {\n          type: 'array',\n          items: {\n            type: 'object',\n            properties: {\n              field: {\n                type: 'string',\n                description: 'The field to be checked in the rule.'\n              },\n              operator: {\n                type: 'string',\n                description: 'The operator to be used in the rule.',\n                enum: [                  'equals'\n                ]\n              },\n              value: {\n                type: 'string',\n                description: 'The value of the field to be checked in the rule.'\n              }\n            }\n          }\n        },\n        created_at: {\n          type: 'string',\n          description: 'The datetime when the rule was created.',\n          format: 'date-time'\n        },\n        effective_end_date: {\n          type: 'string',\n          title: 'Date',\n          description: 'Specifies when the rules should stop applying rules based on the date.'\n        },\n        effective_start_date: {\n          type: 'string',\n          title: 'Date',\n          description: 'Specifies when the rule should begin applying based on the date.'\n        },\n        entity_type: {\n          type: 'string',\n          description: 'The entity type to which the rule is applied.',\n          enum: [            'pay_statement_item'\n          ]\n        },\n        priority: {\n          type: 'integer',\n          description: 'The priority of the rule.'\n        },\n        updated_at: {\n          type: 'string',\n          description: 'The datetime when the rule was last updated.',\n          format: 'date-time'\n        }\n      }\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
+            entity_ids: {
+                type: 'array',
+                description: 'The entity IDs to create the rule for.',
+                items: {
+                    type: 'string',
+                },
+            },
             attributes: {
                 type: 'object',
                 description: 'Specifies the fields to be applied when the condition is met.',
@@ -17,9 +30,9 @@ export const tool = {
                     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.).',
+                        additionalProperties: true,
                     },
                 },
-                required: [],
             },
             conditions: {
                 type: 'array',
@@ -40,7 +53,6 @@ export const tool = {
                             description: 'The value of the field to be checked in the rule.',
                         },
                     },
-                    required: [],
                 },
             },
             effective_end_date: {
@@ -58,12 +70,27 @@ export const tool = {
                 description: 'The entity type to which the rule is applied.',
                 enum: ['pay_statement_item'],
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: [],
     },
+    annotations: {},
 };
-export const handler = (client, args) => {
-    const body = args;
-    return client.hris.company.payStatementItem.rules.create(body);
+export const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    try {
+        return asTextContentResult(await maybeFilter(jq_filter, await client.hris.company.payStatementItem.rules.create(body)));
+    }
+    catch (error) {
+        if (error instanceof Finch.APIError || isJqError(error)) {
+            return asErrorResult(error.message);
+        }
+        throw error;
+    }
 };
 export default { metadata, tool, handler };
 //# sourceMappingURL=create-pay-statement-item-company-hris-rules.mjs.map

package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"create-pay-statement-item-company-hris-rules.mjs","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAMtF,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,uCAAuC;IACjD,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,8CAA8C;IACpD,WAAW,EACT,4ZAA4Z;IAC9Z,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+DAA+D;gBAC5E,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,wJAAwJ;qBAC3J;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;yBACpD;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;4BACnD,IAAI,EAAE,CAAC,QAAQ,CAAC;yBACjB;wBACD,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,mDAAmD;yBACjE;qBACF;oBACD,QAAQ,EAAE,EAAE;iBACb;aACF;YACD,kBAAkB,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,wEAAwE;aACtF;YACD,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,kEAAkE;aAChF;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+CAA+C;gBAC5D,IAAI,EAAE,CAAC,oBAAoB,CAAC;aAC7B;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"create-pay-statement-item-company-hris-rules.mjs","sourceRoot":"","sources":["../../../../../src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mCAAmC;OACnE,EAAY,aAAa,EAAE,mBAAmB,EAAE,MAAM,qCAAqC;OAG3F,KAAK,MAAM,qBAAqB;AAEvC,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,uCAAuC;IACjD,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,mCAAmC;IAC7C,WAAW,EAAE,aAAa;CAC3B,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,8CAA8C;IACpD,WAAW,EACT,0/FAA0/F;IAC5/F,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,wCAAwC;gBACrD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+DAA+D;gBAC5E,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,wJAAwJ;wBAC1J,oBAAoB,EAAE,IAAI;qBAC3B;iBACF;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;yBACpD;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,sCAAsC;4BACnD,IAAI,EAAE,CAAC,QAAQ,CAAC;yBACjB;wBACD,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,mDAAmD;yBACjE;qBACF;iBACF;aACF;YACD,kBAAkB,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,wEAAwE;aACtF;YACD,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,kEAAkE;aAChF;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+CAA+C;gBAC5D,IAAI,EAAE,CAAC,oBAAoB,CAAC;aAC7B;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,EAAE;KACb;IACD,WAAW,EAAE,EAAE;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,IAAI,CAAC;QACH,OAAO,mBAAmB,CACxB,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAC5F,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,CAAC,QAAQ,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}