api.md

Finch

Methods:

• client.get_access_token(*args) -> str
• client.get_auth_url(*args) -> str

ATS

Candidates

Types:

from finch.types.ats import Candidate

Methods:

• client.ats.candidates.retrieve(candidate_id) -> Candidate
• client.ats.candidates.list(**params) -> SyncCandidatesPage[Candidate]

Applications

Types:

from finch.types.ats import Application

Methods:

• client.ats.applications.retrieve(application_id) -> Application
• client.ats.applications.list(**params) -> SyncApplicationsPage[Application]

Stages

Types:

from finch.types.ats import Stage

Methods:

• client.ats.stages.list() -> SyncSinglePage[Stage]

Jobs

Types:

from finch.types.ats import Job

Methods:

• client.ats.jobs.retrieve(job_id) -> Job
• client.ats.jobs.list(**params) -> SyncJobsPage[Job]

Offers

Types:

from finch.types.ats import Offer

Methods:

• client.ats.offers.retrieve(offer_id) -> Offer
• client.ats.offers.list(**params) -> SyncOffersPage[Offer]

HRIS

Types:

from finch.types import Income, Location, Money, Paging

CompanyResource

Types:

from finch.types.hris import Company

Methods:

• client.hris.company.retrieve() -> Company

Payments

Types:

from finch.types.hris import Payment

Methods:

• client.hris.payments.list(**params) -> SyncSinglePage[Payment]

PayStatements

Types:

from finch.types.hris import (
    PayStatement,
    PayStatementResponse,
    PayStatementResponseBody,
)

Methods:

• client.hris.pay_statements.retrieve_many(**params) -> SyncResponsesPage[PayStatementResponse]

Directory

Types:

from finch.types.hris import IndividualInDirectory

Methods:

• client.hris.directory.list_individuals(**params) -> SyncIndividualsPage[IndividualInDirectory]

Individuals

Types:

from finch.types.hris import Individual, IndividualResponse

Methods:

• client.hris.individuals.retrieve_many(**params) -> SyncResponsesPage[IndividualResponse]

EmploymentData

Types:

from finch.types.hris.individuals import EmploymentData, EmploymentDataResponse

Methods:

• client.hris.individuals.employment_data.retrieve_many(**params) -> SyncResponsesPage[EmploymentDataResponse]

Benefits

Types:

from finch.types.hris import (
    BenefitFrequency,
    BenefitType,
    BenfitContribution,
    CompanyBenefit,
    CreateCompanyBenefitsResponse,
    SupportedBenefit,
    UpdateCompanyBenefitResponse,
)

Methods:

• client.hris.benefits.create(**params) -> CreateCompanyBenefitsResponse
• client.hris.benefits.retrieve(benefit_id) -> CompanyBenefit
• client.hris.benefits.update(benefit_id, **params) -> UpdateCompanyBenefitResponse
• client.hris.benefits.list() -> SyncSinglePage[CompanyBenefit]
• client.hris.benefits.list_supported_benefits() -> SyncSinglePage[SupportedBenefit]

Individuals

Types:

from finch.types.hris.benefits import (
    EnrolledIndividual,
    IndividualBenefit,
    UnenrolledIndividual,
    IndividualEnrolledIDsResponse,
)

Methods:

• client.hris.benefits.individuals.enroll_many(benefit_id, **params) -> SyncSinglePage[EnrolledIndividual]
• client.hris.benefits.individuals.enrolled_ids(benefit_id) -> IndividualEnrolledIDsResponse
• client.hris.benefits.individuals.retrieve_many_benefits(benefit_id, **params) -> SyncSinglePage[IndividualBenefit]
• client.hris.benefits.individuals.unenroll(benefit_id, **params) -> SyncSinglePage[UnenrolledIndividual]

Providers

Types:

from finch.types import Provider

Methods:

• client.providers.list() -> SyncSinglePage[Provider]

Account

Types:

from finch.types import DisconnectResponse, Introspection

Methods:

• client.account.disconnect() -> DisconnectResponse
• client.account.introspect() -> Introspection