diff --git a/src/finch/resources/ats/applications.py b/src/finch/resources/ats/applications.py index 615e0bc2..617c2e70 100644 --- a/src/finch/resources/ats/applications.py +++ b/src/finch/resources/ats/applications.py @@ -24,7 +24,18 @@ def retrieve( extra_body: Body | None = None, timeout: float | None | NotGiven = NOT_GIVEN, ) -> Application: - """Gets an application from an organization.""" + """ + Gets an application from an organization. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ return self._get( f"/ats/applications/{application_id}", options=make_request_options( @@ -93,7 +104,18 @@ async def retrieve( extra_body: Body | None = None, timeout: float | None | NotGiven = NOT_GIVEN, ) -> Application: - """Gets an application from an organization.""" + """ + Gets an application from an organization. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ return await self._get( f"/ats/applications/{application_id}", options=make_request_options( diff --git a/src/finch/resources/ats/candidates.py b/src/finch/resources/ats/candidates.py index 045b23b9..1bb04a89 100644 --- a/src/finch/resources/ats/candidates.py +++ b/src/finch/resources/ats/candidates.py @@ -28,6 +28,15 @@ def retrieve( A candidate represents an individual associated with one or more applications. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds """ return self._get( f"/ats/candidates/{candidate_id}", @@ -103,6 +112,15 @@ async def retrieve( A candidate represents an individual associated with one or more applications. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds """ return await self._get( f"/ats/candidates/{candidate_id}", diff --git a/src/finch/resources/ats/jobs.py b/src/finch/resources/ats/jobs.py index 38e323fa..d2c43f21 100644 --- a/src/finch/resources/ats/jobs.py +++ b/src/finch/resources/ats/jobs.py @@ -24,7 +24,18 @@ def retrieve( extra_body: Body | None = None, timeout: float | None | NotGiven = NOT_GIVEN, ) -> Job: - """Gets a job from an organization.""" + """ + Gets a job from an organization. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ return self._get( f"/ats/jobs/{job_id}", options=make_request_options( @@ -93,7 +104,18 @@ async def retrieve( extra_body: Body | None = None, timeout: float | None | NotGiven = NOT_GIVEN, ) -> Job: - """Gets a job from an organization.""" + """ + Gets a job from an organization. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ return await self._get( f"/ats/jobs/{job_id}", options=make_request_options( diff --git a/src/finch/resources/ats/offers.py b/src/finch/resources/ats/offers.py index 771e234b..55a8a8ab 100644 --- a/src/finch/resources/ats/offers.py +++ b/src/finch/resources/ats/offers.py @@ -24,7 +24,18 @@ def retrieve( extra_body: Body | None = None, timeout: float | None | NotGiven = NOT_GIVEN, ) -> Offer: - """Get a single offer from an organization.""" + """ + Get a single offer from an organization. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ return self._get( f"/ats/offers/{offer_id}", options=make_request_options( @@ -93,7 +104,18 @@ async def retrieve( extra_body: Body | None = None, timeout: float | None | NotGiven = NOT_GIVEN, ) -> Offer: - """Get a single offer from an organization.""" + """ + Get a single offer from an organization. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ return await self._get( f"/ats/offers/{offer_id}", options=make_request_options( diff --git a/src/finch/resources/hris/benefits/benefits.py b/src/finch/resources/hris/benefits/benefits.py index f85ba3a3..bf9b6870 100644 --- a/src/finch/resources/hris/benefits/benefits.py +++ b/src/finch/resources/hris/benefits/benefits.py @@ -68,9 +68,9 @@ def create( "/employer/benefits", body=maybe_transform( { - "type": type, "description": description, "frequency": frequency, + "type": type, }, benefit_create_params.BenefitCreateParams, ), @@ -95,6 +95,15 @@ def retrieve( **Availability: Automated Benefits providers only** Lists benefit information for a given benefit + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds """ return self._get( f"/employer/benefits/{benefit_id}", @@ -232,9 +241,9 @@ async def create( "/employer/benefits", body=maybe_transform( { - "type": type, "description": description, "frequency": frequency, + "type": type, }, benefit_create_params.BenefitCreateParams, ), @@ -259,6 +268,15 @@ async def retrieve( **Availability: Automated Benefits providers only** Lists benefit information for a given benefit + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds """ return await self._get( f"/employer/benefits/{benefit_id}", diff --git a/src/finch/resources/hris/benefits/individuals.py b/src/finch/resources/hris/benefits/individuals.py index d2d25b67..03b4aa33 100644 --- a/src/finch/resources/hris/benefits/individuals.py +++ b/src/finch/resources/hris/benefits/individuals.py @@ -27,7 +27,7 @@ def enroll_many( self, benefit_id: str, *, - individuals: List[individual_enroll_many_params.IndividualEnrollManyParam], + individuals: List[individual_enroll_many_params.Individual], # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -84,6 +84,15 @@ def enrolled_ids( **Availability: Automated Benefits providers only** Lists individuals currently enrolled in a given benefit. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds """ return self._get( f"/employer/benefits/{benefit_id}/enrolled", @@ -185,7 +194,7 @@ def enroll_many( self, benefit_id: str, *, - individuals: List[individual_enroll_many_params.IndividualEnrollManyParam], + individuals: List[individual_enroll_many_params.Individual], # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -242,6 +251,15 @@ async def enrolled_ids( **Availability: Automated Benefits providers only** Lists individuals currently enrolled in a given benefit. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds """ return await self._get( f"/employer/benefits/{benefit_id}/enrolled", diff --git a/src/finch/resources/hris/individuals/individuals.py b/src/finch/resources/hris/individuals/individuals.py index 5e2a3d58..43b15d75 100644 --- a/src/finch/resources/hris/individuals/individuals.py +++ b/src/finch/resources/hris/individuals/individuals.py @@ -54,8 +54,8 @@ def retrieve_many( page=SyncResponsesPage[IndividualResponse], body=maybe_transform( { - "requests": requests, "options": options, + "requests": requests, }, individual_retrieve_many_params.IndividualRetrieveManyParams, ), @@ -103,8 +103,8 @@ def retrieve_many( page=AsyncResponsesPage[IndividualResponse], body=maybe_transform( { - "requests": requests, "options": options, + "requests": requests, }, individual_retrieve_many_params.IndividualRetrieveManyParams, ), diff --git a/src/finch/resources/hris/payments.py b/src/finch/resources/hris/payments.py index 2eba7fe6..15856203 100644 --- a/src/finch/resources/hris/payments.py +++ b/src/finch/resources/hris/payments.py @@ -56,8 +56,8 @@ def list( timeout=timeout, query=maybe_transform( { - "start_date": start_date, "end_date": end_date, + "start_date": start_date, }, payment_list_params.PaymentListParams, ), @@ -107,8 +107,8 @@ def list( timeout=timeout, query=maybe_transform( { - "start_date": start_date, "end_date": end_date, + "start_date": start_date, }, payment_list_params.PaymentListParams, ), 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 62f2a2f2..2d88ef4d 100644 --- a/src/finch/types/hris/benefits/individual_enroll_many_params.py +++ b/src/finch/types/hris/benefits/individual_enroll_many_params.py @@ -3,16 +3,18 @@ from __future__ import annotations from typing import List -from typing_extensions import TypedDict +from typing_extensions import Required, TypedDict -__all__ = ["IndividualEnrollManyParam"] +__all__ = ["IndividualEnrollManyParams", "Individual"] -class IndividualEnrollManyParam(TypedDict, total=False): +class IndividualEnrollManyParams(TypedDict, total=False): + individuals: Required[List[Individual]] + """Array of the individual_id to enroll and a configuration object.""" + + +class Individual(TypedDict, total=False): configuration: object individual_id: str """Finch id (uuidv4) for the individual to enroll""" - - -IndividualEnrollManyParams = List[IndividualEnrollManyParam] diff --git a/src/finch/types/hris/individual_retrieve_many_params.py b/src/finch/types/hris/individual_retrieve_many_params.py index f937db83..bc95e012 100644 --- a/src/finch/types/hris/individual_retrieve_many_params.py +++ b/src/finch/types/hris/individual_retrieve_many_params.py @@ -5,18 +5,18 @@ from typing import List, Optional from typing_extensions import TypedDict -__all__ = ["IndividualRetrieveManyParams", "Request", "Options"] +__all__ = ["IndividualRetrieveManyParams", "Options", "Request"] -class Request(TypedDict, total=False): - individual_id: str +class IndividualRetrieveManyParams(TypedDict, total=False): + options: Optional[Options] + + requests: List[Request] class Options(TypedDict, total=False): include: List[str] -class IndividualRetrieveManyParams(TypedDict, total=False): - options: Optional[Options] - - requests: List[Request] +class Request(TypedDict, total=False): + individual_id: str diff --git a/src/finch/types/hris/individuals/employment_data_retrieve_many_params.py b/src/finch/types/hris/individuals/employment_data_retrieve_many_params.py index 2e099514..a1ab2fb9 100644 --- a/src/finch/types/hris/individuals/employment_data_retrieve_many_params.py +++ b/src/finch/types/hris/individuals/employment_data_retrieve_many_params.py @@ -8,6 +8,11 @@ __all__ = ["EmploymentDataRetrieveManyParams", "Request"] +class EmploymentDataRetrieveManyParams(TypedDict, total=False): + requests: Required[List[Request]] + """The array of batch requests.""" + + class Request(TypedDict, total=False): individual_id: Required[str] """A stable Finch `id` (UUID v4) for an individual in the company. @@ -16,8 +21,3 @@ class Request(TypedDict, total=False): preferantial to send all ids in a single request for Finch to optimize provider rate-limits. """ - - -class EmploymentDataRetrieveManyParams(TypedDict, total=False): - requests: Required[List[Request]] - """The array of batch requests.""" 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 d166c486..6329117d 100644 --- a/src/finch/types/hris/pay_statement_retrieve_many_params.py +++ b/src/finch/types/hris/pay_statement_retrieve_many_params.py @@ -8,6 +8,11 @@ __all__ = ["PayStatementRetrieveManyParams", "Request"] +class PayStatementRetrieveManyParams(TypedDict, total=False): + requests: Required[List[Request]] + """The array of batch requests.""" + + class Request(TypedDict, total=False): payment_id: Required[str] """A stable Finch `id` (UUID v4) for a payment.""" @@ -17,8 +22,3 @@ class Request(TypedDict, total=False): offset: int """Index to start from.""" - - -class PayStatementRetrieveManyParams(TypedDict, total=False): - requests: Required[List[Request]] - """The array of batch requests.""" diff --git a/tests/api_resources/hris/test_benefits.py b/tests/api_resources/hris/test_benefits.py index 4ed8a6b3..5ff71c54 100644 --- a/tests/api_resources/hris/test_benefits.py +++ b/tests/api_resources/hris/test_benefits.py @@ -33,9 +33,9 @@ def test_method_create(self, client: Finch) -> None: @parametrize def test_method_create_with_all_params(self, client: Finch) -> None: benefit = client.hris.benefits.create( - type="401k", description="string", frequency="one_time", + type="401k", ) assert_matches_type(CreateCompanyBenefitsResponse, benefit, path=["response"]) @@ -85,9 +85,9 @@ async def test_method_create(self, client: AsyncFinch) -> None: @parametrize async def test_method_create_with_all_params(self, client: AsyncFinch) -> None: benefit = await client.hris.benefits.create( - type="401k", description="string", frequency="one_time", + type="401k", ) assert_matches_type(CreateCompanyBenefitsResponse, benefit, path=["response"]) diff --git a/tests/api_resources/hris/test_individuals.py b/tests/api_resources/hris/test_individuals.py index 6bcb7217..98dc39be 100644 --- a/tests/api_resources/hris/test_individuals.py +++ b/tests/api_resources/hris/test_individuals.py @@ -28,8 +28,8 @@ def test_method_retrieve_many(self, client: Finch) -> None: @parametrize def test_method_retrieve_many_with_all_params(self, client: Finch) -> None: individual = client.hris.individuals.retrieve_many( - requests=[{"individual_id": "string"}, {"individual_id": "string"}, {"individual_id": "string"}], options={"include": ["string", "string", "string"]}, + requests=[{"individual_id": "string"}, {"individual_id": "string"}, {"individual_id": "string"}], ) assert_matches_type(SyncResponsesPage[IndividualResponse], individual, path=["response"]) @@ -47,7 +47,7 @@ async def test_method_retrieve_many(self, client: AsyncFinch) -> None: @parametrize async def test_method_retrieve_many_with_all_params(self, client: AsyncFinch) -> None: individual = await client.hris.individuals.retrieve_many( - requests=[{"individual_id": "string"}, {"individual_id": "string"}, {"individual_id": "string"}], options={"include": ["string", "string", "string"]}, + requests=[{"individual_id": "string"}, {"individual_id": "string"}, {"individual_id": "string"}], ) assert_matches_type(AsyncResponsesPage[IndividualResponse], individual, path=["response"]) diff --git a/tests/api_resources/hris/test_payments.py b/tests/api_resources/hris/test_payments.py index 83e294c8..fc757620 100644 --- a/tests/api_resources/hris/test_payments.py +++ b/tests/api_resources/hris/test_payments.py @@ -24,8 +24,8 @@ class TestPayments: @parametrize def test_method_list(self, client: Finch) -> None: payment = client.hris.payments.list( - start_date=parse_date("2021-01-01"), end_date=parse_date("2021-01-01"), + start_date=parse_date("2021-01-01"), ) assert_matches_type(SyncSinglePage[Payment], payment, path=["response"]) @@ -38,7 +38,7 @@ class TestAsyncPayments: @parametrize async def test_method_list(self, client: AsyncFinch) -> None: payment = await client.hris.payments.list( - start_date=parse_date("2021-01-01"), end_date=parse_date("2021-01-01"), + start_date=parse_date("2021-01-01"), ) assert_matches_type(AsyncSinglePage[Payment], payment, path=["response"])