Skip to content

release: 2.3.0 #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stainless-app merged 2 commits into from
Jul 15, 2026
Merged

release: 2.3.0 #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ce8204
feat(api): api update
stainless-app[bot] Jul 15, 2026
984d946
release: 2.3.0
stainless-app[bot] Jul 15, 2026
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "2.2.0"
".": "2.3.0"
}
4 changes: 2 additions & 2 deletions .stats.yml
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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-python/compare/v2.2.0...v2.3.0)

### Features

* **api:** api update ([0ce8204](https://github.com/Finch-API/finch-api-python/commit/0ce82044eb0ab15456c6e0f5a920c43db35802e8))

## 2.2.0 (2026-07-13)

Full Changelog: [v2.1.0...v2.2.0](https://github.com/Finch-API/finch-api-python/compare/v2.1.0...v2.2.0)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "finch-api"
version = "2.2.0"
version = "2.3.0"
description = "The official Python library for the Finch API"
dynamic = ["readme"]
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion src/finch/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

__title__ = "finch"
__version__ = "2.2.0" # x-release-please-version
__version__ = "2.3.0" # x-release-please-version
36 changes: 24 additions & 12 deletions src/finch/resources/hris/benefits/benefits.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ def create(
`/providers` endpoint to view available types for each provider.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

company_contribution: The company match for this benefit.

Expand Down Expand Up @@ -146,7 +147,8 @@ def retrieve(
Lists deductions and contributions information for a given item

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -188,7 +190,8 @@ def update(
Updates an existing company-wide deduction or contribution

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

description: Updated name or description.

Expand Down Expand Up @@ -231,7 +234,8 @@ def list(
List all company-wide deductions and contributions.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -270,7 +274,8 @@ def list_supported_benefits(
Get deductions metadata

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -316,7 +321,8 @@ def register(
Please use the `/provider` endpoint to view available types for each provider.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

frequency: The frequency of the benefit deduction/contribution.

Expand Down Expand Up @@ -397,7 +403,8 @@ async def create(
`/providers` endpoint to view available types for each provider.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

company_contribution: The company match for this benefit.

Expand Down Expand Up @@ -457,7 +464,8 @@ async def retrieve(
Lists deductions and contributions information for a given item

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -501,7 +509,8 @@ async def update(
Updates an existing company-wide deduction or contribution

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

description: Updated name or description.

Expand Down Expand Up @@ -546,7 +555,8 @@ def list(
List all company-wide deductions and contributions.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -585,7 +595,8 @@ def list_supported_benefits(
Get deductions metadata

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -631,7 +642,8 @@ async def register(
Please use the `/provider` endpoint to view available types for each provider.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

frequency: The frequency of the benefit deduction/contribution.

Expand Down
24 changes: 16 additions & 8 deletions src/finch/resources/hris/benefits/individuals.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ def enroll_many(
enrollments, but will continue to set the state of the existing enrollment.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individuals: Array of the individual_id to enroll and a configuration object.

Expand Down Expand Up @@ -115,7 +116,8 @@ def enrolled_ids(
Lists individuals currently enrolled in a given deduction.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -159,7 +161,8 @@ def retrieve_many_benefits(
Get enrollment information for the given individuals.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
defaults to all individuals
Expand Down Expand Up @@ -211,7 +214,8 @@ def unenroll_many(
Unenroll individuals from a deduction or contribution

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individual_ids: Array of individual_ids to unenroll.

Expand Down Expand Up @@ -285,7 +289,8 @@ async def enroll_many(
enrollments, but will continue to set the state of the existing enrollment.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individuals: Array of the individual_id to enroll and a configuration object.

Expand Down Expand Up @@ -331,7 +336,8 @@ async def enrolled_ids(
Lists individuals currently enrolled in a given deduction.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -375,7 +381,8 @@ def retrieve_many_benefits(
Get enrollment information for the given individuals.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
defaults to all individuals
Expand Down Expand Up @@ -427,7 +434,8 @@ async def unenroll_many(
Unenroll individuals from a deduction or contribution

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individual_ids: Array of individual_ids to unenroll.

Expand Down
6 changes: 4 additions & 2 deletions src/finch/resources/hris/company.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ def retrieve(
Read basic company data

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -111,7 +112,8 @@ async def retrieve(
Read basic company data

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down
12 changes: 8 additions & 4 deletions src/finch/resources/hris/directory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ def list(
Read company directory and organization structure

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

limit: Number of employees to return (defaults to 100, maximum 10000)

Expand Down Expand Up @@ -110,7 +111,8 @@ def list_individuals(
Read company directory and organization structure

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

limit: Number of employees to return (defaults to 100, maximum 10000)

Expand Down Expand Up @@ -172,7 +174,8 @@ def list(
Read company directory and organization structure

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

limit: Number of employees to return (defaults to 100, maximum 10000)

Expand Down Expand Up @@ -225,7 +228,8 @@ def list_individuals(
Read company directory and organization structure

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

limit: Number of employees to return (defaults to 100, maximum 10000)

Expand Down
12 changes: 8 additions & 4 deletions src/finch/resources/hris/documents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ def list(
company-wide documents.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
defaults to all individuals
Expand Down Expand Up @@ -122,7 +123,8 @@ def retreive(
specific document by its ID.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -194,7 +196,8 @@ async def list(
company-wide documents.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
defaults to all individuals
Expand Down Expand Up @@ -254,7 +257,8 @@ async def retreive(
specific document by its ID.

Args:
entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down
6 changes: 4 additions & 2 deletions src/finch/resources/hris/employments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ def retrieve_many(
Args:
requests: The array of batch requests. Maximum 10000 items per request.

entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -125,7 +126,8 @@ def retrieve_many(
Args:
requests: The array of batch requests. Maximum 10000 items per request.

entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down
6 changes: 4 additions & 2 deletions src/finch/resources/hris/individuals.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ def retrieve_many(
Args:
requests: The array of batch requests. Maximum 10000 items per request.

entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down Expand Up @@ -133,7 +134,8 @@ def retrieve_many(
Args:
requests: The array of batch requests. Maximum 10000 items per request.

entity_ids: The entity IDs to specify which entities' data to access.
entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
entity ID per request; a maximum of one is accepted.

extra_headers: Send extra headers

Expand Down
Loading