Methods:
client.GetAuthURL(products string, redirectUri string, sandbox bool, opts ...option.RequestOption) (string, error)
client.WithAccessToken(accessToken string) (Client, error)
Response Types:
Methods:
client.AccessTokens.New(ctx context.Context, body finchgo.AccessTokenNewParams) (finchgo.CreateAccessTokenResponse, error)
Params Types:
Response Types:
Response Types:
Methods:
Response Types:
Methods:
client.HRIS.Directory.List(ctx context.Context, query finchgo.HRISDirectoryListParams) (finchgo.IndividualsPage, error)
Response Types:
Methods:
client.HRIS.Individuals.GetMany(ctx context.Context, body finchgo.HRISIndividualGetManyParams) (pagination.ResponsesPage[finchgo.IndividualResponse], error)
Response Types:
Methods:
client.HRIS.Employments.GetMany(ctx context.Context, body finchgo.HRISEmploymentGetManyParams) (pagination.ResponsesPage[finchgo.EmploymentDataResponse], error)
Response Types:
Methods:
client.HRIS.Payments.List(ctx context.Context, query finchgo.HRISPaymentListParams) (pagination.SinglePage[finchgo.Payment], error)
Response Types:
Methods:
client.HRIS.PayStatements.GetMany(ctx context.Context, body finchgo.HRISPayStatementGetManyParams) (pagination.ResponsesPage[finchgo.PayStatementResponse], error)
Params Types:
Response Types:
- finchgo.BenefitContribution
- finchgo.BenefitFeaturesAndOperations
- finchgo.BenefitFrequency
- finchgo.BenefitType
- finchgo.BenefitsSupport
- finchgo.CompanyBenefit
- finchgo.CreateCompanyBenefitsResponse
- finchgo.SupportPerBenefitType
- finchgo.SupportedBenefit
- finchgo.UpdateCompanyBenefitResponse
Methods:
client.HRIS.Benefits.New(ctx context.Context, body finchgo.HRISBenefitNewParams) (finchgo.CreateCompanyBenefitsResponse, error)
client.HRIS.Benefits.Get(ctx context.Context, benefitID string) (finchgo.CompanyBenefit, error)
client.HRIS.Benefits.Update(ctx context.Context, benefitID string, body finchgo.HRISBenefitUpdateParams) (finchgo.UpdateCompanyBenefitResponse, error)
client.HRIS.Benefits.List(ctx context.Context) (pagination.SinglePage[finchgo.CompanyBenefit], error)
client.HRIS.Benefits.ListSupportedBenefits(ctx context.Context) (pagination.SinglePage[finchgo.SupportedBenefit], error)
Response Types:
- finchgo.IndividualBenefit
- finchgo.UnenrolledIndividual
- finchgo.HRISBenefitIndividualEnrolledIDsResponse
Methods:
client.HRIS.Benefits.Individuals.EnrolledIDs(ctx context.Context, benefitID string) (finchgo.HRISBenefitIndividualEnrolledIDsResponse, error)
client.HRIS.Benefits.Individuals.GetManyBenefits(ctx context.Context, benefitID string, query finchgo.HRISBenefitIndividualGetManyBenefitsParams) (pagination.SinglePage[finchgo.IndividualBenefit], error)
client.HRIS.Benefits.Individuals.UnenrollMany(ctx context.Context, benefitID string, body finchgo.HRISBenefitIndividualUnenrollManyParams) (pagination.SinglePage[finchgo.UnenrolledIndividual], error)
Response Types:
Methods:
client.Providers.List(ctx context.Context) (pagination.SinglePage[finchgo.Provider], error)
Response Types:
Methods:
client.Account.Disconnect(ctx context.Context) (finchgo.DisconnectResponse, error)
client.Account.Introspect(ctx context.Context) (finchgo.Introspection, error)
Response Types:
- finchgo.AccountUpdateEvent
- finchgo.BaseWebhookEvent
- finchgo.CompanyEvent
- finchgo.DirectoryEvent
- finchgo.EmploymentEvent
- finchgo.IndividualEvent
- finchgo.JobCompletionEvent
- finchgo.PayStatementEvent
- finchgo.PaymentEvent
- finchgo.WebhookEventUnion
Methods:
client.Webhooks.Unwrap(payload []byte, headers http.Header, secret string, now time.Time) (WebhookEvent, error)
client.Webhooks.VerifySignature(payload []byte, headers http.Header, secret string, now time.Time) error
Response Types:
Methods:
client.RequestForwarding.Forward(ctx context.Context, body finchgo.RequestForwardingForwardParams) (finchgo.RequestForwardingForwardResponse, error)
Response Types:
Methods:
client.Jobs.Automated.New(ctx context.Context, body finchgo.JobAutomatedNewParams) (finchgo.JobAutomatedNewResponse, error)
client.Jobs.Automated.Get(ctx context.Context, jobID string) (finchgo.AutomatedAsyncJob, error)
client.Jobs.Automated.List(ctx context.Context, query finchgo.JobAutomatedListParams) (pagination.Page[finchgo.AutomatedAsyncJob], error)
Response Types:
Methods:
Response Types:
Methods:
client.Sandbox.Connections.New(ctx context.Context, body finchgo.SandboxConnectionNewParams) (finchgo.SandboxConnectionNewResponse, error)
Response Types:
Methods:
client.Sandbox.Connections.Accounts.New(ctx context.Context, body finchgo.SandboxConnectionAccountNewParams) (finchgo.SandboxConnectionAccountNewResponse, error)
client.Sandbox.Connections.Accounts.Update(ctx context.Context, body finchgo.SandboxConnectionAccountUpdateParams) (finchgo.SandboxConnectionAccountUpdateResponse, error)
Response Types:
Methods:
client.Sandbox.Company.Update(ctx context.Context, body finchgo.SandboxCompanyUpdateParams) (finchgo.SandboxCompanyUpdateResponse, error)
Response Types:
Methods:
client.Sandbox.Directory.New(ctx context.Context, body finchgo.SandboxDirectoryNewParams) ([]finchgo.SandboxDirectoryNewResponse, error)
Response Types:
Methods:
client.Sandbox.Individual.Update(ctx context.Context, individualID string, body finchgo.SandboxIndividualUpdateParams) (finchgo.SandboxIndividualUpdateResponse, error)
Response Types:
Methods:
client.Sandbox.Employment.Update(ctx context.Context, individualID string, body finchgo.SandboxEmploymentUpdateParams) (finchgo.SandboxEmploymentUpdateResponse, error)
Response Types:
Methods:
client.Sandbox.Payment.New(ctx context.Context, body finchgo.SandboxPaymentNewParams) (finchgo.SandboxPaymentNewResponse, error)
Response Types:
Methods:
client.Sandbox.Jobs.New(ctx context.Context, body finchgo.SandboxJobNewParams) (finchgo.SandboxJobNewResponse, error)
Response Types:
Methods:
client.Sandbox.Jobs.Configuration.Get(ctx context.Context) ([]finchgo.SandboxJobConfiguration, error)
client.Sandbox.Jobs.Configuration.Update(ctx context.Context, body finchgo.SandboxJobConfigurationUpdateParams) (finchgo.SandboxJobConfiguration, error)
Response Types:
Methods:
client.Payroll.PayGroups.Get(ctx context.Context, payGroupID string) (finchgo.PayrollPayGroupGetResponse, error)
client.Payroll.PayGroups.List(ctx context.Context, query finchgo.PayrollPayGroupListParams) (pagination.SinglePage[finchgo.PayrollPayGroupListResponse], error)
Response Types:
Methods:
client.Connect.Sessions.New(ctx context.Context, body finchgo.ConnectSessionNewParams) (finchgo.ConnectSessionNewResponse, error)
client.Connect.Sessions.Reauthenticate(ctx context.Context, body finchgo.ConnectSessionReauthenticateParams) (finchgo.ConnectSessionReauthenticateResponse, error)