@tryfinch/finch-api-mcp 6.30.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +85 -10
- package/code-tool-types.d.mts +16 -0
- package/code-tool-types.d.mts.map +1 -0
- package/code-tool-types.d.ts +16 -0
- package/code-tool-types.d.ts.map +1 -0
- package/code-tool-types.js +4 -0
- package/code-tool-types.js.map +1 -0
- package/code-tool-types.mjs +3 -0
- package/code-tool-types.mjs.map +1 -0
- package/code-tool.d.mts +54 -0
- package/code-tool.d.mts.map +1 -0
- package/code-tool.d.ts +54 -0
- package/code-tool.d.ts.map +1 -0
- package/code-tool.js +54 -0
- package/code-tool.js.map +1 -0
- package/code-tool.mjs +51 -0
- package/code-tool.mjs.map +1 -0
- package/compat.d.mts +6 -0
- package/compat.d.mts.map +1 -1
- package/compat.d.ts +6 -0
- package/compat.d.ts.map +1 -1
- package/compat.js +52 -7
- package/compat.js.map +1 -1
- package/compat.mjs +52 -6
- package/compat.mjs.map +1 -1
- package/docs-search-tool.d.mts +50 -0
- package/docs-search-tool.d.mts.map +1 -0
- package/docs-search-tool.d.ts +50 -0
- package/docs-search-tool.d.ts.map +1 -0
- package/docs-search-tool.js +51 -0
- package/docs-search-tool.js.map +1 -0
- package/docs-search-tool.mjs +47 -0
- package/docs-search-tool.mjs.map +1 -0
- package/dynamic-tools.d.mts +2 -2
- package/dynamic-tools.d.mts.map +1 -1
- package/dynamic-tools.d.ts +2 -2
- package/dynamic-tools.d.ts.map +1 -1
- package/dynamic-tools.js +11 -9
- package/dynamic-tools.js.map +1 -1
- package/dynamic-tools.mjs +11 -9
- package/dynamic-tools.mjs.map +1 -1
- package/filtering.d.mts +3 -0
- package/filtering.d.mts.map +1 -0
- package/filtering.d.ts +3 -0
- package/filtering.d.ts.map +1 -0
- package/filtering.js +24 -0
- package/filtering.js.map +1 -0
- package/filtering.mjs +16 -0
- package/filtering.mjs.map +1 -0
- package/headers.d.mts +4 -0
- package/headers.d.mts.map +1 -0
- package/headers.d.ts +4 -0
- package/headers.d.ts.map +1 -0
- package/headers.js +31 -0
- package/headers.js.map +1 -0
- package/headers.mjs +27 -0
- package/headers.mjs.map +1 -0
- package/http.d.mts +9 -0
- package/http.d.mts.map +1 -0
- package/http.d.ts +9 -0
- package/http.d.ts.map +1 -0
- package/http.js +108 -0
- package/http.js.map +1 -0
- package/http.mjs +100 -0
- package/http.mjs.map +1 -0
- package/index.d.mts +1 -0
- package/index.d.ts +1 -0
- package/index.js +15 -10
- package/index.js.map +1 -1
- package/index.mjs +18 -12
- package/index.mjs.map +1 -1
- package/options.d.mts +17 -8
- package/options.d.mts.map +1 -1
- package/options.d.ts +17 -8
- package/options.d.ts.map +1 -1
- package/options.js +151 -61
- package/options.js.map +1 -1
- package/options.mjs +149 -60
- package/options.mjs.map +1 -1
- package/package.json +161 -12
- package/server.d.mts +12 -15
- package/server.d.mts.map +1 -1
- package/server.d.ts +12 -15
- package/server.d.ts.map +1 -1
- package/server.js +107 -36
- package/server.js.map +1 -1
- package/server.mjs +105 -36
- package/server.mjs.map +1 -1
- package/src/code-tool-types.ts +18 -0
- package/src/code-tool.ts +64 -0
- package/src/compat.ts +60 -6
- package/src/docs-search-tool.ts +59 -0
- package/src/dynamic-tools.ts +13 -12
- package/src/filtering.ts +18 -0
- package/src/headers.ts +35 -0
- package/src/http.ts +127 -0
- package/src/index.ts +20 -14
- package/src/options.ts +185 -73
- package/src/server.ts +128 -48
- package/src/stdio.ts +13 -0
- package/src/tools/access-tokens/create-access-tokens.ts +30 -5
- package/src/tools/account/disconnect-account.ts +28 -5
- package/src/tools/account/introspect-account.ts +30 -5
- package/src/tools/connect/sessions/new-connect-sessions.ts +46 -14
- package/src/tools/connect/sessions/reauthenticate-connect-sessions.ts +32 -9
- package/src/tools/hris/benefits/create-hris-benefits.ts +45 -18
- package/src/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.ts +55 -10
- package/src/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.ts +37 -5
- package/src/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.ts +36 -5
- package/src/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.ts +37 -5
- package/src/tools/hris/benefits/list-hris-benefits.ts +38 -5
- package/src/tools/hris/benefits/list-supported-benefits-hris-benefits.ts +38 -5
- package/src/tools/hris/benefits/retrieve-hris-benefits.ts +37 -5
- package/src/tools/hris/benefits/update-hris-benefits.ts +35 -5
- package/src/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.ts +35 -5
- package/src/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.ts +35 -7
- package/src/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.ts +36 -5
- package/src/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.ts +37 -5
- package/src/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.ts +37 -5
- package/src/tools/hris/company/retrieve-hris-company.ts +37 -5
- package/src/tools/hris/directory/list-hris-directory.ts +36 -5
- package/src/tools/hris/documents/list-hris-documents.ts +34 -5
- package/src/tools/hris/documents/retreive-hris-documents.ts +36 -5
- package/src/tools/hris/employments/retrieve-many-hris-employments.ts +24 -3
- package/src/tools/hris/individuals/retrieve-many-hris-individuals.ts +34 -7
- package/src/tools/hris/pay-statements/retrieve-many-hris-pay-statements.ts +24 -3
- package/src/tools/hris/payments/list-hris-payments.ts +36 -5
- package/src/tools/index.ts +6 -20
- package/src/tools/jobs/automated/create-jobs-automated.ts +28 -5
- package/src/tools/jobs/automated/list-jobs-automated.ts +27 -5
- package/src/tools/jobs/automated/retrieve-jobs-automated.ts +28 -5
- package/src/tools/jobs/manual/retrieve-jobs-manual.ts +27 -5
- package/src/tools/payroll/pay-groups/list-payroll-pay-groups.ts +36 -5
- package/src/tools/payroll/pay-groups/retrieve-payroll-pay-groups.ts +37 -5
- package/src/tools/providers/list-providers.ts +31 -5
- package/src/tools/request-forwarding/forward-request-forwarding.ts +31 -9
- package/src/tools/sandbox/company/update-sandbox-company.ts +37 -9
- package/src/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.ts +28 -5
- package/src/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.ts +29 -6
- package/src/tools/sandbox/connections/create-sandbox-connections.ts +26 -5
- package/src/tools/sandbox/directory/create-sandbox-directory.ts +31 -14
- package/src/tools/sandbox/employment/update-sandbox-employment.ts +23 -9
- package/src/tools/sandbox/individual/update-sandbox-individual.ts +30 -7
- package/src/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.ts +32 -5
- package/src/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.ts +30 -5
- package/src/tools/sandbox/jobs/create-sandbox-jobs.ts +26 -5
- package/src/tools/sandbox/payment/create-sandbox-payment.ts +89 -173
- package/src/tools/types.ts +115 -0
- package/stdio.d.mts +3 -0
- package/stdio.d.mts.map +1 -0
- package/stdio.d.ts +3 -0
- package/stdio.d.ts.map +1 -0
- package/stdio.js +14 -0
- package/stdio.js.map +1 -0
- package/stdio.mjs +10 -0
- package/stdio.mjs.map +1 -0
- package/tools/access-tokens/create-access-tokens.d.mts +26 -7
- package/tools/access-tokens/create-access-tokens.d.mts.map +1 -1
- package/tools/access-tokens/create-access-tokens.d.ts +26 -7
- package/tools/access-tokens/create-access-tokens.d.ts.map +1 -1
- package/tools/access-tokens/create-access-tokens.js +32 -4
- package/tools/access-tokens/create-access-tokens.js.map +1 -1
- package/tools/access-tokens/create-access-tokens.mjs +29 -4
- package/tools/access-tokens/create-access-tokens.mjs.map +1 -1
- package/tools/account/disconnect-account.d.mts +26 -7
- package/tools/account/disconnect-account.d.mts.map +1 -1
- package/tools/account/disconnect-account.d.ts +26 -7
- package/tools/account/disconnect-account.d.ts.map +1 -1
- package/tools/account/disconnect-account.js +30 -4
- package/tools/account/disconnect-account.js.map +1 -1
- package/tools/account/disconnect-account.mjs +27 -4
- package/tools/account/disconnect-account.mjs.map +1 -1
- package/tools/account/introspect-account.d.mts +26 -7
- package/tools/account/introspect-account.d.mts.map +1 -1
- package/tools/account/introspect-account.d.ts +26 -7
- package/tools/account/introspect-account.d.ts.map +1 -1
- package/tools/account/introspect-account.js +32 -4
- package/tools/account/introspect-account.js.map +1 -1
- package/tools/account/introspect-account.mjs +29 -4
- package/tools/account/introspect-account.mjs.map +1 -1
- package/tools/connect/sessions/new-connect-sessions.d.mts +26 -7
- package/tools/connect/sessions/new-connect-sessions.d.mts.map +1 -1
- package/tools/connect/sessions/new-connect-sessions.d.ts +26 -7
- package/tools/connect/sessions/new-connect-sessions.d.ts.map +1 -1
- package/tools/connect/sessions/new-connect-sessions.js +47 -13
- package/tools/connect/sessions/new-connect-sessions.js.map +1 -1
- package/tools/connect/sessions/new-connect-sessions.mjs +44 -13
- package/tools/connect/sessions/new-connect-sessions.mjs.map +1 -1
- package/tools/connect/sessions/reauthenticate-connect-sessions.d.mts +26 -7
- package/tools/connect/sessions/reauthenticate-connect-sessions.d.mts.map +1 -1
- package/tools/connect/sessions/reauthenticate-connect-sessions.d.ts +26 -7
- package/tools/connect/sessions/reauthenticate-connect-sessions.d.ts.map +1 -1
- package/tools/connect/sessions/reauthenticate-connect-sessions.js +32 -8
- package/tools/connect/sessions/reauthenticate-connect-sessions.js.map +1 -1
- package/tools/connect/sessions/reauthenticate-connect-sessions.mjs +29 -8
- package/tools/connect/sessions/reauthenticate-connect-sessions.mjs.map +1 -1
- package/tools/hris/benefits/create-hris-benefits.d.mts +26 -7
- package/tools/hris/benefits/create-hris-benefits.d.mts.map +1 -1
- package/tools/hris/benefits/create-hris-benefits.d.ts +26 -7
- package/tools/hris/benefits/create-hris-benefits.d.ts.map +1 -1
- package/tools/hris/benefits/create-hris-benefits.js +48 -17
- package/tools/hris/benefits/create-hris-benefits.js.map +1 -1
- package/tools/hris/benefits/create-hris-benefits.mjs +45 -17
- package/tools/hris/benefits/create-hris-benefits.mjs.map +1 -1
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.d.mts +26 -7
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.d.mts.map +1 -1
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.d.ts +26 -7
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.d.ts.map +1 -1
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.js +54 -9
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.js.map +1 -1
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.mjs +51 -9
- package/tools/hris/benefits/individuals/enroll-many-benefits-hris-individuals.mjs.map +1 -1
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.d.mts +26 -7
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.d.mts.map +1 -1
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.d.ts +26 -7
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.d.ts.map +1 -1
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.js +37 -4
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.js.map +1 -1
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.mjs +34 -4
- package/tools/hris/benefits/individuals/enrolled-ids-benefits-hris-individuals.mjs.map +1 -1
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.d.mts +26 -7
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.d.mts.map +1 -1
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.d.ts +26 -7
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.d.ts.map +1 -1
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.js +38 -4
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.js.map +1 -1
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.mjs +35 -4
- package/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.mjs.map +1 -1
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.d.mts +26 -7
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.d.mts.map +1 -1
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.d.ts +26 -7
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.d.ts.map +1 -1
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.js +37 -4
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.js.map +1 -1
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.mjs +34 -4
- package/tools/hris/benefits/individuals/unenroll-many-benefits-hris-individuals.mjs.map +1 -1
- package/tools/hris/benefits/list-hris-benefits.d.mts +26 -7
- package/tools/hris/benefits/list-hris-benefits.d.mts.map +1 -1
- package/tools/hris/benefits/list-hris-benefits.d.ts +26 -7
- package/tools/hris/benefits/list-hris-benefits.d.ts.map +1 -1
- package/tools/hris/benefits/list-hris-benefits.js +40 -4
- package/tools/hris/benefits/list-hris-benefits.js.map +1 -1
- package/tools/hris/benefits/list-hris-benefits.mjs +37 -4
- package/tools/hris/benefits/list-hris-benefits.mjs.map +1 -1
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.d.mts +26 -7
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.d.mts.map +1 -1
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.d.ts +26 -7
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.d.ts.map +1 -1
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.js +40 -4
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.js.map +1 -1
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.mjs +37 -4
- package/tools/hris/benefits/list-supported-benefits-hris-benefits.mjs.map +1 -1
- package/tools/hris/benefits/retrieve-hris-benefits.d.mts +26 -7
- package/tools/hris/benefits/retrieve-hris-benefits.d.mts.map +1 -1
- package/tools/hris/benefits/retrieve-hris-benefits.d.ts +26 -7
- package/tools/hris/benefits/retrieve-hris-benefits.d.ts.map +1 -1
- package/tools/hris/benefits/retrieve-hris-benefits.js +37 -4
- package/tools/hris/benefits/retrieve-hris-benefits.js.map +1 -1
- package/tools/hris/benefits/retrieve-hris-benefits.mjs +34 -4
- package/tools/hris/benefits/retrieve-hris-benefits.mjs.map +1 -1
- package/tools/hris/benefits/update-hris-benefits.d.mts +26 -7
- package/tools/hris/benefits/update-hris-benefits.d.mts.map +1 -1
- package/tools/hris/benefits/update-hris-benefits.d.ts +26 -7
- package/tools/hris/benefits/update-hris-benefits.d.ts.map +1 -1
- package/tools/hris/benefits/update-hris-benefits.js +35 -4
- package/tools/hris/benefits/update-hris-benefits.js.map +1 -1
- package/tools/hris/benefits/update-hris-benefits.mjs +32 -4
- package/tools/hris/benefits/update-hris-benefits.mjs.map +1 -1
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.d.mts +26 -7
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.d.mts.map +1 -1
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.d.ts +26 -7
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.d.ts.map +1 -1
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.js +38 -4
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.js.map +1 -1
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.mjs +35 -4
- package/tools/hris/company/pay-statement-item/list-company-hris-pay-statement-item.mjs.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.d.mts +26 -7
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.d.mts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.d.ts +26 -7
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.d.ts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.js +36 -6
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.js.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.mjs +33 -6
- package/tools/hris/company/pay-statement-item/rules/create-pay-statement-item-company-hris-rules.mjs.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.d.mts +26 -7
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.d.mts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.d.ts +26 -7
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.d.ts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.js +37 -4
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.js.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.mjs +34 -4
- package/tools/hris/company/pay-statement-item/rules/delete-pay-statement-item-company-hris-rules.mjs.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.d.mts +26 -7
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.d.mts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.d.ts +26 -7
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.d.ts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.js +40 -4
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.js.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.mjs +37 -4
- package/tools/hris/company/pay-statement-item/rules/list-pay-statement-item-company-hris-rules.mjs.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.d.mts +26 -7
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.d.mts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.d.ts +26 -7
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.d.ts.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.js +38 -4
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.js.map +1 -1
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.mjs +35 -4
- package/tools/hris/company/pay-statement-item/rules/update-pay-statement-item-company-hris-rules.mjs.map +1 -1
- package/tools/hris/company/retrieve-hris-company.d.mts +26 -7
- package/tools/hris/company/retrieve-hris-company.d.mts.map +1 -1
- package/tools/hris/company/retrieve-hris-company.d.ts +26 -7
- package/tools/hris/company/retrieve-hris-company.d.ts.map +1 -1
- package/tools/hris/company/retrieve-hris-company.js +39 -4
- package/tools/hris/company/retrieve-hris-company.js.map +1 -1
- package/tools/hris/company/retrieve-hris-company.mjs +36 -4
- package/tools/hris/company/retrieve-hris-company.mjs.map +1 -1
- package/tools/hris/directory/list-hris-directory.d.mts +26 -7
- package/tools/hris/directory/list-hris-directory.d.mts.map +1 -1
- package/tools/hris/directory/list-hris-directory.d.ts +26 -7
- package/tools/hris/directory/list-hris-directory.d.ts.map +1 -1
- package/tools/hris/directory/list-hris-directory.js +38 -4
- package/tools/hris/directory/list-hris-directory.js.map +1 -1
- package/tools/hris/directory/list-hris-directory.mjs +35 -4
- package/tools/hris/directory/list-hris-directory.mjs.map +1 -1
- package/tools/hris/documents/list-hris-documents.d.mts +26 -7
- package/tools/hris/documents/list-hris-documents.d.mts.map +1 -1
- package/tools/hris/documents/list-hris-documents.d.ts +26 -7
- package/tools/hris/documents/list-hris-documents.d.ts.map +1 -1
- package/tools/hris/documents/list-hris-documents.js +37 -4
- package/tools/hris/documents/list-hris-documents.js.map +1 -1
- package/tools/hris/documents/list-hris-documents.mjs +34 -4
- package/tools/hris/documents/list-hris-documents.mjs.map +1 -1
- package/tools/hris/documents/retreive-hris-documents.d.mts +26 -7
- package/tools/hris/documents/retreive-hris-documents.d.mts.map +1 -1
- package/tools/hris/documents/retreive-hris-documents.d.ts +26 -7
- package/tools/hris/documents/retreive-hris-documents.d.ts.map +1 -1
- package/tools/hris/documents/retreive-hris-documents.js +37 -4
- package/tools/hris/documents/retreive-hris-documents.js.map +1 -1
- package/tools/hris/documents/retreive-hris-documents.mjs +34 -4
- package/tools/hris/documents/retreive-hris-documents.mjs.map +1 -1
- package/tools/hris/employments/retrieve-many-hris-employments.d.mts +26 -7
- package/tools/hris/employments/retrieve-many-hris-employments.d.mts.map +1 -1
- package/tools/hris/employments/retrieve-many-hris-employments.d.ts +26 -7
- package/tools/hris/employments/retrieve-many-hris-employments.d.ts.map +1 -1
- package/tools/hris/employments/retrieve-many-hris-employments.js +28 -2
- package/tools/hris/employments/retrieve-many-hris-employments.js.map +1 -1
- package/tools/hris/employments/retrieve-many-hris-employments.mjs +25 -2
- package/tools/hris/employments/retrieve-many-hris-employments.mjs.map +1 -1
- package/tools/hris/individuals/retrieve-many-hris-individuals.d.mts +26 -7
- package/tools/hris/individuals/retrieve-many-hris-individuals.d.mts.map +1 -1
- package/tools/hris/individuals/retrieve-many-hris-individuals.d.ts +26 -7
- package/tools/hris/individuals/retrieve-many-hris-individuals.d.ts.map +1 -1
- package/tools/hris/individuals/retrieve-many-hris-individuals.js +36 -6
- package/tools/hris/individuals/retrieve-many-hris-individuals.js.map +1 -1
- package/tools/hris/individuals/retrieve-many-hris-individuals.mjs +33 -6
- package/tools/hris/individuals/retrieve-many-hris-individuals.mjs.map +1 -1
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.d.mts +26 -7
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.d.mts.map +1 -1
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.d.ts +26 -7
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.d.ts.map +1 -1
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.js +28 -2
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.js.map +1 -1
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.mjs +25 -2
- package/tools/hris/pay-statements/retrieve-many-hris-pay-statements.mjs.map +1 -1
- package/tools/hris/payments/list-hris-payments.d.mts +26 -7
- package/tools/hris/payments/list-hris-payments.d.mts.map +1 -1
- package/tools/hris/payments/list-hris-payments.d.ts +26 -7
- package/tools/hris/payments/list-hris-payments.d.ts.map +1 -1
- package/tools/hris/payments/list-hris-payments.js +38 -4
- package/tools/hris/payments/list-hris-payments.js.map +1 -1
- package/tools/hris/payments/list-hris-payments.mjs +35 -4
- package/tools/hris/payments/list-hris-payments.mjs.map +1 -1
- package/tools/index.d.mts +2 -13
- package/tools/index.d.mts.map +1 -1
- package/tools/index.d.ts +2 -13
- package/tools/index.d.ts.map +1 -1
- package/tools/index.js +3 -4
- package/tools/index.js.map +1 -1
- package/tools/index.mjs +3 -4
- package/tools/index.mjs.map +1 -1
- package/tools/jobs/automated/create-jobs-automated.d.mts +26 -7
- package/tools/jobs/automated/create-jobs-automated.d.mts.map +1 -1
- package/tools/jobs/automated/create-jobs-automated.d.ts +26 -7
- package/tools/jobs/automated/create-jobs-automated.d.ts.map +1 -1
- package/tools/jobs/automated/create-jobs-automated.js +31 -4
- package/tools/jobs/automated/create-jobs-automated.js.map +1 -1
- package/tools/jobs/automated/create-jobs-automated.mjs +28 -4
- package/tools/jobs/automated/create-jobs-automated.mjs.map +1 -1
- package/tools/jobs/automated/list-jobs-automated.d.mts +26 -7
- package/tools/jobs/automated/list-jobs-automated.d.mts.map +1 -1
- package/tools/jobs/automated/list-jobs-automated.d.ts +26 -7
- package/tools/jobs/automated/list-jobs-automated.d.ts.map +1 -1
- package/tools/jobs/automated/list-jobs-automated.js +30 -4
- package/tools/jobs/automated/list-jobs-automated.js.map +1 -1
- package/tools/jobs/automated/list-jobs-automated.mjs +27 -4
- package/tools/jobs/automated/list-jobs-automated.mjs.map +1 -1
- package/tools/jobs/automated/retrieve-jobs-automated.d.mts +26 -7
- package/tools/jobs/automated/retrieve-jobs-automated.d.mts.map +1 -1
- package/tools/jobs/automated/retrieve-jobs-automated.d.ts +26 -7
- package/tools/jobs/automated/retrieve-jobs-automated.d.ts.map +1 -1
- package/tools/jobs/automated/retrieve-jobs-automated.js +30 -4
- package/tools/jobs/automated/retrieve-jobs-automated.js.map +1 -1
- package/tools/jobs/automated/retrieve-jobs-automated.mjs +27 -4
- package/tools/jobs/automated/retrieve-jobs-automated.mjs.map +1 -1
- package/tools/jobs/manual/retrieve-jobs-manual.d.mts +26 -7
- package/tools/jobs/manual/retrieve-jobs-manual.d.mts.map +1 -1
- package/tools/jobs/manual/retrieve-jobs-manual.d.ts +26 -7
- package/tools/jobs/manual/retrieve-jobs-manual.d.ts.map +1 -1
- package/tools/jobs/manual/retrieve-jobs-manual.js +30 -4
- package/tools/jobs/manual/retrieve-jobs-manual.js.map +1 -1
- package/tools/jobs/manual/retrieve-jobs-manual.mjs +27 -4
- package/tools/jobs/manual/retrieve-jobs-manual.mjs.map +1 -1
- package/tools/payroll/pay-groups/list-payroll-pay-groups.d.mts +26 -7
- package/tools/payroll/pay-groups/list-payroll-pay-groups.d.mts.map +1 -1
- package/tools/payroll/pay-groups/list-payroll-pay-groups.d.ts +26 -7
- package/tools/payroll/pay-groups/list-payroll-pay-groups.d.ts.map +1 -1
- package/tools/payroll/pay-groups/list-payroll-pay-groups.js +38 -4
- package/tools/payroll/pay-groups/list-payroll-pay-groups.js.map +1 -1
- package/tools/payroll/pay-groups/list-payroll-pay-groups.mjs +35 -4
- package/tools/payroll/pay-groups/list-payroll-pay-groups.mjs.map +1 -1
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.d.mts +26 -7
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.d.mts.map +1 -1
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.d.ts +26 -7
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.d.ts.map +1 -1
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.js +37 -4
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.js.map +1 -1
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.mjs +34 -4
- package/tools/payroll/pay-groups/retrieve-payroll-pay-groups.mjs.map +1 -1
- package/tools/providers/list-providers.d.mts +26 -7
- package/tools/providers/list-providers.d.mts.map +1 -1
- package/tools/providers/list-providers.d.ts +26 -7
- package/tools/providers/list-providers.d.ts.map +1 -1
- package/tools/providers/list-providers.js +33 -4
- package/tools/providers/list-providers.js.map +1 -1
- package/tools/providers/list-providers.mjs +30 -4
- package/tools/providers/list-providers.mjs.map +1 -1
- package/tools/request-forwarding/forward-request-forwarding.d.mts +26 -7
- package/tools/request-forwarding/forward-request-forwarding.d.mts.map +1 -1
- package/tools/request-forwarding/forward-request-forwarding.d.ts +26 -7
- package/tools/request-forwarding/forward-request-forwarding.d.ts.map +1 -1
- package/tools/request-forwarding/forward-request-forwarding.js +34 -8
- package/tools/request-forwarding/forward-request-forwarding.js.map +1 -1
- package/tools/request-forwarding/forward-request-forwarding.mjs +31 -8
- package/tools/request-forwarding/forward-request-forwarding.mjs.map +1 -1
- package/tools/sandbox/company/update-sandbox-company.d.mts +26 -7
- package/tools/sandbox/company/update-sandbox-company.d.mts.map +1 -1
- package/tools/sandbox/company/update-sandbox-company.d.ts +26 -7
- package/tools/sandbox/company/update-sandbox-company.d.ts.map +1 -1
- package/tools/sandbox/company/update-sandbox-company.js +39 -8
- package/tools/sandbox/company/update-sandbox-company.js.map +1 -1
- package/tools/sandbox/company/update-sandbox-company.mjs +36 -8
- package/tools/sandbox/company/update-sandbox-company.mjs.map +1 -1
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.d.mts +26 -7
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.d.mts.map +1 -1
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.d.ts +26 -7
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.d.ts.map +1 -1
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.js +28 -4
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.js.map +1 -1
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.mjs +25 -4
- package/tools/sandbox/connections/accounts/create-connections-sandbox-accounts.mjs.map +1 -1
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.d.mts +26 -7
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.d.mts.map +1 -1
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.d.ts +26 -7
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.d.ts.map +1 -1
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.js +30 -5
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.js.map +1 -1
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.mjs +27 -5
- package/tools/sandbox/connections/accounts/update-connections-sandbox-accounts.mjs.map +1 -1
- package/tools/sandbox/connections/create-sandbox-connections.d.mts +26 -7
- package/tools/sandbox/connections/create-sandbox-connections.d.mts.map +1 -1
- package/tools/sandbox/connections/create-sandbox-connections.d.ts +26 -7
- package/tools/sandbox/connections/create-sandbox-connections.d.ts.map +1 -1
- package/tools/sandbox/connections/create-sandbox-connections.js +28 -4
- package/tools/sandbox/connections/create-sandbox-connections.js.map +1 -1
- package/tools/sandbox/connections/create-sandbox-connections.mjs +25 -4
- package/tools/sandbox/connections/create-sandbox-connections.mjs.map +1 -1
- package/tools/sandbox/directory/create-sandbox-directory.d.mts +26 -7
- package/tools/sandbox/directory/create-sandbox-directory.d.mts.map +1 -1
- package/tools/sandbox/directory/create-sandbox-directory.d.ts +26 -7
- package/tools/sandbox/directory/create-sandbox-directory.d.ts.map +1 -1
- package/tools/sandbox/directory/create-sandbox-directory.js +32 -13
- package/tools/sandbox/directory/create-sandbox-directory.js.map +1 -1
- package/tools/sandbox/directory/create-sandbox-directory.mjs +29 -13
- package/tools/sandbox/directory/create-sandbox-directory.mjs.map +1 -1
- package/tools/sandbox/employment/update-sandbox-employment.d.mts +26 -7
- package/tools/sandbox/employment/update-sandbox-employment.d.mts.map +1 -1
- package/tools/sandbox/employment/update-sandbox-employment.d.ts +26 -7
- package/tools/sandbox/employment/update-sandbox-employment.d.ts.map +1 -1
- package/tools/sandbox/employment/update-sandbox-employment.js +26 -8
- package/tools/sandbox/employment/update-sandbox-employment.js.map +1 -1
- package/tools/sandbox/employment/update-sandbox-employment.mjs +23 -8
- package/tools/sandbox/employment/update-sandbox-employment.mjs.map +1 -1
- package/tools/sandbox/individual/update-sandbox-individual.d.mts +26 -7
- package/tools/sandbox/individual/update-sandbox-individual.d.mts.map +1 -1
- package/tools/sandbox/individual/update-sandbox-individual.d.ts +26 -7
- package/tools/sandbox/individual/update-sandbox-individual.d.ts.map +1 -1
- package/tools/sandbox/individual/update-sandbox-individual.js +30 -6
- package/tools/sandbox/individual/update-sandbox-individual.js.map +1 -1
- package/tools/sandbox/individual/update-sandbox-individual.mjs +27 -6
- package/tools/sandbox/individual/update-sandbox-individual.mjs.map +1 -1
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.d.mts +26 -7
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.d.mts.map +1 -1
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.d.ts +26 -7
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.d.ts.map +1 -1
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.js +32 -4
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.js.map +1 -1
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.mjs +29 -4
- package/tools/sandbox/jobs/configuration/retrieve-jobs-sandbox-configuration.mjs.map +1 -1
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.d.mts +26 -7
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.d.mts.map +1 -1
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.d.ts +26 -7
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.d.ts.map +1 -1
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.js +30 -4
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.js.map +1 -1
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.mjs +27 -4
- package/tools/sandbox/jobs/configuration/update-jobs-sandbox-configuration.mjs.map +1 -1
- package/tools/sandbox/jobs/create-sandbox-jobs.d.mts +26 -7
- package/tools/sandbox/jobs/create-sandbox-jobs.d.mts.map +1 -1
- package/tools/sandbox/jobs/create-sandbox-jobs.d.ts +26 -7
- package/tools/sandbox/jobs/create-sandbox-jobs.d.ts.map +1 -1
- package/tools/sandbox/jobs/create-sandbox-jobs.js +28 -4
- package/tools/sandbox/jobs/create-sandbox-jobs.js.map +1 -1
- package/tools/sandbox/jobs/create-sandbox-jobs.mjs +25 -4
- package/tools/sandbox/jobs/create-sandbox-jobs.mjs.map +1 -1
- package/tools/sandbox/payment/create-sandbox-payment.d.mts +26 -7
- package/tools/sandbox/payment/create-sandbox-payment.d.mts.map +1 -1
- package/tools/sandbox/payment/create-sandbox-payment.d.ts +26 -7
- package/tools/sandbox/payment/create-sandbox-payment.d.ts.map +1 -1
- package/tools/sandbox/payment/create-sandbox-payment.js +91 -167
- package/tools/sandbox/payment/create-sandbox-payment.js.map +1 -1
- package/tools/sandbox/payment/create-sandbox-payment.mjs +88 -167
- package/tools/sandbox/payment/create-sandbox-payment.mjs.map +1 -1
- package/tools/types.d.mts +52 -0
- package/tools/types.d.mts.map +1 -0
- package/tools/types.d.ts +52 -0
- package/tools/types.d.ts.map +1 -0
- package/tools/types.js +58 -0
- package/tools/types.js.map +1 -0
- package/tools/types.mjs +53 -0
- package/tools/types.mjs.map +1 -0
- package/src/tools/hris/directory/list-individuals-hris-directory.ts +0 -36
- package/tools/hris/directory/list-individuals-hris-directory.d.mts +0 -32
- package/tools/hris/directory/list-individuals-hris-directory.d.mts.map +0 -1
- package/tools/hris/directory/list-individuals-hris-directory.d.ts +0 -32
- package/tools/hris/directory/list-individuals-hris-directory.d.ts.map +0 -1
- package/tools/hris/directory/list-individuals-hris-directory.js +0 -33
- package/tools/hris/directory/list-individuals-hris-directory.js.map +0 -1
- package/tools/hris/directory/list-individuals-hris-directory.mjs +0 -29
- package/tools/hris/directory/list-individuals-hris-directory.mjs.map +0 -1
package/src/tools/hris/benefits/individuals/retrieve-many-benefits-benefits-hris-individuals.ts
CHANGED
|
@@ -1,36 +1,67 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.benefits.individuals',
|
|
9
11
|
operation: 'read',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'get',
|
|
14
|
+
httpPath: '/employer/benefits/{benefit_id}/individuals',
|
|
15
|
+
operationId: 'get-individual-benefits',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'retrieve_many_benefits_benefits_hris_individuals',
|
|
15
|
-
description:
|
|
20
|
+
description:
|
|
21
|
+
"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\nGet enrollment information for the given individuals.\n\n# Response Schema\n```json\n{\n type: 'array',\n title: 'IndividualBenefits',\n items: {\n $ref: '#/$defs/individual_benefit'\n },\n $defs: {\n individual_benefit: {\n type: 'object',\n properties: {\n body: {\n anyOf: [ {\n type: 'object',\n properties: {\n annual_maximum: {\n type: 'integer',\n description: 'If the benefit supports annual maximum, the amount in cents for this individual.'\n },\n catch_up: {\n type: 'boolean',\n description: 'If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled for this individual.'\n },\n company_contribution: {\n anyOf: [ {\n type: 'object',\n properties: {\n amount: {\n type: 'integer',\n description: 'Contribution amount in cents (for type=fixed) or basis points (for type=percent, where 100 = 1%). Not used for type=tiered.'\n },\n type: {\n type: 'string',\n description: 'Contribution type. Supported values: \"fixed\" (amount in cents), \"percent\" (amount in basis points), or \"tiered\" (multi-tier matching).',\n enum: [ 'fixed'\n ]\n }\n },\n required: [ 'amount',\n 'type'\n ]\n },\n {\n type: 'object',\n properties: {\n amount: {\n type: 'integer',\n description: 'Contribution amount in cents (for type=fixed) or basis points (for type=percent, where 100 = 1%). Not used for type=tiered.'\n },\n type: {\n type: 'string',\n description: 'Contribution type. Supported values: \"fixed\" (amount in cents), \"percent\" (amount in basis points), or \"tiered\" (multi-tier matching).',\n enum: [ 'percent'\n ]\n }\n },\n required: [ 'amount',\n 'type'\n ]\n },\n {\n type: 'object',\n properties: {\n tiers: {\n type: 'array',\n description: 'Array of tier objects defining employer match tiers based on employee contribution thresholds. Required when type=tiered.',\n items: {\n type: 'object',\n properties: {\n match: {\n type: 'integer'\n },\n threshold: {\n type: 'integer'\n }\n },\n required: [ 'match',\n 'threshold'\n ]\n }\n },\n type: {\n type: 'string',\n description: 'Contribution type. Supported values: \"fixed\" (amount in cents), \"percent\" (amount in basis points), or \"tiered\" (multi-tier matching).',\n enum: [ 'tiered'\n ]\n }\n },\n required: [ 'tiers',\n 'type'\n ]\n }\n ],\n title: 'CompanyContribution',\n description: 'Company contribution configuration. Supports fixed amounts (in cents), percentage-based contributions (in basis points where 100 = 1%), or tiered matching structures.'\n },\n employee_deduction: {\n anyOf: [ {\n type: 'object',\n properties: {\n amount: {\n type: 'integer',\n description: 'Contribution amount in cents (for type=fixed) or basis points (for type=percent, where 100 = 1%).'\n },\n type: {\n type: 'string',\n description: 'Contribution type. Supported values: \"fixed\" (amount in cents) or \"percent\" (amount in basis points).',\n enum: [ 'fixed'\n ]\n }\n },\n required: [ 'amount',\n 'type'\n ]\n },\n {\n type: 'object',\n properties: {\n amount: {\n type: 'integer',\n description: 'Contribution amount in cents (for type=fixed) or basis points (for type=percent, where 100 = 1%).'\n },\n type: {\n type: 'string',\n description: 'Contribution type. Supported values: \"fixed\" (amount in cents) or \"percent\" (amount in basis points).',\n enum: [ 'percent'\n ]\n }\n },\n required: [ 'amount',\n 'type'\n ]\n }\n ],\n title: 'EmployeeDeductionContribution',\n description: 'Employee deduction configuration. Supports both fixed amounts (in cents) and percentage-based contributions (in basis points where 100 = 1%).'\n },\n hsa_contribution_limit: {\n type: 'string',\n description: 'Type for HSA contribution limit if the benefit is a HSA.',\n enum: [ 'individual',\n 'family'\n ]\n }\n },\n required: [ 'annual_maximum',\n 'catch_up',\n 'company_contribution',\n 'employee_deduction'\n ]\n },\n {\n type: 'object',\n properties: {\n code: {\n type: 'number'\n },\n message: {\n type: 'string'\n },\n name: {\n type: 'string'\n },\n finch_code: {\n type: 'string'\n }\n },\n required: [ 'code',\n 'message',\n 'name'\n ]\n }\n ]\n },\n code: {\n type: 'integer'\n },\n individual_id: {\n type: 'string'\n }\n },\n required: [ 'body',\n 'code',\n 'individual_id'\n ]\n }\n }\n}\n```",
|
|
16
22
|
inputSchema: {
|
|
17
23
|
type: 'object',
|
|
18
24
|
properties: {
|
|
19
25
|
benefit_id: {
|
|
20
26
|
type: 'string',
|
|
21
27
|
},
|
|
28
|
+
entity_ids: {
|
|
29
|
+
type: 'array',
|
|
30
|
+
description: "The entity IDs to specify which entities' data to access.",
|
|
31
|
+
items: {
|
|
32
|
+
type: 'string',
|
|
33
|
+
},
|
|
34
|
+
},
|
|
22
35
|
individual_ids: {
|
|
23
36
|
type: 'string',
|
|
24
37
|
description:
|
|
25
38
|
'comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals',
|
|
26
39
|
},
|
|
40
|
+
jq_filter: {
|
|
41
|
+
type: 'string',
|
|
42
|
+
title: 'jq Filter',
|
|
43
|
+
description:
|
|
44
|
+
'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/).',
|
|
45
|
+
},
|
|
27
46
|
},
|
|
47
|
+
required: ['benefit_id'],
|
|
48
|
+
},
|
|
49
|
+
annotations: {
|
|
50
|
+
readOnlyHint: true,
|
|
28
51
|
},
|
|
29
52
|
};
|
|
30
53
|
|
|
31
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
32
|
-
const { benefit_id, ...body } = args as any;
|
|
33
|
-
|
|
54
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
55
|
+
const { benefit_id, jq_filter, ...body } = args as any;
|
|
56
|
+
const response = await client.hris.benefits.individuals.retrieveManyBenefits(benefit_id, body).asResponse();
|
|
57
|
+
try {
|
|
58
|
+
return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
|
|
59
|
+
} catch (error) {
|
|
60
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
61
|
+
return asErrorResult(error.message);
|
|
62
|
+
}
|
|
63
|
+
throw error;
|
|
64
|
+
}
|
|
34
65
|
};
|
|
35
66
|
|
|
36
67
|
export default { metadata, tool, handler };
|
|
@@ -1,24 +1,37 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.benefits.individuals',
|
|
9
11
|
operation: 'write',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'delete',
|
|
14
|
+
httpPath: '/employer/benefits/{benefit_id}/individuals',
|
|
15
|
+
operationId: 'delete-individual-benefits',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'unenroll_many_benefits_hris_individuals',
|
|
15
|
-
description:
|
|
20
|
+
description:
|
|
21
|
+
"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\nUnenroll individuals from a deduction or contribution\n\n# Response Schema\n```json\n{\n $ref: '#/$defs/unenrolled_individual_benefit_response',\n $defs: {\n unenrolled_individual_benefit_response: {\n type: 'object',\n properties: {\n job_id: {\n type: 'string'\n }\n },\n required: [ 'job_id'\n ]\n }\n }\n}\n```",
|
|
16
22
|
inputSchema: {
|
|
17
23
|
type: 'object',
|
|
18
24
|
properties: {
|
|
19
25
|
benefit_id: {
|
|
20
26
|
type: 'string',
|
|
21
27
|
},
|
|
28
|
+
entity_ids: {
|
|
29
|
+
type: 'array',
|
|
30
|
+
description: "The entity IDs to specify which entities' data to access.",
|
|
31
|
+
items: {
|
|
32
|
+
type: 'string',
|
|
33
|
+
},
|
|
34
|
+
},
|
|
22
35
|
individual_ids: {
|
|
23
36
|
type: 'array',
|
|
24
37
|
description: 'Array of individual_ids to unenroll.',
|
|
@@ -26,13 +39,32 @@ export const tool: Tool = {
|
|
|
26
39
|
type: 'string',
|
|
27
40
|
},
|
|
28
41
|
},
|
|
42
|
+
jq_filter: {
|
|
43
|
+
type: 'string',
|
|
44
|
+
title: 'jq Filter',
|
|
45
|
+
description:
|
|
46
|
+
'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/).',
|
|
47
|
+
},
|
|
29
48
|
},
|
|
49
|
+
required: ['benefit_id'],
|
|
50
|
+
},
|
|
51
|
+
annotations: {
|
|
52
|
+
idempotentHint: true,
|
|
30
53
|
},
|
|
31
54
|
};
|
|
32
55
|
|
|
33
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
34
|
-
const { benefit_id, ...body } = args as any;
|
|
35
|
-
|
|
56
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
57
|
+
const { benefit_id, jq_filter, ...body } = args as any;
|
|
58
|
+
try {
|
|
59
|
+
return asTextContentResult(
|
|
60
|
+
await maybeFilter(jq_filter, await client.hris.benefits.individuals.unenrollMany(benefit_id, body)),
|
|
61
|
+
);
|
|
62
|
+
} catch (error) {
|
|
63
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
64
|
+
return asErrorResult(error.message);
|
|
65
|
+
}
|
|
66
|
+
throw error;
|
|
67
|
+
}
|
|
36
68
|
};
|
|
37
69
|
|
|
38
70
|
export default { metadata, tool, handler };
|
|
@@ -1,26 +1,59 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.benefits',
|
|
9
11
|
operation: 'read',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'get',
|
|
14
|
+
httpPath: '/employer/benefits',
|
|
15
|
+
operationId: 'get-company-benefits',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'list_hris_benefits',
|
|
15
|
-
description:
|
|
20
|
+
description:
|
|
21
|
+
"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\nList all company-wide deductions and contributions.\n\n# Response Schema\n```json\n{\n type: 'array',\n description: 'Array of company benefits.',\n items: {\n $ref: '#/$defs/company_benefit'\n },\n $defs: {\n company_benefit: {\n type: 'object',\n title: 'CompanyBenefit',\n properties: {\n benefit_id: {\n type: 'string',\n description: 'The id of the benefit.'\n },\n description: {\n type: 'string'\n },\n frequency: {\n $ref: '#/$defs/benefit_frequency'\n },\n type: {\n $ref: '#/$defs/benefit_type'\n },\n company_contribution: {\n type: 'object',\n title: 'BenefitCompanyMatchContribution',\n description: 'The company match for this benefit.',\n properties: {\n tiers: {\n type: 'array',\n items: {\n type: 'object',\n properties: {\n match: {\n type: 'integer'\n },\n threshold: {\n type: 'integer'\n }\n },\n required: [ 'match',\n 'threshold'\n ]\n }\n },\n type: {\n type: 'string',\n enum: [ 'match'\n ]\n }\n },\n required: [ 'tiers',\n 'type'\n ]\n }\n },\n required: [ 'benefit_id',\n 'description',\n 'frequency',\n 'type'\n ]\n },\n benefit_frequency: {\n type: 'string',\n title: 'BenefitFrequency',\n description: 'The frequency of the benefit deduction/contribution.',\n enum: [ 'every_paycheck',\n 'monthly',\n 'one_time'\n ]\n },\n benefit_type: {\n type: 'string',\n title: 'BenefitType',\n description: 'Type of benefit.',\n enum: [ '457',\n '401k',\n '401k_roth',\n '401k_loan',\n '403b',\n '403b_roth',\n '457_roth',\n 'commuter',\n 'custom_post_tax',\n 'custom_pre_tax',\n 'fsa_dependent_care',\n 'fsa_medical',\n 'hsa_post',\n 'hsa_pre',\n 's125_dental',\n 's125_medical',\n 's125_vision',\n 'simple',\n 'simple_ira'\n ]\n }\n }\n}\n```",
|
|
16
22
|
inputSchema: {
|
|
17
23
|
type: 'object',
|
|
18
|
-
properties: {
|
|
24
|
+
properties: {
|
|
25
|
+
entity_ids: {
|
|
26
|
+
type: 'array',
|
|
27
|
+
description: "The entity IDs to specify which entities' data to access.",
|
|
28
|
+
items: {
|
|
29
|
+
type: 'string',
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
jq_filter: {
|
|
33
|
+
type: 'string',
|
|
34
|
+
title: 'jq Filter',
|
|
35
|
+
description:
|
|
36
|
+
'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/).',
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
required: [],
|
|
40
|
+
},
|
|
41
|
+
annotations: {
|
|
42
|
+
readOnlyHint: true,
|
|
19
43
|
},
|
|
20
44
|
};
|
|
21
45
|
|
|
22
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
23
|
-
|
|
46
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
47
|
+
const { jq_filter, ...body } = args as any;
|
|
48
|
+
const response = await client.hris.benefits.list(body).asResponse();
|
|
49
|
+
try {
|
|
50
|
+
return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
|
|
51
|
+
} catch (error) {
|
|
52
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
53
|
+
return asErrorResult(error.message);
|
|
54
|
+
}
|
|
55
|
+
throw error;
|
|
56
|
+
}
|
|
24
57
|
};
|
|
25
58
|
|
|
26
59
|
export default { metadata, tool, handler };
|
|
@@ -1,26 +1,59 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.benefits',
|
|
9
11
|
operation: 'read',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'get',
|
|
14
|
+
httpPath: '/employer/benefits/meta',
|
|
15
|
+
operationId: 'get-company-benefits-meta',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'list_supported_benefits_hris_benefits',
|
|
15
|
-
description:
|
|
20
|
+
description:
|
|
21
|
+
"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\nGet deductions metadata\n\n# Response Schema\n```json\n{\n type: 'array',\n items: {\n $ref: '#/$defs/supported_benefit'\n },\n $defs: {\n supported_benefit: {\n type: 'object',\n title: 'BenefitFeature',\n properties: {\n annual_maximum: {\n type: 'boolean',\n description: 'Whether the provider supports an annual maximum for this benefit.'\n },\n company_contribution: {\n type: 'array',\n description: 'Supported contribution types. An empty array indicates contributions are not supported.',\n items: {\n type: 'string',\n enum: [ 'fixed',\n 'percent',\n 'tiered'\n ]\n }\n },\n description: {\n type: 'string'\n },\n employee_deduction: {\n type: 'array',\n description: 'Supported deduction types. An empty array indicates deductions are not supported.',\n items: {\n type: 'string',\n enum: [ 'fixed',\n 'percent'\n ]\n }\n },\n frequencies: {\n type: 'array',\n description: 'The list of frequencies supported by the provider for this benefit',\n items: {\n $ref: '#/$defs/benefit_frequency'\n }\n },\n catch_up: {\n type: 'boolean',\n description: 'Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.'\n },\n hsa_contribution_limit: {\n type: 'array',\n description: 'Whether the provider supports HSA contribution limits. Empty if this feature is not supported for the benefit. This array only has values for HSA benefits.',\n items: {\n type: 'string',\n enum: [ 'family',\n 'individual'\n ]\n }\n }\n },\n required: [ 'annual_maximum',\n 'company_contribution',\n 'description',\n 'employee_deduction',\n 'frequencies'\n ]\n },\n benefit_frequency: {\n type: 'string',\n title: 'BenefitFrequency',\n description: 'The frequency of the benefit deduction/contribution.',\n enum: [ 'every_paycheck',\n 'monthly',\n 'one_time'\n ]\n }\n }\n}\n```",
|
|
16
22
|
inputSchema: {
|
|
17
23
|
type: 'object',
|
|
18
|
-
properties: {
|
|
24
|
+
properties: {
|
|
25
|
+
entity_ids: {
|
|
26
|
+
type: 'array',
|
|
27
|
+
description: "The entity IDs to specify which entities' data to access.",
|
|
28
|
+
items: {
|
|
29
|
+
type: 'string',
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
jq_filter: {
|
|
33
|
+
type: 'string',
|
|
34
|
+
title: 'jq Filter',
|
|
35
|
+
description:
|
|
36
|
+
'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/).',
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
required: [],
|
|
40
|
+
},
|
|
41
|
+
annotations: {
|
|
42
|
+
readOnlyHint: true,
|
|
19
43
|
},
|
|
20
44
|
};
|
|
21
45
|
|
|
22
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
23
|
-
|
|
46
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
47
|
+
const { jq_filter, ...body } = args as any;
|
|
48
|
+
const response = await client.hris.benefits.listSupportedBenefits(body).asResponse();
|
|
49
|
+
try {
|
|
50
|
+
return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
|
|
51
|
+
} catch (error) {
|
|
52
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
53
|
+
return asErrorResult(error.message);
|
|
54
|
+
}
|
|
55
|
+
throw error;
|
|
56
|
+
}
|
|
24
57
|
};
|
|
25
58
|
|
|
26
59
|
export default { metadata, tool, handler };
|
|
@@ -1,31 +1,63 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.benefits',
|
|
9
11
|
operation: 'read',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'get',
|
|
14
|
+
httpPath: '/employer/benefits/{benefit_id}',
|
|
15
|
+
operationId: 'get-company-benefit',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'retrieve_hris_benefits',
|
|
15
|
-
description:
|
|
20
|
+
description:
|
|
21
|
+
"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\nLists deductions and contributions information for a given item\n\n# Response Schema\n```json\n{\n $ref: '#/$defs/company_benefit',\n $defs: {\n company_benefit: {\n type: 'object',\n title: 'CompanyBenefit',\n properties: {\n benefit_id: {\n type: 'string',\n description: 'The id of the benefit.'\n },\n description: {\n type: 'string'\n },\n frequency: {\n $ref: '#/$defs/benefit_frequency'\n },\n type: {\n $ref: '#/$defs/benefit_type'\n },\n company_contribution: {\n type: 'object',\n title: 'BenefitCompanyMatchContribution',\n description: 'The company match for this benefit.',\n properties: {\n tiers: {\n type: 'array',\n items: {\n type: 'object',\n properties: {\n match: {\n type: 'integer'\n },\n threshold: {\n type: 'integer'\n }\n },\n required: [ 'match',\n 'threshold'\n ]\n }\n },\n type: {\n type: 'string',\n enum: [ 'match'\n ]\n }\n },\n required: [ 'tiers',\n 'type'\n ]\n }\n },\n required: [ 'benefit_id',\n 'description',\n 'frequency',\n 'type'\n ]\n },\n benefit_frequency: {\n type: 'string',\n title: 'BenefitFrequency',\n description: 'The frequency of the benefit deduction/contribution.',\n enum: [ 'every_paycheck',\n 'monthly',\n 'one_time'\n ]\n },\n benefit_type: {\n type: 'string',\n title: 'BenefitType',\n description: 'Type of benefit.',\n enum: [ '457',\n '401k',\n '401k_roth',\n '401k_loan',\n '403b',\n '403b_roth',\n '457_roth',\n 'commuter',\n 'custom_post_tax',\n 'custom_pre_tax',\n 'fsa_dependent_care',\n 'fsa_medical',\n 'hsa_post',\n 'hsa_pre',\n 's125_dental',\n 's125_medical',\n 's125_vision',\n 'simple',\n 'simple_ira'\n ]\n }\n }\n}\n```",
|
|
16
22
|
inputSchema: {
|
|
17
23
|
type: 'object',
|
|
18
24
|
properties: {
|
|
19
25
|
benefit_id: {
|
|
20
26
|
type: 'string',
|
|
21
27
|
},
|
|
28
|
+
entity_ids: {
|
|
29
|
+
type: 'array',
|
|
30
|
+
description: "The entity IDs to specify which entities' data to access.",
|
|
31
|
+
items: {
|
|
32
|
+
type: 'string',
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
jq_filter: {
|
|
36
|
+
type: 'string',
|
|
37
|
+
title: 'jq Filter',
|
|
38
|
+
description:
|
|
39
|
+
'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/).',
|
|
40
|
+
},
|
|
22
41
|
},
|
|
42
|
+
required: ['benefit_id'],
|
|
43
|
+
},
|
|
44
|
+
annotations: {
|
|
45
|
+
readOnlyHint: true,
|
|
23
46
|
},
|
|
24
47
|
};
|
|
25
48
|
|
|
26
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
27
|
-
const { benefit_id, ...body } = args as any;
|
|
28
|
-
|
|
49
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
50
|
+
const { benefit_id, jq_filter, ...body } = args as any;
|
|
51
|
+
try {
|
|
52
|
+
return asTextContentResult(
|
|
53
|
+
await maybeFilter(jq_filter, await client.hris.benefits.retrieve(benefit_id, body)),
|
|
54
|
+
);
|
|
55
|
+
} catch (error) {
|
|
56
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
57
|
+
return asErrorResult(error.message);
|
|
58
|
+
}
|
|
59
|
+
throw error;
|
|
60
|
+
}
|
|
29
61
|
};
|
|
30
62
|
|
|
31
63
|
export default { metadata, tool, handler };
|
|
@@ -1,35 +1,65 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.benefits',
|
|
9
11
|
operation: 'write',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'post',
|
|
14
|
+
httpPath: '/employer/benefits/{benefit_id}',
|
|
15
|
+
operationId: 'update-company-benefits',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'update_hris_benefits',
|
|
15
|
-
description:
|
|
20
|
+
description:
|
|
21
|
+
"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\nUpdates an existing company-wide deduction or contribution\n\n# Response Schema\n```json\n{\n $ref: '#/$defs/update_company_benefit_response',\n $defs: {\n update_company_benefit_response: {\n type: 'object',\n properties: {\n benefit_id: {\n type: 'string',\n description: 'The id of the benefit.'\n },\n job_id: {\n type: 'string'\n }\n },\n required: [ 'benefit_id',\n 'job_id'\n ]\n }\n }\n}\n```",
|
|
16
22
|
inputSchema: {
|
|
17
23
|
type: 'object',
|
|
18
24
|
properties: {
|
|
19
25
|
benefit_id: {
|
|
20
26
|
type: 'string',
|
|
21
27
|
},
|
|
28
|
+
entity_ids: {
|
|
29
|
+
type: 'array',
|
|
30
|
+
description: "The entity IDs to specify which entities' data to access.",
|
|
31
|
+
items: {
|
|
32
|
+
type: 'string',
|
|
33
|
+
},
|
|
34
|
+
},
|
|
22
35
|
description: {
|
|
23
36
|
type: 'string',
|
|
24
37
|
description: 'Updated name or description.',
|
|
25
38
|
},
|
|
39
|
+
jq_filter: {
|
|
40
|
+
type: 'string',
|
|
41
|
+
title: 'jq Filter',
|
|
42
|
+
description:
|
|
43
|
+
'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/).',
|
|
44
|
+
},
|
|
26
45
|
},
|
|
46
|
+
required: ['benefit_id'],
|
|
27
47
|
},
|
|
48
|
+
annotations: {},
|
|
28
49
|
};
|
|
29
50
|
|
|
30
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
31
|
-
const { benefit_id, ...body } = args as any;
|
|
32
|
-
|
|
51
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
52
|
+
const { benefit_id, jq_filter, ...body } = args as any;
|
|
53
|
+
try {
|
|
54
|
+
return asTextContentResult(
|
|
55
|
+
await maybeFilter(jq_filter, await client.hris.benefits.update(benefit_id, body)),
|
|
56
|
+
);
|
|
57
|
+
} catch (error) {
|
|
58
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
59
|
+
return asErrorResult(error.message);
|
|
60
|
+
}
|
|
61
|
+
throw error;
|
|
62
|
+
}
|
|
33
63
|
};
|
|
34
64
|
|
|
35
65
|
export default { metadata, tool, handler };
|
|
@@ -1,19 +1,24 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.company.pay_statement_item',
|
|
9
11
|
operation: 'read',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'get',
|
|
14
|
+
httpPath: '/employer/pay-statement-item',
|
|
15
|
+
operationId: 'get-pay-statement-item',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'list_company_hris_pay_statement_item',
|
|
15
20
|
description:
|
|
16
|
-
"**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",
|
|
21
|
+
"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```",
|
|
17
22
|
inputSchema: {
|
|
18
23
|
type: 'object',
|
|
19
24
|
properties: {
|
|
@@ -32,6 +37,13 @@ export const tool: Tool = {
|
|
|
32
37
|
'The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.',
|
|
33
38
|
format: 'date',
|
|
34
39
|
},
|
|
40
|
+
entity_ids: {
|
|
41
|
+
type: 'array',
|
|
42
|
+
description: "The entity IDs to specify which entities' data to access.",
|
|
43
|
+
items: {
|
|
44
|
+
type: 'string',
|
|
45
|
+
},
|
|
46
|
+
},
|
|
35
47
|
name: {
|
|
36
48
|
type: 'string',
|
|
37
49
|
description: 'Case-insensitive partial match search by pay statement item name.',
|
|
@@ -46,13 +58,31 @@ export const tool: Tool = {
|
|
|
46
58
|
type: 'string',
|
|
47
59
|
description: 'String search by pay statement item type.',
|
|
48
60
|
},
|
|
61
|
+
jq_filter: {
|
|
62
|
+
type: 'string',
|
|
63
|
+
title: 'jq Filter',
|
|
64
|
+
description:
|
|
65
|
+
'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/).',
|
|
66
|
+
},
|
|
49
67
|
},
|
|
68
|
+
required: [],
|
|
69
|
+
},
|
|
70
|
+
annotations: {
|
|
71
|
+
readOnlyHint: true,
|
|
50
72
|
},
|
|
51
73
|
};
|
|
52
74
|
|
|
53
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
54
|
-
const body = args as any;
|
|
55
|
-
|
|
75
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
76
|
+
const { jq_filter, ...body } = args as any;
|
|
77
|
+
const response = await client.hris.company.payStatementItem.list(body).asResponse();
|
|
78
|
+
try {
|
|
79
|
+
return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
|
|
80
|
+
} catch (error) {
|
|
81
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
82
|
+
return asErrorResult(error.message);
|
|
83
|
+
}
|
|
84
|
+
throw error;
|
|
85
|
+
}
|
|
56
86
|
};
|
|
57
87
|
|
|
58
88
|
export default { metadata, tool, handler };
|
|
@@ -1,22 +1,34 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
|
|
4
|
+
import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
|
|
5
|
+
|
|
3
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
|
-
import type { Metadata } from '../../../../';
|
|
5
7
|
import Finch from '@tryfinch/finch-api';
|
|
6
8
|
|
|
7
9
|
export const metadata: Metadata = {
|
|
8
10
|
resource: 'hris.company.pay_statement_item.rules',
|
|
9
11
|
operation: 'write',
|
|
10
12
|
tags: [],
|
|
13
|
+
httpMethod: 'post',
|
|
14
|
+
httpPath: '/employer/pay-statement-item/rule',
|
|
15
|
+
operationId: 'create-rule',
|
|
11
16
|
};
|
|
12
17
|
|
|
13
18
|
export const tool: Tool = {
|
|
14
19
|
name: 'create_pay_statement_item_company_hris_rules',
|
|
15
20
|
description:
|
|
16
|
-
'**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',
|
|
21
|
+
"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```",
|
|
17
22
|
inputSchema: {
|
|
18
23
|
type: 'object',
|
|
19
24
|
properties: {
|
|
25
|
+
entity_ids: {
|
|
26
|
+
type: 'array',
|
|
27
|
+
description: 'The entity IDs to create the rule for.',
|
|
28
|
+
items: {
|
|
29
|
+
type: 'string',
|
|
30
|
+
},
|
|
31
|
+
},
|
|
20
32
|
attributes: {
|
|
21
33
|
type: 'object',
|
|
22
34
|
description: 'Specifies the fields to be applied when the condition is met.',
|
|
@@ -25,9 +37,9 @@ export const tool: Tool = {
|
|
|
25
37
|
type: 'object',
|
|
26
38
|
description:
|
|
27
39
|
'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.).',
|
|
40
|
+
additionalProperties: true,
|
|
28
41
|
},
|
|
29
42
|
},
|
|
30
|
-
required: [],
|
|
31
43
|
},
|
|
32
44
|
conditions: {
|
|
33
45
|
type: 'array',
|
|
@@ -48,7 +60,6 @@ export const tool: Tool = {
|
|
|
48
60
|
description: 'The value of the field to be checked in the rule.',
|
|
49
61
|
},
|
|
50
62
|
},
|
|
51
|
-
required: [],
|
|
52
63
|
},
|
|
53
64
|
},
|
|
54
65
|
effective_end_date: {
|
|
@@ -66,13 +77,30 @@ export const tool: Tool = {
|
|
|
66
77
|
description: 'The entity type to which the rule is applied.',
|
|
67
78
|
enum: ['pay_statement_item'],
|
|
68
79
|
},
|
|
80
|
+
jq_filter: {
|
|
81
|
+
type: 'string',
|
|
82
|
+
title: 'jq Filter',
|
|
83
|
+
description:
|
|
84
|
+
'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/).',
|
|
85
|
+
},
|
|
69
86
|
},
|
|
87
|
+
required: [],
|
|
70
88
|
},
|
|
89
|
+
annotations: {},
|
|
71
90
|
};
|
|
72
91
|
|
|
73
|
-
export const handler = (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
74
|
-
const body = args as any;
|
|
75
|
-
|
|
92
|
+
export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
|
|
93
|
+
const { jq_filter, ...body } = args as any;
|
|
94
|
+
try {
|
|
95
|
+
return asTextContentResult(
|
|
96
|
+
await maybeFilter(jq_filter, await client.hris.company.payStatementItem.rules.create(body)),
|
|
97
|
+
);
|
|
98
|
+
} catch (error) {
|
|
99
|
+
if (error instanceof Finch.APIError || isJqError(error)) {
|
|
100
|
+
return asErrorResult(error.message);
|
|
101
|
+
}
|
|
102
|
+
throw error;
|
|
103
|
+
}
|
|
76
104
|
};
|
|
77
105
|
|
|
78
106
|
export default { metadata, tool, handler };
|