diff --git a/.release-please-manifest.json b/.release-please-manifest.json index bfc26f9c..75ec52fc 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/.stats.yml b/.stats.yml index 6d130acd..0fc8637f 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/CHANGELOG.md b/CHANGELOG.md index 425a643a..c1acc20f 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-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) diff --git a/pyproject.toml b/pyproject.toml index 6619f4b2..0f14b5e6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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" diff --git a/src/finch/_version.py b/src/finch/_version.py index fb1e83f5..101bf9c6 100644 --- a/src/finch/_version.py +++ b/src/finch/_version.py @@ -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 diff --git a/src/finch/resources/hris/benefits/benefits.py b/src/finch/resources/hris/benefits/benefits.py index 05b61df3..061a754f 100644 --- a/src/finch/resources/hris/benefits/benefits.py +++ b/src/finch/resources/hris/benefits/benefits.py @@ -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. @@ -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 @@ -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. @@ -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 @@ -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 @@ -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. @@ -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. @@ -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 @@ -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. @@ -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 @@ -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 @@ -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. diff --git a/src/finch/resources/hris/benefits/individuals.py b/src/finch/resources/hris/benefits/individuals.py index f432915c..d46a7e19 100644 --- a/src/finch/resources/hris/benefits/individuals.py +++ b/src/finch/resources/hris/benefits/individuals.py @@ -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. @@ -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 @@ -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 @@ -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. @@ -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. @@ -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 @@ -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 @@ -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. diff --git a/src/finch/resources/hris/company.py b/src/finch/resources/hris/company.py index 180ef359..1c23453c 100644 --- a/src/finch/resources/hris/company.py +++ b/src/finch/resources/hris/company.py @@ -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 @@ -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 diff --git a/src/finch/resources/hris/directory.py b/src/finch/resources/hris/directory.py index 468cec4b..1be8d2ad 100644 --- a/src/finch/resources/hris/directory.py +++ b/src/finch/resources/hris/directory.py @@ -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) @@ -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) @@ -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) @@ -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) diff --git a/src/finch/resources/hris/documents.py b/src/finch/resources/hris/documents.py index 4ff2cd59..5d9ab116 100644 --- a/src/finch/resources/hris/documents.py +++ b/src/finch/resources/hris/documents.py @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/src/finch/resources/hris/employments.py b/src/finch/resources/hris/employments.py index da61b5a2..e6808707 100644 --- a/src/finch/resources/hris/employments.py +++ b/src/finch/resources/hris/employments.py @@ -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 @@ -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 diff --git a/src/finch/resources/hris/individuals.py b/src/finch/resources/hris/individuals.py index cebd400c..5515c2a2 100644 --- a/src/finch/resources/hris/individuals.py +++ b/src/finch/resources/hris/individuals.py @@ -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 @@ -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 diff --git a/src/finch/resources/hris/pay_statement_item/pay_statement_item.py b/src/finch/resources/hris/pay_statement_item/pay_statement_item.py index 0c95b967..a63cbbb0 100644 --- a/src/finch/resources/hris/pay_statement_item/pay_statement_item.py +++ b/src/finch/resources/hris/pay_statement_item/pay_statement_item.py @@ -81,7 +81,8 @@ def list( end_date: The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format. - 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. name: Case-insensitive partial match search by pay statement item name. @@ -174,7 +175,8 @@ def list( end_date: The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format. - 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. name: Case-insensitive partial match search by pay statement item name. diff --git a/src/finch/resources/hris/pay_statement_item/rules.py b/src/finch/resources/hris/pay_statement_item/rules.py index fe7275e9..8d872880 100644 --- a/src/finch/resources/hris/pay_statement_item/rules.py +++ b/src/finch/resources/hris/pay_statement_item/rules.py @@ -72,7 +72,8 @@ def create( retrieved where pay statement item information is available. Args: - entity_ids: The entity IDs to create the rule for. + entity_ids: The entity IDs to create the rule for. Provide exactly one entity ID per + request; a maximum of one is accepted. attributes: Specifies the fields to be applied when the condition is met. @@ -130,7 +131,8 @@ def update( Update a rule for a pay statement item. Args: - entity_ids: The entity IDs to update the rule for. + entity_ids: The entity IDs to update the rule for. Provide exactly one entity ID per + request; a maximum of one is accepted. extra_headers: Send extra headers @@ -171,7 +173,8 @@ def list( List all rules of a connection account. Args: - entity_ids: The entity IDs to retrieve rules for. + entity_ids: The entity IDs to retrieve rules for. Provide exactly one entity ID per request; + a maximum of one is accepted. extra_headers: Send extra headers @@ -211,7 +214,8 @@ def delete( Delete a rule for a pay statement item. Args: - entity_ids: The entity IDs to delete the rule for. + entity_ids: The entity IDs to delete the rule for. Provide exactly one entity ID per + request; a maximum of one is accepted. extra_headers: Send extra headers @@ -280,7 +284,8 @@ async def create( retrieved where pay statement item information is available. Args: - entity_ids: The entity IDs to create the rule for. + entity_ids: The entity IDs to create the rule for. Provide exactly one entity ID per + request; a maximum of one is accepted. attributes: Specifies the fields to be applied when the condition is met. @@ -338,7 +343,8 @@ async def update( Update a rule for a pay statement item. Args: - entity_ids: The entity IDs to update the rule for. + entity_ids: The entity IDs to update the rule for. Provide exactly one entity ID per + request; a maximum of one is accepted. extra_headers: Send extra headers @@ -381,7 +387,8 @@ def list( List all rules of a connection account. Args: - entity_ids: The entity IDs to retrieve rules for. + entity_ids: The entity IDs to retrieve rules for. Provide exactly one entity ID per request; + a maximum of one is accepted. extra_headers: Send extra headers @@ -421,7 +428,8 @@ async def delete( Delete a rule for a pay statement item. Args: - entity_ids: The entity IDs to delete the rule for. + entity_ids: The entity IDs to delete the rule for. Provide exactly one entity ID per + request; a maximum of one is accepted. extra_headers: Send extra headers diff --git a/src/finch/resources/hris/pay_statements.py b/src/finch/resources/hris/pay_statements.py index da89e4d0..496c6843 100644 --- a/src/finch/resources/hris/pay_statements.py +++ b/src/finch/resources/hris/pay_statements.py @@ -61,7 +61,8 @@ def retrieve_many( Args: requests: The array of batch requests. Maximum 10 payment_ids 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 @@ -133,7 +134,8 @@ def retrieve_many( Args: requests: The array of batch requests. Maximum 10 payment_ids 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 diff --git a/src/finch/resources/hris/payments.py b/src/finch/resources/hris/payments.py index 99a5e5a9..f4eb18ca 100644 --- a/src/finch/resources/hris/payments.py +++ b/src/finch/resources/hris/payments.py @@ -64,7 +64,8 @@ def list( start_date: The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field. - 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 @@ -139,7 +140,8 @@ def list( start_date: The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field. - 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 diff --git a/src/finch/resources/payroll/pay_groups.py b/src/finch/resources/payroll/pay_groups.py index b50c5245..47974f72 100644 --- a/src/finch/resources/payroll/pay_groups.py +++ b/src/finch/resources/payroll/pay_groups.py @@ -55,7 +55,8 @@ def retrieve( Read information from a single pay group 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 @@ -97,7 +98,8 @@ def list( Read company pay groups and frequencies 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 @@ -165,7 +167,8 @@ async def retrieve( Read information from a single pay group 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 @@ -209,7 +212,8 @@ def list( Read company pay groups and frequencies 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 diff --git a/src/finch/types/base_webhook_event.py b/src/finch/types/base_webhook_event.py index 50c7cd84..c5b43de1 100644 --- a/src/finch/types/base_webhook_event.py +++ b/src/finch/types/base_webhook_event.py @@ -16,11 +16,7 @@ class BaseWebhookEvent(BaseModel): """ company_id: str - """[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.""" connection_id: Optional[str] = None """Unique Finch ID of the connection associated with the webhook event.""" diff --git a/src/finch/types/create_access_token_response.py b/src/finch/types/create_access_token_response.py index 0edd76d4..7b07f5c6 100644 --- a/src/finch/types/create_access_token_response.py +++ b/src/finch/types/create_access_token_response.py @@ -44,10 +44,7 @@ class CreateAccessTokenResponse(BaseModel): """ company_id: Optional[str] = None - """ - [DEPRECATED] Use `connection_id` to identify the connection instead of this - company ID - """ + """The Finch UUID of the company associated with the `access_token`.""" customer_id: Optional[str] = None """ diff --git a/src/finch/types/hris/benefit_create_params.py b/src/finch/types/hris/benefit_create_params.py index 18b907bb..eae83a59 100644 --- a/src/finch/types/hris/benefit_create_params.py +++ b/src/finch/types/hris/benefit_create_params.py @@ -14,7 +14,10 @@ class BenefitCreateParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ company_contribution: Optional[CompanyContribution] """The company match for this benefit.""" diff --git a/src/finch/types/hris/benefit_list_params.py b/src/finch/types/hris/benefit_list_params.py index 4dcc7014..b9219372 100644 --- a/src/finch/types/hris/benefit_list_params.py +++ b/src/finch/types/hris/benefit_list_params.py @@ -11,4 +11,7 @@ class BenefitListParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/benefit_list_supported_benefits_params.py b/src/finch/types/hris/benefit_list_supported_benefits_params.py index 81ef1435..0ed71e94 100644 --- a/src/finch/types/hris/benefit_list_supported_benefits_params.py +++ b/src/finch/types/hris/benefit_list_supported_benefits_params.py @@ -11,4 +11,7 @@ class BenefitListSupportedBenefitsParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/benefit_register_params.py b/src/finch/types/hris/benefit_register_params.py index 14a33387..03a0ad4c 100644 --- a/src/finch/types/hris/benefit_register_params.py +++ b/src/finch/types/hris/benefit_register_params.py @@ -14,7 +14,10 @@ class BenefitRegisterParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ description: str diff --git a/src/finch/types/hris/benefit_retrieve_params.py b/src/finch/types/hris/benefit_retrieve_params.py index 2a7c870a..6cd1dc8d 100644 --- a/src/finch/types/hris/benefit_retrieve_params.py +++ b/src/finch/types/hris/benefit_retrieve_params.py @@ -11,4 +11,7 @@ class BenefitRetrieveParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/benefit_update_params.py b/src/finch/types/hris/benefit_update_params.py index 1fe5a338..22b5d60e 100644 --- a/src/finch/types/hris/benefit_update_params.py +++ b/src/finch/types/hris/benefit_update_params.py @@ -11,7 +11,10 @@ class BenefitUpdateParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ description: str """Updated name or description.""" diff --git a/src/finch/types/hris/benefits/individual_enroll_many_params.py b/src/finch/types/hris/benefits/individual_enroll_many_params.py index 1988387c..b4d39005 100644 --- a/src/finch/types/hris/benefits/individual_enroll_many_params.py +++ b/src/finch/types/hris/benefits/individual_enroll_many_params.py @@ -21,7 +21,10 @@ class IndividualEnrollManyParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ individuals: Iterable[Individual] """Array of the individual_id to enroll and a configuration object.""" diff --git a/src/finch/types/hris/benefits/individual_enrolled_ids_params.py b/src/finch/types/hris/benefits/individual_enrolled_ids_params.py index 405cd23c..d3bd76a8 100644 --- a/src/finch/types/hris/benefits/individual_enrolled_ids_params.py +++ b/src/finch/types/hris/benefits/individual_enrolled_ids_params.py @@ -11,4 +11,7 @@ class IndividualEnrolledIDsParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/benefits/individual_retrieve_many_benefits_params.py b/src/finch/types/hris/benefits/individual_retrieve_many_benefits_params.py index f56bc521..7e1aa376 100644 --- a/src/finch/types/hris/benefits/individual_retrieve_many_benefits_params.py +++ b/src/finch/types/hris/benefits/individual_retrieve_many_benefits_params.py @@ -11,7 +11,10 @@ class IndividualRetrieveManyBenefitsParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ individual_ids: str """comma-delimited list of stable Finch uuids for each individual. diff --git a/src/finch/types/hris/benefits/individual_unenroll_many_params.py b/src/finch/types/hris/benefits/individual_unenroll_many_params.py index d68a5a39..2f395aad 100644 --- a/src/finch/types/hris/benefits/individual_unenroll_many_params.py +++ b/src/finch/types/hris/benefits/individual_unenroll_many_params.py @@ -11,7 +11,10 @@ class IndividualUnenrollManyParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ individual_ids: SequenceNotStr[str] """Array of individual_ids to unenroll.""" diff --git a/src/finch/types/hris/company_retrieve_params.py b/src/finch/types/hris/company_retrieve_params.py index c7d819a2..c8b47e48 100644 --- a/src/finch/types/hris/company_retrieve_params.py +++ b/src/finch/types/hris/company_retrieve_params.py @@ -11,4 +11,7 @@ class CompanyRetrieveParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/directory_list_individuals_params.py b/src/finch/types/hris/directory_list_individuals_params.py index 1c4e5a2a..813f9ed9 100644 --- a/src/finch/types/hris/directory_list_individuals_params.py +++ b/src/finch/types/hris/directory_list_individuals_params.py @@ -11,7 +11,10 @@ class DirectoryListIndividualsParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ limit: int """Number of employees to return (defaults to 100, maximum 10000)""" diff --git a/src/finch/types/hris/directory_list_params.py b/src/finch/types/hris/directory_list_params.py index 30e1a8d5..7e9bf9c7 100644 --- a/src/finch/types/hris/directory_list_params.py +++ b/src/finch/types/hris/directory_list_params.py @@ -11,7 +11,10 @@ class DirectoryListParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ limit: int """Number of employees to return (defaults to 100, maximum 10000)""" diff --git a/src/finch/types/hris/document_list_params.py b/src/finch/types/hris/document_list_params.py index ad599d1a..f00bd484 100644 --- a/src/finch/types/hris/document_list_params.py +++ b/src/finch/types/hris/document_list_params.py @@ -12,7 +12,10 @@ class DocumentListParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ individual_ids: SequenceNotStr[str] """Comma-delimited list of stable Finch uuids for each individual. diff --git a/src/finch/types/hris/document_retreive_params.py b/src/finch/types/hris/document_retreive_params.py index 714fdf13..f90fff77 100644 --- a/src/finch/types/hris/document_retreive_params.py +++ b/src/finch/types/hris/document_retreive_params.py @@ -11,4 +11,7 @@ class DocumentRetreiveParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/employment_retrieve_many_params.py b/src/finch/types/hris/employment_retrieve_many_params.py index e4468316..f5a73237 100644 --- a/src/finch/types/hris/employment_retrieve_many_params.py +++ b/src/finch/types/hris/employment_retrieve_many_params.py @@ -15,7 +15,10 @@ class EmploymentRetrieveManyParams(TypedDict, total=False): """The array of batch requests. Maximum 10000 items per request.""" entity_ids: SequenceNotStr[str] - """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. + """ class Request(TypedDict, total=False): diff --git a/src/finch/types/hris/individual_retrieve_many_params.py b/src/finch/types/hris/individual_retrieve_many_params.py index 70a2cf9b..36c6fd46 100644 --- a/src/finch/types/hris/individual_retrieve_many_params.py +++ b/src/finch/types/hris/individual_retrieve_many_params.py @@ -15,7 +15,10 @@ class IndividualRetrieveManyParams(TypedDict, total=False): """The array of batch requests. Maximum 10000 items per request.""" entity_ids: SequenceNotStr[str] - """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. + """ options: Optional[Options] diff --git a/src/finch/types/hris/pay_statement_item/rule_create_params.py b/src/finch/types/hris/pay_statement_item/rule_create_params.py index 596c8a64..b074b687 100644 --- a/src/finch/types/hris/pay_statement_item/rule_create_params.py +++ b/src/finch/types/hris/pay_statement_item/rule_create_params.py @@ -12,7 +12,10 @@ class RuleCreateParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ attributes: Attributes """Specifies the fields to be applied when the condition is met.""" diff --git a/src/finch/types/hris/pay_statement_item/rule_delete_params.py b/src/finch/types/hris/pay_statement_item/rule_delete_params.py index d704df6b..dd32508f 100644 --- a/src/finch/types/hris/pay_statement_item/rule_delete_params.py +++ b/src/finch/types/hris/pay_statement_item/rule_delete_params.py @@ -11,4 +11,7 @@ class RuleDeleteParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/pay_statement_item/rule_list_params.py b/src/finch/types/hris/pay_statement_item/rule_list_params.py index e054cbf1..22d50747 100644 --- a/src/finch/types/hris/pay_statement_item/rule_list_params.py +++ b/src/finch/types/hris/pay_statement_item/rule_list_params.py @@ -11,4 +11,7 @@ class RuleListParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/hris/pay_statement_item/rule_update_params.py b/src/finch/types/hris/pay_statement_item/rule_update_params.py index 689cd81d..25201eaa 100644 --- a/src/finch/types/hris/pay_statement_item/rule_update_params.py +++ b/src/finch/types/hris/pay_statement_item/rule_update_params.py @@ -12,6 +12,9 @@ class RuleUpdateParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ optional_property: Annotated[object, PropertyInfo(alias="optionalProperty")] diff --git a/src/finch/types/hris/pay_statement_item_list_params.py b/src/finch/types/hris/pay_statement_item_list_params.py index 082ad652..6e8df69b 100644 --- a/src/finch/types/hris/pay_statement_item_list_params.py +++ b/src/finch/types/hris/pay_statement_item_list_params.py @@ -26,7 +26,10 @@ class PayStatementItemListParams(TypedDict, total=False): """ entity_ids: SequenceNotStr[str] - """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. + """ name: str """Case-insensitive partial match search by pay statement item name.""" diff --git a/src/finch/types/hris/pay_statement_retrieve_many_params.py b/src/finch/types/hris/pay_statement_retrieve_many_params.py index c30094aa..ccbab470 100644 --- a/src/finch/types/hris/pay_statement_retrieve_many_params.py +++ b/src/finch/types/hris/pay_statement_retrieve_many_params.py @@ -15,7 +15,10 @@ class PayStatementRetrieveManyParams(TypedDict, total=False): """The array of batch requests. Maximum 10 payment_ids per request.""" entity_ids: SequenceNotStr[str] - """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. + """ class Request(TypedDict, total=False): diff --git a/src/finch/types/hris/payment_list_params.py b/src/finch/types/hris/payment_list_params.py index dcf7285c..241c9da4 100644 --- a/src/finch/types/hris/payment_list_params.py +++ b/src/finch/types/hris/payment_list_params.py @@ -26,4 +26,7 @@ class PaymentListParams(TypedDict, total=False): """ entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/introspection.py b/src/finch/types/introspection.py index 32783c15..2dd28b3d 100644 --- a/src/finch/types/introspection.py +++ b/src/finch/types/introspection.py @@ -97,10 +97,7 @@ class Introspection(BaseModel): authentication_methods: Optional[List[AuthenticationMethod]] = None company_id: Optional[str] = None - """ - [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`.""" customer_email: Optional[str] = None """ diff --git a/src/finch/types/payroll/pay_group_list_params.py b/src/finch/types/payroll/pay_group_list_params.py index df574bee..6a8cccd5 100644 --- a/src/finch/types/payroll/pay_group_list_params.py +++ b/src/finch/types/payroll/pay_group_list_params.py @@ -11,7 +11,10 @@ class PayGroupListParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ individual_id: str diff --git a/src/finch/types/payroll/pay_group_retrieve_params.py b/src/finch/types/payroll/pay_group_retrieve_params.py index 79143a38..b6b71815 100644 --- a/src/finch/types/payroll/pay_group_retrieve_params.py +++ b/src/finch/types/payroll/pay_group_retrieve_params.py @@ -11,4 +11,7 @@ class PayGroupRetrieveParams(TypedDict, total=False): entity_ids: SequenceNotStr[str] - """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. + """ diff --git a/src/finch/types/sandbox/connection_create_response.py b/src/finch/types/sandbox/connection_create_response.py index 5ebe5934..9067d15c 100644 --- a/src/finch/types/sandbox/connection_create_response.py +++ b/src/finch/types/sandbox/connection_create_response.py @@ -17,7 +17,7 @@ class ConnectionCreateResponse(BaseModel): authentication_type: Literal["credential", "api_token", "oauth", "assisted"] company_id: str - """[DEPRECATED] Use `connection_id` to associate a connection with an access token""" + """The Finch UUID of the company associated with the `access_token`.""" connection_id: str """The ID of the new connection""" diff --git a/src/finch/types/sandbox/connections/account_create_response.py b/src/finch/types/sandbox/connections/account_create_response.py index 99b1f95e..4907de92 100644 --- a/src/finch/types/sandbox/connections/account_create_response.py +++ b/src/finch/types/sandbox/connections/account_create_response.py @@ -17,7 +17,7 @@ class AccountCreateResponse(BaseModel): authentication_type: Literal["credential", "api_token", "oauth", "assisted"] company_id: str - """[DEPRECATED] Use `connection_id` to associate a connection with an access token""" + """The Finch UUID of the company associated with the `access_token`.""" connection_id: str """The ID of the new connection""" diff --git a/src/finch/types/sandbox/connections/account_update_response.py b/src/finch/types/sandbox/connections/account_update_response.py index 956d8094..a62e370a 100644 --- a/src/finch/types/sandbox/connections/account_update_response.py +++ b/src/finch/types/sandbox/connections/account_update_response.py @@ -15,7 +15,7 @@ class AccountUpdateResponse(BaseModel): authentication_type: Literal["credential", "api_token", "oauth", "assisted"] company_id: str - """[DEPRECATED] Use `connection_id` to associate a connection with an access token""" + """The Finch UUID of the company associated with the `access_token`.""" connection_id: str """The ID of the new connection"""