from finch.types import ConnectionStatusType, OperationSupport, OperationSupportMatrix, PagingMethods:
client.get_auth_url(*args) -> strclient.with_access_token(*args) -> Self
Types:
from finch.types import CreateAccessTokenResponseMethods:
client.access_tokens.create(**params) -> CreateAccessTokenResponse
Types:
from finch.types import Income, Location, MoneyTypes:
from finch.types.hris import CompanyMethods:
Types:
from finch.types.hris import IndividualInDirectoryMethods:
client.hris.directory.list(**params) -> SyncIndividualsPage[IndividualInDirectory]
Types:
from finch.types.hris import Individual, IndividualResponseMethods:
client.hris.individuals.retrieve_many(**params) -> SyncResponsesPage[IndividualResponse]
Types:
from finch.types.hris import EmploymentData, EmploymentDataResponseMethods:
client.hris.employments.retrieve_many(**params) -> SyncResponsesPage[EmploymentDataResponse]
Types:
from finch.types.hris import PaymentMethods:
client.hris.payments.list(**params) -> SyncSinglePage[Payment]
Types:
from finch.types.hris import PayStatement, PayStatementResponse, PayStatementResponseBodyMethods:
client.hris.pay_statements.retrieve_many(**params) -> SyncResponsesPage[PayStatementResponse]
Types:
from finch.types.hris import (
BenefitContribution,
BenefitFeaturesAndOperations,
BenefitFrequency,
BenefitType,
BenefitsSupport,
BenfitContribution,
CompanyBenefit,
CreateCompanyBenefitsResponse,
SupportPerBenefitType,
SupportedBenefit,
UpdateCompanyBenefitResponse,
)Methods:
client.hris.benefits.create(**params) -> CreateCompanyBenefitsResponseclient.hris.benefits.retrieve(benefit_id) -> CompanyBenefitclient.hris.benefits.update(benefit_id, **params) -> UpdateCompanyBenefitResponseclient.hris.benefits.list() -> SyncSinglePage[CompanyBenefit]client.hris.benefits.list_supported_benefits() -> SyncSinglePage[SupportedBenefit]
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) -> IndividualEnrolledIDsResponseclient.hris.benefits.individuals.retrieve_many_benefits(benefit_id, **params) -> SyncSinglePage[IndividualBenefit]client.hris.benefits.individuals.unenroll_many(benefit_id, **params) -> SyncSinglePage[UnenrolledIndividual]
Types:
from finch.types import ProviderMethods:
client.providers.list() -> SyncSinglePage[Provider]
Types:
from finch.types import DisconnectResponse, IntrospectionMethods:
client.account.disconnect() -> DisconnectResponseclient.account.introspect() -> Introspection
Types:
from finch.types import (
AccountUpdateEvent,
BaseWebhookEvent,
CompanyEvent,
DirectoryEvent,
EmploymentEvent,
IndividualEvent,
JobCompletionEvent,
PayStatementEvent,
PaymentEvent,
WebhookEvent,
)Methods:
client.webhooks.unwrap(*args) -> WebhookEventclient.webhooks.verify_signature(*args) -> None
Types:
from finch.types import RequestForwardingForwardResponseMethods:
client.request_forwarding.forward(**params) -> RequestForwardingForwardResponse
Types:
from finch.types.jobs import AutomatedAsyncJob, AutomatedCreateResponseMethods:
client.jobs.automated.create(**params) -> AutomatedCreateResponseclient.jobs.automated.retrieve(job_id) -> AutomatedAsyncJobclient.jobs.automated.list(**params) -> SyncPage[AutomatedAsyncJob]
Types:
from finch.types.jobs import ManualAsyncJobMethods:
client.jobs.manual.retrieve(job_id) -> ManualAsyncJob
Types:
from finch.types.sandbox import ConnectionCreateResponseMethods:
client.sandbox.connections.create(**params) -> ConnectionCreateResponse
Types:
from finch.types.sandbox.connections import AccountCreateResponse, AccountUpdateResponseMethods:
client.sandbox.connections.accounts.create(**params) -> AccountCreateResponseclient.sandbox.connections.accounts.update(**params) -> AccountUpdateResponse
Types:
from finch.types.sandbox import CompanyUpdateResponseMethods:
client.sandbox.company.update(**params) -> CompanyUpdateResponse
Types:
from finch.types.sandbox import DirectoryCreateResponseMethods:
client.sandbox.directory.create(**params) -> DirectoryCreateResponse
Types:
from finch.types.sandbox import IndividualUpdateResponseMethods:
client.sandbox.individual.update(individual_id, **params) -> IndividualUpdateResponse
Types:
from finch.types.sandbox import EmploymentUpdateResponseMethods:
client.sandbox.employment.update(individual_id, **params) -> EmploymentUpdateResponse
Types:
from finch.types.sandbox import PaymentCreateResponseMethods:
client.sandbox.payment.create(**params) -> PaymentCreateResponse
Types:
from finch.types.sandbox import JobCreateResponseMethods:
client.sandbox.jobs.create(**params) -> JobCreateResponse
Types:
from finch.types.sandbox.jobs import SandboxJobConfiguration, ConfigurationRetrieveResponseMethods:
client.sandbox.jobs.configuration.retrieve() -> ConfigurationRetrieveResponseclient.sandbox.jobs.configuration.update(**params) -> SandboxJobConfiguration
Types:
from finch.types.payroll import PayGroupRetrieveResponse, PayGroupListResponseMethods:
client.payroll.pay_groups.retrieve(pay_group_id) -> PayGroupRetrieveResponseclient.payroll.pay_groups.list(**params) -> SyncSinglePage[PayGroupListResponse]