Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "10.2.0"
".": "10.3.0"
}
4 changes: 2 additions & 2 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 48
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-a6b05e51c46366a54466c2009f5fdde74e0fa40bbcc6568601a4e3342dd16937.yml
openapi_spec_hash: 084797c220144df17d98eb984dd4cba2
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-166cc05754d8591beda094f4ee6f438f55d5f65d490ab364ea130c5100134375.yml
openapi_spec_hash: 4582a35bbe9fb5404d1e4f804c877fa8
config_hash: 9ae56f40cec7304896138bfad5caf748
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 10.3.0 (2026-07-15)

Full Changelog: [v10.2.0...v10.3.0](https://github.com/Finch-API/finch-api-node/compare/v10.2.0...v10.3.0)

### Features

* **api:** api update ([0752db2](https://github.com/Finch-API/finch-api-node/commit/0752db20bab9e544cf5a2bfe073bd15ab9bdedef))

## 10.2.0 (2026-07-13)

Full Changelog: [v10.1.1...v10.2.0](https://github.com/Finch-API/finch-api-node/compare/v10.1.1...v10.2.0)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@tryfinch/finch-api",
"version": "10.2.0",
"version": "10.3.0",
"description": "The official TypeScript library for the Finch API",
"author": "Finch <founders@tryfinch.com>",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/mcp-server/manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"dxt_version": "0.2",
"name": "@tryfinch/finch-api-mcp",
"version": "10.2.0",
"version": "10.3.0",
"description": "The official MCP Server for the Finch API",
"author": {
"name": "Finch",
Expand Down
2 changes: 1 addition & 1 deletion packages/mcp-server/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@tryfinch/finch-api-mcp",
"version": "10.2.0",
"version": "10.3.0",
"description": "The official MCP Server for the Finch API",
"author": "Finch <founders@tryfinch.com>",
"types": "dist/index.d.ts",
Expand Down
50 changes: 25 additions & 25 deletions packages/mcp-server/src/local-docs-search.ts

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/mcp-server/src/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export const newMcpServer = async ({
new McpServer(
{
name: 'tryfinch_finch_api_api',
version: '10.2.0',
version: '10.3.0',
},
{
instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }),
Expand Down
3 changes: 1 addition & 2 deletions src/resources/access-tokens.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ export interface CreateAccessTokenResponse {
account_id?: string;

/**
* @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
* of this company ID
* The Finch UUID of the company associated with the `access_token`.
*/
company_id?: string;

Expand Down
3 changes: 1 addition & 2 deletions src/resources/account.ts
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,7 @@ export interface Introspection {
authentication_methods?: Array<Introspection.AuthenticationMethod>;

/**
* @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
* connection instead of this company ID
* The Finch UUID of the company associated with the `access_token`.
*/
company_id?: string;

Expand Down
18 changes: 12 additions & 6 deletions src/resources/hris/benefits/benefits.ts
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,8 @@ export type BenfitContribution = BenefitContribution | null;

export interface BenefitCreateParams {
/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down Expand Up @@ -452,14 +453,16 @@ export namespace BenefitCreateParams {

export interface BenefitRetrieveParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}

export interface BenefitUpdateParams {
/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand All @@ -471,21 +474,24 @@ export interface BenefitUpdateParams {

export interface BenefitListParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}

export interface BenefitListSupportedBenefitsParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}

export interface BenefitRegisterParams {
/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down
12 changes: 8 additions & 4 deletions src/resources/hris/benefits/individuals.ts
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,8 @@ export interface IndividualEnrolledIDsResponse {

export interface IndividualEnrollManyParams {
/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down Expand Up @@ -362,14 +363,16 @@ export namespace IndividualEnrollManyParams {

export interface IndividualEnrolledIDsParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}

export interface IndividualRetrieveManyBenefitsParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand All @@ -382,7 +385,8 @@ export interface IndividualRetrieveManyBenefitsParams {

export interface IndividualUnenrollManyParams {
/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down
3 changes: 2 additions & 1 deletion src/resources/hris/company.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,8 @@ export namespace Company {

export interface CompanyRetrieveParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}
Expand Down
6 changes: 4 additions & 2 deletions src/resources/hris/directory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,16 @@ export namespace IndividualInDirectory {

export interface DirectoryListParams extends IndividualsPageParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}

export interface DirectoryListIndividualsParams extends IndividualsPageParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}
Expand Down
6 changes: 4 additions & 2 deletions src/resources/hris/documents.ts
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,8 @@ export type DocumentRetreiveResponse = W42020 | W42005;

export interface DocumentListParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down Expand Up @@ -245,7 +246,8 @@ export interface DocumentListParams {

export interface DocumentRetreiveParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}
Expand Down
3 changes: 2 additions & 1 deletion src/resources/hris/employments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,8 @@ export interface EmploymentRetrieveManyParams {
requests: Array<EmploymentRetrieveManyParams.Request>;

/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}
Expand Down
3 changes: 2 additions & 1 deletion src/resources/hris/individuals.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@ export interface IndividualRetrieveManyParams {
requests: Array<IndividualRetrieveManyParams.Request>;

/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ export interface PayStatementItemListParams {
end_date?: string;

/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down
12 changes: 8 additions & 4 deletions src/resources/hris/pay-statement-item/rules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,8 @@ export namespace RuleDeleteResponse {

export interface RuleCreateParams {
/**
* Query param: The entity IDs to create the rule for.
* Query param: The entity IDs to create the rule for. Provide exactly one entity
* ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down Expand Up @@ -472,7 +473,8 @@ export namespace RuleCreateParams {

export interface RuleUpdateParams {
/**
* Query param: The entity IDs to update the rule for.
* Query param: The entity IDs to update the rule for. Provide exactly one entity
* ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand All @@ -484,14 +486,16 @@ export interface RuleUpdateParams {

export interface RuleListParams {
/**
* The entity IDs to retrieve rules for.
* The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
* a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}

export interface RuleDeleteParams {
/**
* The entity IDs to delete the rule for.
* The entity IDs to delete the rule for. Provide exactly one entity ID per
* request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}
Expand Down
3 changes: 2 additions & 1 deletion src/resources/hris/pay-statements.ts
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,8 @@ export interface PayStatementRetrieveManyParams {
requests: Array<PayStatementRetrieveManyParams.Request>;

/**
* Query param: The entity IDs to specify which entities' data to access.
* Query param: The entity IDs to specify which entities' data to access. Provide
* exactly one entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}
Expand Down
3 changes: 2 additions & 1 deletion src/resources/hris/payments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ export interface PaymentListParams {
start_date: string;

/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}
Expand Down
6 changes: 4 additions & 2 deletions src/resources/payroll/pay-groups.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,16 @@ export interface PayGroupListResponse {

export interface PayGroupRetrieveParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;
}

export interface PayGroupListParams {
/**
* The entity IDs to specify which entities' data to access.
* The entity IDs to specify which entities' data to access. Provide exactly one
* entity ID per request; a maximum of one is accepted.
*/
entity_ids?: Array<string>;

Expand Down
6 changes: 2 additions & 4 deletions src/resources/sandbox/connections/accounts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ export interface AccountCreateResponse {
authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';

/**
* @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
* access token
* The Finch UUID of the company associated with the `access_token`.
*/
company_id: string;

Expand Down Expand Up @@ -95,8 +94,7 @@ export interface AccountUpdateResponse {
authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';

/**
* @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
* access token
* The Finch UUID of the company associated with the `access_token`.
*/
company_id: string;

Expand Down
3 changes: 1 addition & 2 deletions src/resources/sandbox/connections/connections.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ export interface ConnectionCreateResponse {
authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';

/**
* @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
* access token
* The Finch UUID of the company associated with the `access_token`.
*/
company_id: string;

Expand Down
4 changes: 1 addition & 3 deletions src/resources/webhooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -566,9 +566,7 @@ export interface BaseWebhookEvent {
account_id: string;

/**
* @deprecated [DEPRECATED] Unique Finch ID of the company for which data has been
* updated. Use `connection_id` instead to identify the connection associated with
* this event.
* Unique Finch ID of the company for which data has been updated.
*/
company_id: string;

Expand Down
2 changes: 1 addition & 1 deletion src/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const VERSION = '10.2.0'; // x-release-please-version
export const VERSION = '10.3.0'; // x-release-please-version
Loading