From 045f63c9bc0ba9b3dab9fa12f024774a46486211 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 17:36:37 +0000 Subject: [PATCH 1/2] feat(api): api update --- .stats.yml | 4 ++-- accesstoken.go | 5 +---- account.go | 5 +---- hrisbenefit.go | 18 ++++++++++++------ hrisbenefitindividual.go | 12 ++++++++---- hriscompany.go | 3 ++- hrisdirectory.go | 6 ++++-- hrisdocument.go | 6 ++++-- hrisemployment.go | 3 ++- hrisindividual.go | 3 ++- hrispayment.go | 3 ++- hrispaystatement.go | 3 ++- hrispaystatementitem.go | 3 ++- hrispaystatementitemrule.go | 12 ++++++++---- payrollpaygroup.go | 6 ++++-- sandboxconnection.go | 4 +--- sandboxconnectionaccount.go | 8 ++------ webhook.go | 5 +---- 18 files changed, 60 insertions(+), 49 deletions(-) diff --git a/.stats.yml b/.stats.yml index 6d130ac..0fc8637 100644 --- a/.stats.yml +++ b/.stats.yml @@ -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 diff --git a/accesstoken.go b/accesstoken.go index d05919c..ed6cee5 100644 --- a/accesstoken.go +++ b/accesstoken.go @@ -102,10 +102,7 @@ type CreateAccessTokenResponse struct { // // Deprecated: deprecated AccountID string `json:"account_id"` - // [DEPRECATED] Use `connection_id` to identify the connection instead of this - // company ID - // - // Deprecated: deprecated + // The Finch UUID of the company associated with the `access_token`. CompanyID string `json:"company_id"` // The ID of your customer you provided to Finch when a connect session was created // for this connection diff --git a/account.go b/account.go index 6a01466..5189039 100644 --- a/account.go +++ b/account.go @@ -132,10 +132,7 @@ type Introspection struct { // Deprecated: deprecated AccountID string `json:"account_id"` AuthenticationMethods []IntrospectionAuthenticationMethod `json:"authentication_methods"` - // [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection - // instead of this company ID - // - // Deprecated: deprecated + // The Finch UUID of the company associated with the `access_token`. CompanyID string `json:"company_id"` // The email of your customer you provided to Finch when a connect session was // created for this connection diff --git a/hrisbenefit.go b/hrisbenefit.go index 098bab7..59c7a27 100644 --- a/hrisbenefit.go +++ b/hrisbenefit.go @@ -530,7 +530,8 @@ func (r updateCompanyBenefitResponseJSON) RawJSON() string { } type HRISBenefitNewParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // The company match for this benefit. CompanyContribution param.Field[HRISBenefitNewParamsCompanyContribution] `json:"company_contribution"` @@ -590,7 +591,8 @@ func (r HRISBenefitNewParamsCompanyContributionType) IsKnown() bool { } type HRISBenefitGetParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } @@ -603,7 +605,8 @@ func (r HRISBenefitGetParams) URLQuery() (v url.Values) { } type HRISBenefitUpdateParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Updated name or description. Description param.Field[string] `json:"description"` @@ -623,7 +626,8 @@ func (r HRISBenefitUpdateParams) URLQuery() (v url.Values) { } type HRISBenefitListParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } @@ -636,7 +640,8 @@ func (r HRISBenefitListParams) URLQuery() (v url.Values) { } type HRISBenefitListSupportedBenefitsParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } @@ -650,7 +655,8 @@ func (r HRISBenefitListSupportedBenefitsParams) URLQuery() (v url.Values) { } type HRISBenefitRegisterParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` Description param.Field[string] `json:"description"` // The frequency of the benefit deduction/contribution. diff --git a/hrisbenefitindividual.go b/hrisbenefitindividual.go index b73d09e..d2b0cef 100644 --- a/hrisbenefitindividual.go +++ b/hrisbenefitindividual.go @@ -835,7 +835,8 @@ func (r hrisBenefitIndividualEnrolledIDsResponseJSON) RawJSON() string { } type HRISBenefitIndividualEnrollManyParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Array of the individual_id to enroll and a configuration object. Individuals []HRISBenefitIndividualEnrollManyParamsIndividual `json:"individuals"` @@ -967,7 +968,8 @@ func (r HRISBenefitIndividualEnrollManyParamsIndividualsConfigurationEmployeeDed } type HRISBenefitIndividualEnrolledIDsParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } @@ -981,7 +983,8 @@ func (r HRISBenefitIndividualEnrolledIDsParams) URLQuery() (v url.Values) { } type HRISBenefitIndividualGetManyBenefitsParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // comma-delimited list of stable Finch uuids for each individual. If empty, // defaults to all individuals @@ -998,7 +1001,8 @@ func (r HRISBenefitIndividualGetManyBenefitsParams) URLQuery() (v url.Values) { } type HRISBenefitIndividualUnenrollManyParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Array of individual_ids to unenroll. IndividualIDs param.Field[[]string] `json:"individual_ids"` diff --git a/hriscompany.go b/hriscompany.go index 573820c..cb7fec7 100644 --- a/hriscompany.go +++ b/hriscompany.go @@ -250,7 +250,8 @@ func (r CompanyEntityType) IsKnown() bool { } type HRISCompanyGetParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } diff --git a/hrisdirectory.go b/hrisdirectory.go index 8d8f7ec..263358f 100644 --- a/hrisdirectory.go +++ b/hrisdirectory.go @@ -284,7 +284,8 @@ func (r individualInDirectoryManagerJSON) RawJSON() string { } type HRISDirectoryListParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Number of employees to return (defaults to 100, maximum 10000) Limit param.Field[int64] `query:"limit"` @@ -302,7 +303,8 @@ func (r HRISDirectoryListParams) URLQuery() (v url.Values) { } type HRISDirectoryListIndividualsParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Number of employees to return (defaults to 100, maximum 10000) Limit param.Field[int64] `query:"limit"` diff --git a/hrisdocument.go b/hrisdocument.go index 04fec7a..51cd98b 100644 --- a/hrisdocument.go +++ b/hrisdocument.go @@ -444,7 +444,8 @@ func (r HRISDocumentRetreiveResponseType) IsKnown() bool { } type HRISDocumentListParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Comma-delimited list of stable Finch uuids for each individual. If empty, // defaults to all individuals @@ -482,7 +483,8 @@ func (r HRISDocumentListParamsType) IsKnown() bool { } type HRISDocumentRetreiveParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } diff --git a/hrisemployment.go b/hrisemployment.go index 32ec473..f111f2e 100644 --- a/hrisemployment.go +++ b/hrisemployment.go @@ -587,7 +587,8 @@ func (r employmentDataResponseJSON) RawJSON() string { type HRISEmploymentGetManyParams struct { // The array of batch requests. Maximum 10000 items per request. Requests param.Field[[]HRISEmploymentGetManyParamsRequest] `json:"requests" api:"required"` - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } diff --git a/hrisindividual.go b/hrisindividual.go index 7eb6ca8..cb8aef1 100644 --- a/hrisindividual.go +++ b/hrisindividual.go @@ -440,7 +440,8 @@ func (r individualResponseJSON) RawJSON() string { type HRISIndividualGetManyParams struct { // The array of batch requests. Maximum 10000 items per request. Requests param.Field[[]HRISIndividualGetManyParamsRequest] `json:"requests" api:"required"` - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` Options param.Field[HRISIndividualGetManyParamsOptions] `json:"options"` } diff --git a/hrispayment.go b/hrispayment.go index 01f7fce..ab11b11 100644 --- a/hrispayment.go +++ b/hrispayment.go @@ -160,7 +160,8 @@ type HRISPaymentListParams struct { // The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` // format. Filters payments by their **pay_date** field. StartDate param.Field[time.Time] `query:"start_date" api:"required" format:"date"` - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } diff --git a/hrispaystatement.go b/hrispaystatement.go index 317e78f..b531f23 100644 --- a/hrispaystatement.go +++ b/hrispaystatement.go @@ -693,7 +693,8 @@ func (r PayStatementResponseBodyBatchError) implementsPayStatementResponseBody() type HRISPayStatementGetManyParams struct { // The array of batch requests. Maximum 10 payment_ids per request. Requests param.Field[[]HRISPayStatementGetManyParamsRequest] `json:"requests" api:"required"` - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } diff --git a/hrispaystatementitem.go b/hrispaystatementitem.go index b6a9c8a..9862ada 100644 --- a/hrispaystatementitem.go +++ b/hrispaystatementitem.go @@ -152,7 +152,8 @@ type HRISPayStatementItemListParams struct { // The end date to retrieve pay statement items by via their last seen pay date in // `YYYY-MM-DD` format. EndDate param.Field[time.Time] `query:"end_date" format:"date"` - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Case-insensitive partial match search by pay statement item name. Name param.Field[string] `query:"name"` diff --git a/hrispaystatementitemrule.go b/hrispaystatementitemrule.go index faabbb6..9ebe780 100644 --- a/hrispaystatementitemrule.go +++ b/hrispaystatementitemrule.go @@ -612,7 +612,8 @@ func (r HRISPayStatementItemRuleDeleteResponseEntityType) IsKnown() bool { } type HRISPayStatementItemRuleNewParams struct { - // The entity IDs to create the rule for. + // The entity IDs to create the rule for. Provide exactly one entity ID per + // request; a maximum of one is accepted. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` // Specifies the fields to be applied when the condition is met. Attributes param.Field[HRISPayStatementItemRuleNewParamsAttributes] `json:"attributes"` @@ -693,7 +694,8 @@ func (r HRISPayStatementItemRuleNewParamsEntityType) IsKnown() bool { } type HRISPayStatementItemRuleUpdateParams struct { - // The entity IDs to update the rule for. + // The entity IDs to update the rule for. Provide exactly one entity ID per + // request; a maximum of one is accepted. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` OptionalProperty param.Field[interface{}] `json:"optionalProperty"` } @@ -712,7 +714,8 @@ func (r HRISPayStatementItemRuleUpdateParams) URLQuery() (v url.Values) { } type HRISPayStatementItemRuleListParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } @@ -726,7 +729,8 @@ func (r HRISPayStatementItemRuleListParams) URLQuery() (v url.Values) { } type HRISPayStatementItemRuleDeleteParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } diff --git a/payrollpaygroup.go b/payrollpaygroup.go index 47acc45..3f830fe 100644 --- a/payrollpaygroup.go +++ b/payrollpaygroup.go @@ -177,7 +177,8 @@ func (r PayrollPayGroupListResponsePayFrequency) IsKnown() bool { } type PayrollPayGroupGetParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` } @@ -191,7 +192,8 @@ func (r PayrollPayGroupGetParams) URLQuery() (v url.Values) { } type PayrollPayGroupListParams struct { - // 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. EntityIDs param.Field[[]string] `query:"entity_ids" format:"uuid"` IndividualID param.Field[string] `query:"individual_id" format:"uuid"` PayFrequencies param.Field[[]string] `query:"pay_frequencies"` diff --git a/sandboxconnection.go b/sandboxconnection.go index 621f953..fa5bebe 100644 --- a/sandboxconnection.go +++ b/sandboxconnection.go @@ -50,9 +50,7 @@ type SandboxConnectionNewResponse struct { // Deprecated: deprecated AccountID string `json:"account_id" api:"required" format:"uuid"` AuthenticationType SandboxConnectionNewResponseAuthenticationType `json:"authentication_type" api:"required"` - // [DEPRECATED] Use `connection_id` to associate a connection with an access token - // - // Deprecated: deprecated + // The Finch UUID of the company associated with the `access_token`. CompanyID string `json:"company_id" api:"required" format:"uuid"` // The ID of the new connection ConnectionID string `json:"connection_id" api:"required" format:"uuid"` diff --git a/sandboxconnectionaccount.go b/sandboxconnectionaccount.go index e0ced7d..d3f3117 100644 --- a/sandboxconnectionaccount.go +++ b/sandboxconnectionaccount.go @@ -59,9 +59,7 @@ type SandboxConnectionAccountNewResponse struct { // Deprecated: deprecated AccountID string `json:"account_id" api:"required" format:"uuid"` AuthenticationType SandboxConnectionAccountNewResponseAuthenticationType `json:"authentication_type" api:"required"` - // [DEPRECATED] Use `connection_id` to associate a connection with an access token - // - // Deprecated: deprecated + // The Finch UUID of the company associated with the `access_token`. CompanyID string `json:"company_id" api:"required" format:"uuid"` // The ID of the new connection ConnectionID string `json:"connection_id" api:"required" format:"uuid"` @@ -119,9 +117,7 @@ type SandboxConnectionAccountUpdateResponse struct { // Deprecated: deprecated AccountID string `json:"account_id" api:"required" format:"uuid"` AuthenticationType SandboxConnectionAccountUpdateResponseAuthenticationType `json:"authentication_type" api:"required"` - // [DEPRECATED] Use `connection_id` to associate a connection with an access token - // - // Deprecated: deprecated + // The Finch UUID of the company associated with the `access_token`. CompanyID string `json:"company_id" api:"required" format:"uuid"` // The ID of the new connection ConnectionID string `json:"connection_id" api:"required" format:"uuid"` diff --git a/webhook.go b/webhook.go index d788f20..5587fc7 100644 --- a/webhook.go +++ b/webhook.go @@ -1147,10 +1147,7 @@ type BaseWebhookEvent struct { // // Deprecated: deprecated AccountID string `json:"account_id" api:"required"` - // [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. - // - // Deprecated: deprecated + // Unique Finch ID of the company for which data has been updated. CompanyID string `json:"company_id" api:"required"` // Unique Finch ID of the connection associated with the webhook event. ConnectionID string `json:"connection_id"` From 326ef9770f6435e5a75540e4101060db416eb31a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 17:37:00 +0000 Subject: [PATCH 2/2] release: 2.3.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ README.md | 2 +- internal/version.go | 2 +- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index bfc26f9..75ec52f 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "2.2.0" + ".": "2.3.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 009da38..0eeb2c3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 2.3.0 (2026-07-15) + +Full Changelog: [v2.2.0...v2.3.0](https://github.com/Finch-API/finch-api-go/compare/v2.2.0...v2.3.0) + +### Features + +* **api:** api update ([045f63c](https://github.com/Finch-API/finch-api-go/commit/045f63c9bc0ba9b3dab9fa12f024774a46486211)) + ## 2.2.0 (2026-07-13) Full Changelog: [v2.1.0...v2.2.0](https://github.com/Finch-API/finch-api-go/compare/v2.1.0...v2.2.0) diff --git a/README.md b/README.md index de39cb6..a8f6bed 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Or to pin the version: ```sh -go get -u 'github.com/Finch-API/finch-api-go@v2.2.0' +go get -u 'github.com/Finch-API/finch-api-go@v2.3.0' ``` diff --git a/internal/version.go b/internal/version.go index 0759deb..ebb76be 100644 --- a/internal/version.go +++ b/internal/version.go @@ -2,4 +2,4 @@ package internal -const PackageVersion = "2.2.0" // x-release-please-version +const PackageVersion = "2.3.0" // x-release-please-version